minor #54308 Add more explicit nullable types for default null values (alexandre-daubois)

nicolas-grekas · nicolas-grekas · commit 978c155c9260 · 2024-03-19T10:55:32.000+01:00
This PR was merged into the 5.4 branch. Discussion ---------- Add more explicit nullable types for default null values | Q | A | ------------- | --- | Branch? | 5.4 | Bug fix? | no | New feature? | no | Deprecations? | no | Issues | - | License | MIT Continuing to bring deprecation-free support for PHP 8.4 (https://php.watch/versions/8.4/implicitly-marking-parameter-type-nullable-deprecated) If this gets merged, I'll take care of adding missing ones in upper branches if not done during upmerge 🙂 Commits ------- e9d30bac03 Add more explicit nullable types for default null values
diff --git a/Tests/Fixtures/AbstractNormalizerDummy.php b/Tests/Fixtures/AbstractNormalizerDummy.php
@@ -31,29 +31,29 @@ public function getAllowedAttributes($classOrObject, array $context, bool $attri
     /**
      * {@inheritdoc}
      */
-    public function normalize($object, string $format = null, array $context = [])
+    public function normalize($object, ?string $format = null, array $context = [])
     {
     }
 
     /**
      * {@inheritdoc}
      */
-    public function supportsNormalization($data, string $format = null): bool
+    public function supportsNormalization($data, ?string $format = null): bool
     {
         return true;
     }
 
     /**
      * {@inheritdoc}
      */
-    public function denormalize($data, string $type, string $format = null, array $context = [])
+    public function denormalize($data, string $type, ?string $format = null, array $context = [])
     {
     }
 
     /**
      * {@inheritdoc}
      */
-    public function supportsDenormalization($data, string $type, string $format = null): bool
+    public function supportsDenormalization($data, string $type, ?string $format = null): bool
     {
         return true;
     }
diff --git a/Tests/Fixtures/DenormalizableDummy.php b/Tests/Fixtures/DenormalizableDummy.php
@@ -16,7 +16,7 @@
 
 class DenormalizableDummy implements DenormalizableInterface
 {
-    public function denormalize(DenormalizerInterface $denormalizer, $data, string $format = null, array $context = [])
+    public function denormalize(DenormalizerInterface $denormalizer, $data, ?string $format = null, array $context = [])
     {
     }
 }
diff --git a/Tests/Fixtures/Dummy.php b/Tests/Fixtures/Dummy.php
@@ -23,7 +23,7 @@ class Dummy implements NormalizableInterface, DenormalizableInterface
     public $baz;
     public $qux;
 
-    public function normalize(NormalizerInterface $normalizer, string $format = null, array $context = [])
+    public function normalize(NormalizerInterface $normalizer, ?string $format = null, array $context = [])
     {
         return [
             'foo' => $this->foo,
@@ -33,7 +33,7 @@ public function normalize(NormalizerInterface $normalizer, string $format = null
         ];
     }
 
-    public function denormalize(DenormalizerInterface $denormalizer, $data, string $format = null, array $context = [])
+    public function denormalize(DenormalizerInterface $denormalizer, $data, ?string $format = null, array $context = [])
     {
         $this->foo = $data['foo'];
         $this->bar = $data['bar'];
diff --git a/Tests/Fixtures/DummyString.php b/Tests/Fixtures/DummyString.php
@@ -22,7 +22,7 @@ class DummyString implements DenormalizableInterface
     /** @var string $value */
     public $value;
 
-    public function denormalize(DenormalizerInterface $denormalizer, $data, string $format = null, array $context = [])
+    public function denormalize(DenormalizerInterface $denormalizer, $data, ?string $format = null, array $context = [])
     {
         $this->value = $data;
     }
diff --git a/Tests/Fixtures/EnvelopeNormalizer.php b/Tests/Fixtures/EnvelopeNormalizer.php
@@ -20,7 +20,7 @@ class EnvelopeNormalizer implements NormalizerInterface
 {
     private $serializer;
 
-    public function normalize($envelope, string $format = null, array $context = []): array
+    public function normalize($envelope, ?string $format = null, array $context = []): array
     {
         $xmlContent = $this->serializer->serialize($envelope->message, 'xml');
 
@@ -31,7 +31,7 @@ public function normalize($envelope, string $format = null, array $context = [])
         ];
     }
 
-    public function supportsNormalization($data, string $format = null, array $context = []): bool
+    public function supportsNormalization($data, ?string $format = null, array $context = []): bool
     {
         return $data instanceof EnvelopeObject;
     }
diff --git a/Tests/Fixtures/EnvelopedMessageNormalizer.php b/Tests/Fixtures/EnvelopedMessageNormalizer.php
@@ -18,14 +18,14 @@
  */
 class EnvelopedMessageNormalizer implements NormalizerInterface
 {
-    public function normalize($message, string $format = null, array $context = []): array
+    public function normalize($message, ?string $format = null, array $context = []): array
     {
         return [
             'text' => $message->text,
         ];
     }
 
-    public function supportsNormalization($data, string $format = null, array $context = []): bool
+    public function supportsNormalization($data, ?string $format = null, array $context = []): bool
     {
         return $data instanceof EnvelopedMessage;
     }
diff --git a/Tests/Fixtures/NormalizableTraversableDummy.php b/Tests/Fixtures/NormalizableTraversableDummy.php
@@ -18,15 +18,15 @@
 
 class NormalizableTraversableDummy extends TraversableDummy implements NormalizableInterface, DenormalizableInterface
 {
-    public function normalize(NormalizerInterface $normalizer, string $format = null, array $context = [])
+    public function normalize(NormalizerInterface $normalizer, ?string $format = null, array $context = [])
     {
         return [
             'foo' => 'normalizedFoo',
             'bar' => 'normalizedBar',
         ];
     }
 
-    public function denormalize(DenormalizerInterface $denormalizer, $data, string $format = null, array $context = [])
+    public function denormalize(DenormalizerInterface $denormalizer, $data, ?string $format = null, array $context = [])
     {
         return [
             'foo' => 'denormalizedFoo',
diff --git a/Tests/Fixtures/NotNormalizableDummy.php b/Tests/Fixtures/NotNormalizableDummy.php
@@ -24,7 +24,7 @@ public function __construct()
     {
     }
 
-    public function denormalize(DenormalizerInterface $denormalizer, $data, string $format = null, array $context = [])
+    public function denormalize(DenormalizerInterface $denormalizer, $data, ?string $format = null, array $context = [])
     {
         throw new NotNormalizableValueException();
     }
diff --git a/Tests/Fixtures/ScalarDummy.php b/Tests/Fixtures/ScalarDummy.php
@@ -21,12 +21,12 @@ class ScalarDummy implements NormalizableInterface, DenormalizableInterface
     public $foo;
     public $xmlFoo;
 
-    public function normalize(NormalizerInterface $normalizer, string $format = null, array $context = [])
+    public function normalize(NormalizerInterface $normalizer, ?string $format = null, array $context = [])
     {
         return 'xml' === $format ? $this->xmlFoo : $this->foo;
     }
 
-    public function denormalize(DenormalizerInterface $denormalizer, $data, string $format = null, array $context = [])
+    public function denormalize(DenormalizerInterface $denormalizer, $data, ?string $format = null, array $context = [])
     {
         if ('xml' === $format) {
             $this->xmlFoo = $data;
diff --git a/Tests/Normalizer/AbstractObjectNormalizerTest.php b/Tests/Normalizer/AbstractObjectNormalizerTest.php
@@ -559,12 +559,12 @@ public function testProvidingContextCacheKeyGeneratesSameChildContextCacheKey()
         $normalizer = new class() extends AbstractObjectNormalizerDummy {
             public $childContextCacheKey;
 
-            protected function extractAttributes(object $object, string $format = null, array $context = []): array
+            protected function extractAttributes(object $object, ?string $format = null, array $context = []): array
             {
                 return array_keys((array) $object);
             }
 
-            protected function getAttributeValue(object $object, string $attribute, string $format = null, array $context = [])
+            protected function getAttributeValue(object $object, string $attribute, ?string $format = null, array $context = [])
             {
                 return $object->{$attribute};
             }
@@ -599,12 +599,12 @@ public function testChildContextKeepsOriginalContextCacheKey()
         $normalizer = new class() extends AbstractObjectNormalizerDummy {
             public $childContextCacheKey;
 
-            protected function extractAttributes(object $object, string $format = null, array $context = []): array
+            protected function extractAttributes(object $object, ?string $format = null, array $context = []): array
             {
                 return array_keys((array) $object);
             }
 
-            protected function getAttributeValue(object $object, string $attribute, string $format = null, array $context = [])
+            protected function getAttributeValue(object $object, string $attribute, ?string $format = null, array $context = [])
             {
                 return $object->{$attribute};
             }
@@ -634,12 +634,12 @@ public function testChildContextCacheKeyStaysFalseWhenOriginalCacheKeyIsFalse()
         $normalizer = new class() extends AbstractObjectNormalizerDummy {
             public $childContextCacheKey;
 
-            protected function extractAttributes(object $object, string $format = null, array $context = []): array
+            protected function extractAttributes(object $object, ?string $format = null, array $context = []): array
             {
                 return array_keys((array) $object);
             }
 
-            protected function getAttributeValue(object $object, string $attribute, string $format = null, array $context = [])
+            protected function getAttributeValue(object $object, string $attribute, ?string $format = null, array $context = [])
             {
                 return $object->{$attribute};
             }

Original file line number	Diff line number	Diff line change
`@@ -31,29 +31,29 @@ public function getAllowedAttributes($classOrObject, array $context, bool $attri`
`31`	`31`	`/**`
`32`	`32`	`* {@inheritdoc}`
`33`	`33`	`*/`
`34`		`- public function normalize($object, string $format = null, array $context = [])`
	`34`	`+ public function normalize($object, ?string $format = null, array $context = [])`
`35`	`35`	`{`
`36`	`36`	`}`
`37`	`37`
`38`	`38`	`/**`
`39`	`39`	`* {@inheritdoc}`
`40`	`40`	`*/`
`41`		`- public function supportsNormalization($data, string $format = null): bool`
	`41`	`+ public function supportsNormalization($data, ?string $format = null): bool`
`42`	`42`	`{`
`43`	`43`	`return true;`
`44`	`44`	`}`
`45`	`45`
`46`	`46`	`/**`
`47`	`47`	`* {@inheritdoc}`
`48`	`48`	`*/`
`49`		`- public function denormalize($data, string $type, string $format = null, array $context = [])`
	`49`	`+ public function denormalize($data, string $type, ?string $format = null, array $context = [])`
`50`	`50`	`{`
`51`	`51`	`}`
`52`	`52`
`53`	`53`	`/**`
`54`	`54`	`* {@inheritdoc}`
`55`	`55`	`*/`
`56`		`- public function supportsDenormalization($data, string $type, string $format = null): bool`
	`56`	`+ public function supportsDenormalization($data, string $type, ?string $format = null): bool`
`57`	`57`	`{`
`58`	`58`	`return true;`
`59`	`59`	`}`
Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@`
`16`	`16`
`17`	`17`	`class DenormalizableDummy implements DenormalizableInterface`
`18`	`18`	`{`
`19`		`- public function denormalize(DenormalizerInterface $denormalizer, $data, string $format = null, array $context = [])`
	`19`	`+ public function denormalize(DenormalizerInterface $denormalizer, $data, ?string $format = null, array $context = [])`
`20`	`20`	`{`
`21`	`21`	`}`
`22`	`22`	`}`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@ class Dummy implements NormalizableInterface, DenormalizableInterface`
`23`	`23`	`public $baz;`
`24`	`24`	`public $qux;`
`25`	`25`
`26`		`- public function normalize(NormalizerInterface $normalizer, string $format = null, array $context = [])`
	`26`	`+ public function normalize(NormalizerInterface $normalizer, ?string $format = null, array $context = [])`
`27`	`27`	`{`
`28`	`28`	`return [`
`29`	`29`	`'foo' => $this->foo,`
`@@ -33,7 +33,7 @@ public function normalize(NormalizerInterface $normalizer, string $format = null`
`33`	`33`	`];`
`34`	`34`	`}`
`35`	`35`
`36`		`- public function denormalize(DenormalizerInterface $denormalizer, $data, string $format = null, array $context = [])`
	`36`	`+ public function denormalize(DenormalizerInterface $denormalizer, $data, ?string $format = null, array $context = [])`
`37`	`37`	`{`
`38`	`38`	`$this->foo = $data['foo'];`
`39`	`39`	`$this->bar = $data['bar'];`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@ class DummyString implements DenormalizableInterface`
`22`	`22`	`/** @var string $value */`
`23`	`23`	`public $value;`
`24`	`24`
`25`		`- public function denormalize(DenormalizerInterface $denormalizer, $data, string $format = null, array $context = [])`
	`25`	`+ public function denormalize(DenormalizerInterface $denormalizer, $data, ?string $format = null, array $context = [])`
`26`	`26`	`{`
`27`	`27`	`$this->value = $data;`
`28`	`28`	`}`
Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@ class EnvelopeNormalizer implements NormalizerInterface`
`20`	`20`	`{`
`21`	`21`	`private $serializer;`
`22`	`22`
`23`		`- public function normalize($envelope, string $format = null, array $context = []): array`
	`23`	`+ public function normalize($envelope, ?string $format = null, array $context = []): array`
`24`	`24`	`{`
`25`	`25`	`$xmlContent = $this->serializer->serialize($envelope->message, 'xml');`
`26`	`26`
`@@ -31,7 +31,7 @@ public function normalize($envelope, string $format = null, array $context = [])`
`31`	`31`	`];`
`32`	`32`	`}`
`33`	`33`
`34`		`- public function supportsNormalization($data, string $format = null, array $context = []): bool`
	`34`	`+ public function supportsNormalization($data, ?string $format = null, array $context = []): bool`
`35`	`35`	`{`
`36`	`36`	`return $data instanceof EnvelopeObject;`
`37`	`37`	`}`
Original file line number	Diff line number	Diff line change
`@@ -18,14 +18,14 @@`
`18`	`18`	`*/`
`19`	`19`	`class EnvelopedMessageNormalizer implements NormalizerInterface`
`20`	`20`	`{`
`21`		`- public function normalize($message, string $format = null, array $context = []): array`
	`21`	`+ public function normalize($message, ?string $format = null, array $context = []): array`
`22`	`22`	`{`
`23`	`23`	`return [`
`24`	`24`	`'text' => $message->text,`
`25`	`25`	`];`
`26`	`26`	`}`
`27`	`27`
`28`		`- public function supportsNormalization($data, string $format = null, array $context = []): bool`
	`28`	`+ public function supportsNormalization($data, ?string $format = null, array $context = []): bool`
`29`	`29`	`{`
`30`	`30`	`return $data instanceof EnvelopedMessage;`
`31`	`31`	`}`
Original file line number	Diff line number	Diff line change
`@@ -18,15 +18,15 @@`
`18`	`18`
`19`	`19`	`class NormalizableTraversableDummy extends TraversableDummy implements NormalizableInterface, DenormalizableInterface`
`20`	`20`	`{`
`21`		`- public function normalize(NormalizerInterface $normalizer, string $format = null, array $context = [])`
	`21`	`+ public function normalize(NormalizerInterface $normalizer, ?string $format = null, array $context = [])`
`22`	`22`	`{`
`23`	`23`	`return [`
`24`	`24`	`'foo' => 'normalizedFoo',`
`25`	`25`	`'bar' => 'normalizedBar',`
`26`	`26`	`];`
`27`	`27`	`}`
`28`	`28`
`29`		`- public function denormalize(DenormalizerInterface $denormalizer, $data, string $format = null, array $context = [])`
	`29`	`+ public function denormalize(DenormalizerInterface $denormalizer, $data, ?string $format = null, array $context = [])`
`30`	`30`	`{`
`31`	`31`	`return [`
`32`	`32`	`'foo' => 'denormalizedFoo',`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@ public function __construct()`
`24`	`24`	`{`
`25`	`25`	`}`
`26`	`26`
`27`		`- public function denormalize(DenormalizerInterface $denormalizer, $data, string $format = null, array $context = [])`
	`27`	`+ public function denormalize(DenormalizerInterface $denormalizer, $data, ?string $format = null, array $context = [])`
`28`	`28`	`{`
`29`	`29`	`throw new NotNormalizableValueException();`
`30`	`30`	`}`
Original file line number	Diff line number	Diff line change
`@@ -21,12 +21,12 @@ class ScalarDummy implements NormalizableInterface, DenormalizableInterface`
`21`	`21`	`public $foo;`
`22`	`22`	`public $xmlFoo;`
`23`	`23`
`24`		`- public function normalize(NormalizerInterface $normalizer, string $format = null, array $context = [])`
	`24`	`+ public function normalize(NormalizerInterface $normalizer, ?string $format = null, array $context = [])`
`25`	`25`	`{`
`26`	`26`	`return 'xml' === $format ? $this->xmlFoo : $this->foo;`
`27`	`27`	`}`
`28`	`28`
`29`		`- public function denormalize(DenormalizerInterface $denormalizer, $data, string $format = null, array $context = [])`
	`29`	`+ public function denormalize(DenormalizerInterface $denormalizer, $data, ?string $format = null, array $context = [])`
`30`	`30`	`{`
`31`	`31`	`if ('xml' === $format) {`
`32`	`32`	`$this->xmlFoo = $data;`
Original file line number	Diff line number	Diff line change
`@@ -559,12 +559,12 @@ public function testProvidingContextCacheKeyGeneratesSameChildContextCacheKey()`
`559`	`559`	`$normalizer = new class() extends AbstractObjectNormalizerDummy {`
`560`	`560`	`public $childContextCacheKey;`
`561`	`561`
`562`		`- protected function extractAttributes(object $object, string $format = null, array $context = []): array`
	`562`	`+ protected function extractAttributes(object $object, ?string $format = null, array $context = []): array`
`563`	`563`	`{`
`564`	`564`	`return array_keys((array) $object);`
`565`	`565`	`}`
`566`	`566`
`567`		`- protected function getAttributeValue(object $object, string $attribute, string $format = null, array $context = [])`
	`567`	`+ protected function getAttributeValue(object $object, string $attribute, ?string $format = null, array $context = [])`
`568`	`568`	`{`
`569`	`569`	`return $object->{$attribute};`
`570`	`570`	`}`
`@@ -599,12 +599,12 @@ public function testChildContextKeepsOriginalContextCacheKey()`
`599`	`599`	`$normalizer = new class() extends AbstractObjectNormalizerDummy {`
`600`	`600`	`public $childContextCacheKey;`
`601`	`601`
`602`		`- protected function extractAttributes(object $object, string $format = null, array $context = []): array`
	`602`	`+ protected function extractAttributes(object $object, ?string $format = null, array $context = []): array`
`603`	`603`	`{`
`604`	`604`	`return array_keys((array) $object);`
`605`	`605`	`}`
`606`	`606`
`607`		`- protected function getAttributeValue(object $object, string $attribute, string $format = null, array $context = [])`
	`607`	`+ protected function getAttributeValue(object $object, string $attribute, ?string $format = null, array $context = [])`
`608`	`608`	`{`
`609`	`609`	`return $object->{$attribute};`
`610`	`610`	`}`
`@@ -634,12 +634,12 @@ public function testChildContextCacheKeyStaysFalseWhenOriginalCacheKeyIsFalse()`
`634`	`634`	`$normalizer = new class() extends AbstractObjectNormalizerDummy {`
`635`	`635`	`public $childContextCacheKey;`
`636`	`636`
`637`		`- protected function extractAttributes(object $object, string $format = null, array $context = []): array`
	`637`	`+ protected function extractAttributes(object $object, ?string $format = null, array $context = []): array`
`638`	`638`	`{`
`639`	`639`	`return array_keys((array) $object);`
`640`	`640`	`}`
`641`	`641`
`642`		`- protected function getAttributeValue(object $object, string $attribute, string $format = null, array $context = [])`
	`642`	`+ protected function getAttributeValue(object $object, string $attribute, ?string $format = null, array $context = [])`
`643`	`643`	`{`
`644`	`644`	`return $object->{$attribute};`
`645`	`645`	`}`