minor #39170 Improve return value for phpdoc of Normalizer (VincentLanglet)

chalasr · chalasr · commit fb161ec0ee31 · 2020-11-25T13:22:39.000+01:00
This PR was merged into the 4.4 branch. Discussion ---------- Improve return value for phpdoc of Normalizer | Q | A | ------------- | --- | Branch? | 4.4 | Bug fix? | Phpdoc | New feature? | no | Deprecations? | no | License | MIT The inheritdoc return type is too large. The return type type can be more precise for lot of Normalizer. Commits ------- f2713d6 Improve return phpdoc for Normalizer
diff --git a/src/Symfony/Component/Serializer/Normalizer/ArrayDenormalizer.php b/src/Symfony/Component/Serializer/Normalizer/ArrayDenormalizer.php
@@ -35,6 +35,8 @@ class ArrayDenormalizer implements ContextAwareDenormalizerInterface, Serializer
      * {@inheritdoc}
      *
      * @throws NotNormalizableValueException
+     *
+     * @return array
      */
     public function denormalize($data, $type, $format = null, array $context = [])
     {
diff --git a/src/Symfony/Component/Serializer/Normalizer/ConstraintViolationListNormalizer.php b/src/Symfony/Component/Serializer/Normalizer/ConstraintViolationListNormalizer.php
@@ -40,6 +40,8 @@ public function __construct($defaultContext = [], NameConverterInterface $nameCo
 
     /**
      * {@inheritdoc}
+     *
+     * @return array
      */
     public function normalize($object, $format = null, array $context = [])
     {
diff --git a/src/Symfony/Component/Serializer/Normalizer/DataUriNormalizer.php b/src/Symfony/Component/Serializer/Normalizer/DataUriNormalizer.php
@@ -61,6 +61,8 @@ public function __construct($mimeTypeGuesser = null)
 
     /**
      * {@inheritdoc}
+     *
+     * @return string
      */
     public function normalize($object, $format = null, array $context = [])
     {
@@ -102,6 +104,8 @@ public function supportsNormalization($data, $format = null)
      *
      * @throws InvalidArgumentException
      * @throws NotNormalizableValueException
+     *
+     * @return \SplFileInfo
      */
     public function denormalize($data, $type, $format = null, array $context = [])
     {
diff --git a/src/Symfony/Component/Serializer/Normalizer/DateIntervalNormalizer.php b/src/Symfony/Component/Serializer/Normalizer/DateIntervalNormalizer.php
@@ -46,6 +46,8 @@ public function __construct($defaultContext = [])
      * {@inheritdoc}
      *
      * @throws InvalidArgumentException
+     *
+     * @return string
      */
     public function normalize($object, $format = null, array $context = [])
     {
@@ -77,6 +79,8 @@ public function hasCacheableSupportsMethod(): bool
      *
      * @throws InvalidArgumentException
      * @throws UnexpectedValueException
+     *
+     * @return \DateInterval
      */
     public function denormalize($data, $type, $format = null, array $context = [])
     {
diff --git a/src/Symfony/Component/Serializer/Normalizer/DateTimeNormalizer.php b/src/Symfony/Component/Serializer/Normalizer/DateTimeNormalizer.php
@@ -57,6 +57,8 @@ public function __construct($defaultContext = [], \DateTimeZone $timezone = null
      * {@inheritdoc}
      *
      * @throws InvalidArgumentException
+     *
+     * @return string
      */
     public function normalize($object, $format = null, array $context = [])
     {
@@ -87,6 +89,8 @@ public function supportsNormalization($data, $format = null)
      * {@inheritdoc}
      *
      * @throws NotNormalizableValueException
+     *
+     * @return \DateTimeInterface
      */
     public function denormalize($data, $type, $format = null, array $context = [])
     {
diff --git a/src/Symfony/Component/Serializer/Normalizer/DateTimeZoneNormalizer.php b/src/Symfony/Component/Serializer/Normalizer/DateTimeZoneNormalizer.php
@@ -25,6 +25,8 @@ class DateTimeZoneNormalizer implements NormalizerInterface, DenormalizerInterfa
      * {@inheritdoc}
      *
      * @throws InvalidArgumentException
+     *
+     * @return string
      */
     public function normalize($object, $format = null, array $context = [])
     {
@@ -47,6 +49,8 @@ public function supportsNormalization($data, $format = null)
      * {@inheritdoc}
      *
      * @throws NotNormalizableValueException
+     *
+     * @return \DateTimeZone
      */
     public function denormalize($data, $type, $format = null, array $context = [])
     {
diff --git a/src/Symfony/Component/Serializer/Normalizer/ProblemNormalizer.php b/src/Symfony/Component/Serializer/Normalizer/ProblemNormalizer.php
@@ -37,6 +37,8 @@ public function __construct(bool $debug = false, array $defaultContext = [])
 
     /**
      * {@inheritdoc}
+     *
+     * @return array
      */
     public function normalize($exception, $format = null, array $context = [])
     {

Original file line number	Diff line number	Diff line change
`@@ -35,6 +35,8 @@ class ArrayDenormalizer implements ContextAwareDenormalizerInterface, Serializer`
`35`	`35`	`* {@inheritdoc}`
`36`	`36`	`*`
`37`	`37`	`* @throws NotNormalizableValueException`
	`38`	`+ *`
	`39`	`+ * @return array`
`38`	`40`	`*/`
`39`	`41`	`public function denormalize($data, $type, $format = null, array $context = [])`
`40`	`42`	`{`
Original file line number	Diff line number	Diff line change
`@@ -40,6 +40,8 @@ public function __construct($defaultContext = [], NameConverterInterface $nameCo`
`40`	`40`
`41`	`41`	`/**`
`42`	`42`	`* {@inheritdoc}`
	`43`	`+ *`
	`44`	`+ * @return array`
`43`	`45`	`*/`
`44`	`46`	`public function normalize($object, $format = null, array $context = [])`
`45`	`47`	`{`
Original file line number	Diff line number	Diff line change
`@@ -61,6 +61,8 @@ public function __construct($mimeTypeGuesser = null)`
`61`	`61`
`62`	`62`	`/**`
`63`	`63`	`* {@inheritdoc}`
	`64`	`+ *`
	`65`	`+ * @return string`
`64`	`66`	`*/`
`65`	`67`	`public function normalize($object, $format = null, array $context = [])`
`66`	`68`	`{`
`@@ -102,6 +104,8 @@ public function supportsNormalization($data, $format = null)`
`102`	`104`	`*`
`103`	`105`	`* @throws InvalidArgumentException`
`104`	`106`	`* @throws NotNormalizableValueException`
	`107`	`+ *`
	`108`	`+ * @return \SplFileInfo`
`105`	`109`	`*/`
`106`	`110`	`public function denormalize($data, $type, $format = null, array $context = [])`
`107`	`111`	`{`
Original file line number	Diff line number	Diff line change
`@@ -46,6 +46,8 @@ public function __construct($defaultContext = [])`
`46`	`46`	`* {@inheritdoc}`
`47`	`47`	`*`
`48`	`48`	`* @throws InvalidArgumentException`
	`49`	`+ *`
	`50`	`+ * @return string`
`49`	`51`	`*/`
`50`	`52`	`public function normalize($object, $format = null, array $context = [])`
`51`	`53`	`{`
`@@ -77,6 +79,8 @@ public function hasCacheableSupportsMethod(): bool`
`77`	`79`	`*`
`78`	`80`	`* @throws InvalidArgumentException`
`79`	`81`	`* @throws UnexpectedValueException`
	`82`	`+ *`
	`83`	`+ * @return \DateInterval`
`80`	`84`	`*/`
`81`	`85`	`public function denormalize($data, $type, $format = null, array $context = [])`
`82`	`86`	`{`
Original file line number	Diff line number	Diff line change
`@@ -57,6 +57,8 @@ public function __construct($defaultContext = [], \DateTimeZone $timezone = null`
`57`	`57`	`* {@inheritdoc}`
`58`	`58`	`*`
`59`	`59`	`* @throws InvalidArgumentException`
	`60`	`+ *`
	`61`	`+ * @return string`
`60`	`62`	`*/`
`61`	`63`	`public function normalize($object, $format = null, array $context = [])`
`62`	`64`	`{`
`@@ -87,6 +89,8 @@ public function supportsNormalization($data, $format = null)`
`87`	`89`	`* {@inheritdoc}`
`88`	`90`	`*`
`89`	`91`	`* @throws NotNormalizableValueException`
	`92`	`+ *`
	`93`	`+ * @return \DateTimeInterface`
`90`	`94`	`*/`
`91`	`95`	`public function denormalize($data, $type, $format = null, array $context = [])`
`92`	`96`	`{`
Original file line number	Diff line number	Diff line change
`@@ -25,6 +25,8 @@ class DateTimeZoneNormalizer implements NormalizerInterface, DenormalizerInterfa`
`25`	`25`	`* {@inheritdoc}`
`26`	`26`	`*`
`27`	`27`	`* @throws InvalidArgumentException`
	`28`	`+ *`
	`29`	`+ * @return string`
`28`	`30`	`*/`
`29`	`31`	`public function normalize($object, $format = null, array $context = [])`
`30`	`32`	`{`
`@@ -47,6 +49,8 @@ public function supportsNormalization($data, $format = null)`
`47`	`49`	`* {@inheritdoc}`
`48`	`50`	`*`
`49`	`51`	`* @throws NotNormalizableValueException`
	`52`	`+ *`
	`53`	`+ * @return \DateTimeZone`
`50`	`54`	`*/`
`51`	`55`	`public function denormalize($data, $type, $format = null, array $context = [])`
`52`	`56`	`{`
Original file line number	Diff line number	Diff line change
`@@ -37,6 +37,8 @@ public function __construct(bool $debug = false, array $defaultContext = [])`
`37`	`37`
`38`	`38`	`/**`
`39`	`39`	`* {@inheritdoc}`
	`40`	`+ *`
	`41`	`+ * @return array`
`40`	`42`	`*/`
`41`	`43`	`public function normalize($exception, $format = null, array $context = [])`
`42`	`44`	`{`