Add Rule: nullable_type_declaration_for_default_null_value

[Jubeki]

PHP-CS-Fixer Rule: nullable_type_declaration_for_default_null_value

With the given configuration this will change it like this (Taken from the PHP-CS-Fixer Page):

--- Original
+++ New
 <?php
-function sample(?string $str = null)
+function sample(string $str = null)
 {}

--- Original
+++ New
 <?php
-function sample(string|int|null $str = null)
+function sample(string|int $str = null)
 {}

--- Original
+++ New
 <?php
-function sample((\Foo&\Bar)|null $str = null)
+function sample(\Foo&\Bar $str = null)
 {}

This rule is currently not enforced in laravel/framework repository, but I saw some comments in PR's were it was said that the question mark should not be added because of the null default argument:

• Without the question mark: Illuminate\Mail\Mailables\Envelope
• With Question Mark: Illuminate\Process\Factory

[driesvints]

Seems to make sense 👍

https://3v4l.org/3lGsj

[taylorotwell]

Hey @Jubeki - can you resolve the conflict on this and mark ready for review again? Thanks!

[woganmay]

I know this PR has already been merged, but I'm not sure the semantics of the change make sense. PHP's ? operator indicates that the value is optional and will default to null if not provided, so these are readable as:

• sample(string $str = null) means "A string value $str is required and will default to null if not provided"
• sample(?string $str = null) means "A string value $str is NOT required and will default to null if not provided"
• sample(?string $str) means "A string value $str is NOT required" and "by PHP default behavior, will default to null if not provided"

From a code readability standpoint, ?string reads more explicitly than string $str = null, in that it clearly indicates that $str is nullable. I don't know what the general consensus on this is in the PHP community, but I would have thought that pushing for ? being the standard for indicating nullable makes the most sense?

[adevade]

I think it would look better to keep the ? as well. Using the latest Pint gave me the following diff:

- command(?string $to = null, ?string $forward = 'RootEntityId')
+ command(string $to = null, ?string $forward = 'RootEntityId')

Removing the first ? and keeping the second one.

Feels more consistent and easier to keep the question mark.

[andrade-felipe-dev]

o use it the way it was with the "?" indicator. Would I have to change the pint version in the composer? Because if this change were made it would be necessary to at least have some configuration to keep it as it was.

[dennisvandalen]

o use it the way it was with the "?" indicator. Would I have to change the pint version in the composer? Because if this change were made it would be necessary to at least have some configuration to keep it as it was.

Update your pint.json:

{
    "preset": "laravel",
    "rules": {
        "nullable_type_declaration_for_default_null_value": true
    }
}