Deprecate implicit nullable parameter types (#12959)

kocsismate · Girgias · web-flow · commit 330cc5cdb209 · 2024-03-13T21:40:26.000+01:00
RFC: https://wiki.php.net/rfc/deprecate-implicitly-nullable-types Co-authored-by: Gina Peter Banyard <girgias@php.net>
diff --git a/UPGRADING b/UPGRADING
@@ -268,6 +268,10 @@ PHP 8.4 UPGRADE NOTES
 4. Deprecated Functionality
 ========================================
 
+- Core:
+  . Implicitly nullable parameter types are now deprecated.
+    RFC: https://wiki.php.net/rfc/deprecate-implicitly-nullable-types
+
 - Curl:
   . The CURLOPT_BINARYTRANSFER constant is deprecated.
 
diff --git a/Zend/tests/bug63635.phpt b/Zend/tests/bug63635.phpt
@@ -6,7 +6,7 @@ class Node {
     public $parent = NULL;
     public $children = array();
 
-    function __construct(Node $parent=NULL) {
+    function __construct(?Node $parent=NULL) {
         if ($parent) {
             $parent->children[] = $this;
         }
diff --git a/Zend/tests/bug71428.1.phpt b/Zend/tests/bug71428.1.phpt
@@ -3,7 +3,7 @@ bug #71428.1: inheritance with null default values
 --FILE--
 <?php
 class A {
-    public function m(array $a = null) {}
+    public function m(?array $a = null) {}
 }
 class B extends A {
     public function m(array $a = []) {}
diff --git a/Zend/tests/bug71428.3.phpt b/Zend/tests/bug71428.3.phpt
@@ -7,4 +7,6 @@ class B           {  public function m(A $a = NULL, $n) { echo "B.m";} };
 class C extends B {  public function m(A $a       , $n) { echo "C.m";} };
 ?>
 --EXPECTF--
+Deprecated: Implicitly marking parameter $a as nullable is deprecated, the explicit nullable type must be used instead in %s on line %d
+
 Fatal error: Declaration of C::m(A $a, $n) must be compatible with B::m(?A $a, $n) in %sbug71428.3.php on line 4
diff --git a/Zend/tests/bug72119.phpt b/Zend/tests/bug72119.phpt
@@ -3,7 +3,7 @@ Bug #72119 (Interface declaration compatibility regression with default values)
 --FILE--
 <?php
 interface Foo {
-    public function bar(array $baz = null);
+    public function bar(?array $baz = null);
 }
 
 class Hello implements Foo {
diff --git a/Zend/tests/gh11488.phpt b/Zend/tests/gh11488.phpt
@@ -18,4 +18,6 @@ function c(
 --EXPECTF--
 Deprecated: Optional parameter $a declared before required parameter $b is implicitly treated as a required parameter in %s on line %d
 
+Deprecated: Implicitly marking parameter $c as nullable is deprecated, the explicit nullable type must be used instead in %s on line %d
+
 Deprecated: Optional parameter $e declared before required parameter $f is implicitly treated as a required parameter in %s on line %d
diff --git a/Zend/tests/ns_070.phpt b/Zend/tests/ns_070.phpt
@@ -6,7 +6,7 @@ Testing parameter type-hinted with default value inside namespace
 namespace foo;
 
 class bar {
-    public function __construct(\stdclass $x = NULL) {
+    public function __construct(?\stdclass $x = NULL) {
         var_dump($x);
     }
 }
diff --git a/Zend/tests/ns_071.phpt b/Zend/tests/ns_071.phpt
@@ -6,7 +6,7 @@ Testing parameter type-hinted (array) with default value inside namespace
 namespace foo;
 
 class bar {
-    public function __construct(array $x = NULL) {
+    public function __construct(?array $x = NULL) {
         var_dump($x);
     }
 }
diff --git a/Zend/tests/ns_072.phpt b/Zend/tests/ns_072.phpt
@@ -10,7 +10,7 @@ interface foo {
 }
 
 class bar {
-    public function __construct(foo $x = NULL) {
+    public function __construct(?foo $x = NULL) {
         var_dump($x);
     }
 }
diff --git a/Zend/tests/ns_073.phpt b/Zend/tests/ns_073.phpt
@@ -14,6 +14,7 @@ $x(new \stdclass);
 
 ?>
 --EXPECTF--
+Deprecated: Implicitly marking parameter $x as nullable is deprecated, the explicit nullable type must be used instead in %s on line %d
 NULL
 object(stdClass)#%d (0) {
 }
diff --git a/Zend/tests/ns_074.phpt b/Zend/tests/ns_074.phpt
@@ -5,7 +5,7 @@ Testing type-hinted lambda parameter inside namespace
 
 namespace foo;
 
-$x = function (\stdclass $x = NULL) {
+$x = function (?\stdclass $x = NULL) {
     var_dump($x);
 };
 
diff --git a/Zend/tests/required_param_after_optional.phpt b/Zend/tests/required_param_after_optional.phpt
@@ -13,6 +13,10 @@ Deprecated: Optional parameter $testA declared before required parameter $testC
 
 Deprecated: Optional parameter $testB declared before required parameter $testC is implicitly treated as a required parameter in %s on line %d
 
+Deprecated: Implicitly marking parameter $test2A as nullable is deprecated, the explicit nullable type must be used instead in %s on line %d
+
 Deprecated: Optional parameter $test2B declared before required parameter $test2C is implicitly treated as a required parameter in %s on line %d
 
+Deprecated: Implicitly marking parameter $test3A as nullable is deprecated, the explicit nullable type must be used instead in %s on line %d
+
 Deprecated: Optional parameter $test3B declared before required parameter $test3C is implicitly treated as a required parameter in %s on line %d
diff --git a/Zend/tests/traits/bug60717.phpt b/Zend/tests/traits/bug60717.phpt
@@ -69,5 +69,10 @@ namespace HTML
     echo 'Done';
 }
 ?>
---EXPECT--
+--EXPECTF--
+Deprecated: Implicitly marking parameter $attributes as nullable is deprecated, the explicit nullable type must be used instead in %s on line %d
+
+Deprecated: Implicitly marking parameter $attributes as nullable is deprecated, the explicit nullable type must be used instead in %s on line %d
+
+Deprecated: Implicitly marking parameter $attributes as nullable is deprecated, the explicit nullable type must be used instead in %s on line %d
 Done
diff --git a/Zend/tests/type_declarations/callable_003.phpt b/Zend/tests/type_declarations/callable_003.phpt
@@ -13,7 +13,8 @@ function bar(callable $a = null) {
 foo("strpos", 123, "strpos");
 bar("substr");
 ?>
---EXPECT--
+--EXPECTF--
+Deprecated: Implicitly marking parameter $a as nullable is deprecated, the explicit nullable type must be used instead in %s on line %d
 string(6) "strpos"
 int(123)
 string(6) "strpos"
diff --git a/Zend/tests/type_declarations/intersection_types/implicit_nullable_intersection_type.phpt b/Zend/tests/type_declarations/intersection_types/implicit_nullable_intersection_type.phpt
@@ -10,5 +10,6 @@ function foo(X&Y $foo = null) {
 foo(null);
 
 ?>
---EXPECT--
+--EXPECTF--
+Deprecated: Implicitly marking parameter $foo as nullable is deprecated, the explicit nullable type must be used instead in %s on line %d
 NULL
diff --git a/Zend/tests/type_declarations/intersection_types/implicit_nullable_intersection_type_error.phpt b/Zend/tests/type_declarations/intersection_types/implicit_nullable_intersection_type_error.phpt
@@ -15,4 +15,5 @@ try {
 
 ?>
 --EXPECTF--
+Deprecated: Implicitly marking parameter $foo as nullable is deprecated, the explicit nullable type must be used instead in %s on line %d
 foo(): Argument #1 ($foo) must be of type (X&Y)|null, int given, called in %s on line %d
diff --git a/Zend/tests/type_declarations/iterable/iterable_002.phpt b/Zend/tests/type_declarations/iterable/iterable_002.phpt
@@ -17,4 +17,6 @@ function baz(iterable $iterable = 1) {
 
 ?>
 --EXPECTF--
+Deprecated: Implicitly marking parameter $iterable as nullable is deprecated, the explicit nullable type must be used instead in %s on line %d
+
 Fatal error: Cannot use int as default value for parameter $iterable of type Traversable|array in %s on line %d
diff --git a/Zend/tests/type_declarations/literal_types/false_standalone_implicit_nullability.phpt b/Zend/tests/type_declarations/literal_types/false_standalone_implicit_nullability.phpt
@@ -8,6 +8,7 @@ function test(false $v = null) { return $v; }
 var_dump(test(false));
 var_dump(test(null));
 ?>
---EXPECT--
+--EXPECTF--
+Deprecated: Implicitly marking parameter $v as nullable is deprecated, the explicit nullable type must be used instead in %s on line %d
 bool(false)
 NULL
diff --git a/Zend/tests/type_declarations/literal_types/true_standalone_implicit_nullability.phpt b/Zend/tests/type_declarations/literal_types/true_standalone_implicit_nullability.phpt
@@ -8,6 +8,7 @@ function test(true $v = null) { return $v; }
 var_dump(test(true));
 var_dump(test(null));
 ?>
---EXPECT--
+--EXPECTF--
+Deprecated: Implicitly marking parameter $v as nullable is deprecated, the explicit nullable type must be used instead in %s on line %d
 bool(true)
 NULL
diff --git a/Zend/tests/type_declarations/nullable_null.phpt b/Zend/tests/type_declarations/nullable_null.phpt
@@ -7,5 +7,6 @@ function test(Foo $a = null) {
 }
 test(null);
 ?>
---EXPECT--
+--EXPECTF--
+Deprecated: Implicitly marking parameter $a as nullable is deprecated, the explicit nullable type must be used instead in %s on line %d
 ok
diff --git a/Zend/tests/type_declarations/scalar_none.phpt b/Zend/tests/type_declarations/scalar_none.phpt
@@ -8,10 +8,10 @@ $functions = [
     'float' => function (float $f) { return $f; },
     'string' => function (string $s) { return $s; },
     'bool' => function (bool $b) { return $b; },
-    'int nullable' => function (int $i = NULL) { return $i; },
-    'float nullable' => function (float $f = NULL) { return $f; },
-    'string nullable' => function (string $s = NULL) { return $s; },
-    'bool nullable' => function (bool $b = NULL) { return $b; }
+    'int nullable' => function (?int $i = NULL) { return $i; },
+    'float nullable' => function (?float $f = NULL) { return $f; },
+    'string nullable' => function (?string $s = NULL) { return $s; },
+    'bool nullable' => function (?bool $b = NULL) { return $b; }
 ];
 
 foreach ($functions as $type => $function) {
diff --git a/Zend/tests/type_declarations/scalar_null.phpt b/Zend/tests/type_declarations/scalar_null.phpt
@@ -8,10 +8,10 @@ $functions = [
     'float' => function (float $f) { return $f; },
     'string' => function (string $s) { return $s; },
     'bool' => function (bool $b) { return $b; },
-    'int nullable' => function (int $i = NULL) { return $i; },
-    'float nullable' => function (float $f = NULL) { return $f; },
-    'string nullable' => function (string $s = NULL) { return $s; },
-    'bool nullable' => function (bool $b = NULL) { return $b; }
+    'int nullable' => function (?int $i) { return $i; },
+    'float nullable' => function (?float $f) { return $f; },
+    'string nullable' => function (?string $s) { return $s; },
+    'bool nullable' => function (?bool $b) { return $b; }
 ];
 
 foreach ($functions as $type => $function) {
diff --git a/Zend/tests/type_declarations/variance/internal_parent/unresolvable_inheritance_check_param.phpt b/Zend/tests/type_declarations/variance/internal_parent/unresolvable_inheritance_check_param.phpt
@@ -4,7 +4,7 @@ Test unresolvable inheritance check due to unavailable parameter type when the p
 <?php
 
 class Test extends DateTime {
-    public static function createFromFormat($format, $datetime, Wrong $timezone = null): DateTime|false {}
+    public static function createFromFormat($format, $datetime, ?Wrong $timezone = null): DateTime|false {}
 }
 
 ?>
diff --git a/Zend/tests/variadic/adding_additional_optional_parameter.phpt b/Zend/tests/variadic/adding_additional_optional_parameter.phpt
@@ -8,10 +8,10 @@ interface DB {
 }
 
 class MySQL implements DB {
-    public function query($query, string $extraParam = null, string ...$params) { }
+    public function query($query, ?string $extraParam = null, string ...$params) { }
 }
 
 ?>
 ===DONE===
---EXPECT--
+--EXPECTF--
 ===DONE===
diff --git a/Zend/tests/variadic/adding_additional_optional_parameter_error.phpt b/Zend/tests/variadic/adding_additional_optional_parameter_error.phpt
@@ -8,7 +8,7 @@ interface DB {
 }
 
 class MySQL implements DB {
-    public function query($query, int $extraParam = null, string ...$params) { }
+    public function query($query, ?int $extraParam = null, string ...$params) { }
 }
 
 ?>
diff --git a/Zend/zend_compile.c b/Zend/zend_compile.c
@@ -7224,6 +7224,11 @@ static void zend_compile_params(zend_ast *ast, zend_ast *return_type_ast, uint32
 
 			op_array->fn_flags |= ZEND_ACC_HAS_TYPE_HINTS;
 			arg_info->type = zend_compile_typename_ex(type_ast, force_nullable, &forced_allow_nullable);
+			if (forced_allow_nullable) {
+				zend_error(E_DEPRECATED,
+				   "Implicitly marking parameter $%s as nullable is deprecated, the explicit nullable type "
+				   "must be used instead", ZSTR_VAL(name));
+			}
 
 			if (ZEND_TYPE_FULL_MASK(arg_info->type) & MAY_BE_VOID) {
 				zend_error_noreturn(E_COMPILE_ERROR, "void cannot be used as a parameter type");
diff --git a/ext/date/tests/DateTime_extends_basic2.phpt b/ext/date/tests/DateTime_extends_basic2.phpt
@@ -10,7 +10,7 @@ echo "*** Testing new DateTime() : with user space __construct magic method ***\
 
 class DateTimeExt extends DateTime
 {
-    public function __construct ($date = null, DateTimeZone  $dtz = null)
+    public function __construct ($date = null, ?DateTimeZone $dtz = null)
     {
         if($dtz === null)
         {
diff --git a/ext/date/tests/bug55407.phpt b/ext/date/tests/bug55407.phpt
@@ -6,7 +6,7 @@ error_reporting=-1
 <?php namespace melt\core;
 
 class DateTime extends \DateTime {
-    public static function createFromFormat($format, $time, \DateTimeZone $timezone = null): DateTime|false {
+    public static function createFromFormat($format, $time, ?\DateTimeZone $timezone = null): DateTime|false {
         return new DateTime(parent::createFromFormat($format, $time, $timezone));
     }
 }
diff --git a/ext/opcache/tests/bug73746.phpt b/ext/opcache/tests/bug73746.phpt
@@ -11,7 +11,7 @@ class CountryMapping
     const CZ = 'CZ';
     const EN = 'EN';
 
-    public function get(string $countryIsoCode = null) : string // Works correctly if return type is removed
+    public function get(?string $countryIsoCode = null) : string // Works correctly if return type is removed
     {
         switch (strtoupper($countryIsoCode)) {
         case 'CZ':
diff --git a/ext/opcache/tests/bug74442.phpt b/ext/opcache/tests/bug74442.phpt
@@ -7,14 +7,14 @@ opcache
 --FILE--
 <?php
 class Schema_Base {
-    public function addField($typeclass, array $params = null) {
+    public function addField($typeclass, ?array $params = null) {
         $field = new $typeclass($params);
         return $field;
     }
 }
 
 class Field_Base {
-    public function __construct(array $params = null) {
+    public function __construct(?array $params = null) {
         if (! is_array($params)) {
             $params = (array) $params;
         }
diff --git a/ext/opcache/tests/invalid_array_key_type.phpt b/ext/opcache/tests/invalid_array_key_type.phpt
@@ -5,7 +5,7 @@ opcache
 --FILE--
 <?php
 
-function test(\SplObjectStorage $definitions = null) {
+function test(?\SplObjectStorage $definitions = null) {
     $argument = new stdClass;
     $definitions[$argument] = 1;
     $definitions[$argument] += 1;
diff --git a/ext/opcache/tests/jit/cast_001.phpt b/ext/opcache/tests/jit/cast_001.phpt
@@ -10,7 +10,7 @@ opcache.jit=1205
 opcache
 --FILE--
 <?php
-function foo (int $x = null) {
+function foo (?int $x = null) {
     $a = (array)$x;
     $a[] = 42;
     var_dump($a);
diff --git a/ext/opcache/tests/jit/send_var_ex_002.phpt b/ext/opcache/tests/jit/send_var_ex_002.phpt
@@ -12,7 +12,7 @@ for ($i = 0; $i < 3; $i++ ) {
 	var_dump($x);
 }	
 
-function test(&$a = null, SomeType &$b = null) {
+function test(&$a = null, ?SomeType &$b = null) {
     $a++;
 }
 ?>
diff --git a/ext/opcache/tests/opt/assign_op_002.phpt b/ext/opcache/tests/opt/assign_op_002.phpt
@@ -6,7 +6,7 @@ opcache.enable_cli=1
 opcache.optimization_level=-1
 --FILE--
 <?php
-function foo(int $a = null) {
+function foo(?int $a = null) {
     $a -= 1;
     return $a;
 }
diff --git a/ext/pdo_pgsql/tests/bug72294.phpt b/ext/pdo_pgsql/tests/bug72294.phpt
@@ -27,7 +27,7 @@ abstract class PHPUnit_Framework_TestCase
     private $name = null;
     private $result;
 
-    public function run(PHPUnit_Framework_TestResult $result = null)
+    public function run(?PHPUnit_Framework_TestResult $result = null)
     {
         $result->run($this);
     }
diff --git a/ext/reflection/tests/ReflectionClass_export_basic1.phpt b/ext/reflection/tests/ReflectionClass_export_basic1.phpt
@@ -6,7 +6,7 @@ Class A {
     public function privf(Exception $a) {}
     public function pubf(A $a,
                          $b,
-                         C $c = null,
+                         ?C $c = null,
                          $d = K,
                          $e = "15 chars long -",
                          $f = null,
@@ -20,6 +20,7 @@ define('K', "16 chars long --");
 echo new ReflectionClass("C"), "\n";
 ?>
 --EXPECTF--
+Deprecated: Implicitly marking parameter $h as nullable is deprecated, the explicit nullable type must be used instead in %s on line %d
 Class [ <user> class C extends A ] {
   @@ %s 14-14
 
diff --git a/ext/reflection/tests/bug62715.phpt b/ext/reflection/tests/bug62715.phpt
@@ -3,7 +3,7 @@ Bug #62715 (ReflectionParameter::isDefaultValueAvailable() wrong result)
 --FILE--
 <?php
 
-function test(PDO $a = null, $b = 0, array $c) {}
+function test(?PDO $a = null, $b = 0, array $c) {}
 $r = new ReflectionFunction('test');
 
 foreach ($r->getParameters() as $p) {
@@ -17,6 +17,8 @@ foreach ($r->getParameters() as $p) {
 }
 ?>
 --EXPECTF--
+Deprecated: Optional parameter $a declared before required parameter $c is implicitly treated as a required parameter in %s on line %d
+
 Deprecated: Optional parameter $b declared before required parameter $c is implicitly treated as a required parameter in %s on line %d
 bool(false)
 bool(false)
diff --git a/ext/reflection/tests/parameters_002.phpt b/ext/reflection/tests/parameters_002.phpt
@@ -11,7 +11,7 @@ function test($nix, Array $ar, &$ref, stdClass $std,
 class test
 {
     function method($nix, Array $ar, &$ref, stdClass $std,
-        NonExistingClass $na, stdClass $opt = NULL, $def = "FooBar")
+        NonExistingClass $na, ?stdClass $opt = NULL, $def = "FooBar")
     {
     }
 }
@@ -73,6 +73,7 @@ check_params(ReflectionMethod::createFromMethodName('test::method'));
 
 ?>
 --EXPECTF--
+Deprecated: Implicitly marking parameter $opt as nullable is deprecated, the explicit nullable type must be used instead in %s on line %d
 #####test()#####
 ===0===
 getName: string(3) "nix"
diff --git a/ext/reflection/tests/types/ReflectionType_001.phpt b/ext/reflection/tests/types/ReflectionType_001.phpt
@@ -100,7 +100,8 @@ $obj->std = new stdClass;
 $r = (new ReflectionProperty($obj, 'std'))->getType();
 var_dump($r->getName());
 ?>
---EXPECT--
+--EXPECTF--
+Deprecated: Implicitly marking parameter $d as nullable is deprecated, the explicit nullable type must be used instead in %s on line %d
 *** functions
 ** Function 0 - Parameter 0
 bool(true)
diff --git a/ext/reflection/tests/types/pure_intersection_type_implicitly_nullable.phpt b/ext/reflection/tests/types/pure_intersection_type_implicitly_nullable.phpt
diff --git a/ext/spl/tests/bug65328.phpt b/ext/spl/tests/bug65328.phpt
diff --git a/sapi/fpm/tests/logreader.inc b/sapi/fpm/tests/logreader.inc
diff --git a/sapi/fpm/tests/logtool.inc b/sapi/fpm/tests/logtool.inc
diff --git a/sapi/fpm/tests/tester.inc b/sapi/fpm/tests/tester.inc
diff --git a/sapi/phpdbg/tests/phpdbg_get_executable_stream_wrapper.phpt b/sapi/phpdbg/tests/phpdbg_get_executable_stream_wrapper.phpt
diff --git a/tests/classes/type_hinting_003.phpt b/tests/classes/type_hinting_003.phpt
diff --git a/tests/classes/type_hinting_004.phpt b/tests/classes/type_hinting_004.phpt
diff --git a/tests/lang/type_hints_002.phpt b/tests/lang/type_hints_002.phpt

Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@ class Node {`
`6`	`6`	`public $parent = NULL;`
`7`	`7`	`public $children = array();`
`8`	`8`
`9`		`- function __construct(Node $parent=NULL) {`
	`9`	`+ function __construct(?Node $parent=NULL) {`
`10`	`10`	`if ($parent) {`
`11`	`11`	`$parent->children[] = $this;`
`12`	`12`	`}`
Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@ bug #71428.1: inheritance with null default values`
`3`	`3`	`--FILE--`
`4`	`4`	`<?php`
`5`	`5`	`class A {`
`6`		`- public function m(array $a = null) {}`
	`6`	`+ public function m(?array $a = null) {}`
`7`	`7`	`}`
`8`	`8`	`class B extends A {`
`9`	`9`	`public function m(array $a = []) {}`
Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@ Bug #72119 (Interface declaration compatibility regression with default values)`
`3`	`3`	`--FILE--`
`4`	`4`	`<?php`
`5`	`5`	`interface Foo {`
`6`		`- public function bar(array $baz = null);`
	`6`	`+ public function bar(?array $baz = null);`
`7`	`7`	`}`
`8`	`8`
`9`	`9`	`class Hello implements Foo {`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@ Testing parameter type-hinted with default value inside namespace`
`6`	`6`	`namespace foo;`
`7`	`7`
`8`	`8`	`class bar {`
`9`		`- public function __construct(\stdclass $x = NULL) {`
	`9`	`+ public function __construct(?\stdclass $x = NULL) {`
`10`	`10`	`var_dump($x);`
`11`	`11`	`}`
`12`	`12`	`}`
Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@ interface foo {`
`10`	`10`	`}`
`11`	`11`
`12`	`12`	`class bar {`
`13`		`- public function __construct(foo $x = NULL) {`
	`13`	`+ public function __construct(?foo $x = NULL) {`
`14`	`14`	`var_dump($x);`
`15`	`15`	`}`
`16`	`16`	`}`
Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,7 @@ $x(new \stdclass);`
`14`	`14`
`15`	`15`	`?>`
`16`	`16`	`--EXPECTF--`
	`17`	`+Deprecated: Implicitly marking parameter $x as nullable is deprecated, the explicit nullable type must be used instead in %s on line %d`
`17`	`18`	`NULL`
`18`	`19`	`object(stdClass)#%d (0) {`
`19`	`20`	`}`