Skip to content

Commit 9bd027c

Browse files
ondrejmirtesondrejmirtes
committed
PHP 8.4 - report deprecated implicitly nullable parameter types
1 parent 9a88a77 commit 9bd027c

File tree

8 files changed

+237
-48
lines changed

8 files changed

+237
-48
lines changed

‎src/Dependency/ExportedNodeResolver.php

Lines changed: 5 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,10 @@
2222
use PHPStan\Dependency\ExportedNode\ExportedTraitNode;
2323
use PHPStan\Dependency\ExportedNode\ExportedTraitUseAdaptation;
2424
use PHPStan\Node\Printer\ExprPrinter;
25+
use PHPStan\Node\Printer\NodeTypePrinter;
2526
use PHPStan\ShouldNotHappenException;
2627
use PHPStan\Type\FileTypeMapper;
2728
use function array_map;
28-
use function implode;
2929
use function is_string;
3030

3131
final class ExportedNodeResolver
@@ -165,7 +165,7 @@ public function resolve(string $fileName, Node $node): ?RootExportedNode
165165
$docComment !== null ? $docComment->getText() : null,
166166
),
167167
$node->byRef,
168-
$this->printType($node->returnType),
168+
NodeTypePrinter::printType($node->returnType),
169169
$this->exportParameterNodes($node->params),
170170
$this->exportAttributeNodes($node->attrGroups),
171171
);
@@ -174,48 +174,6 @@ public function resolve(string $fileName, Node $node): ?RootExportedNode
174174
return null;
175175
}
176176

177-
/**
178-
* @param Node\Identifier|Node\Name|Node\ComplexType|null $type
179-
*/
180-
private function printType($type): ?string
181-
{
182-
if ($type === null) {
183-
return null;
184-
}
185-
186-
if ($type instanceof Node\NullableType) {
187-
return '?' . $this->printType($type->type);
188-
}
189-
190-
if ($type instanceof Node\UnionType) {
191-
return implode('|', array_map(function ($innerType): string {
192-
$printedType = $this->printType($innerType);
193-
if ($printedType === null) {
194-
throw new ShouldNotHappenException();
195-
}
196-
197-
return $printedType;
198-
}, $type->types));
199-
}
200-
201-
if ($type instanceof Node\IntersectionType) {
202-
return implode('&', array_map(function ($innerType): string {
203-
$printedType = $this->printType($innerType);
204-
if ($printedType === null) {
205-
throw new ShouldNotHappenException();
206-
}
207-
208-
return $printedType;
209-
}, $type->types));
210-
}
211-
212-
if ($type instanceof Node\Identifier || $type instanceof Name) {
213-
return $type->toString();
214-
}
215-
216-
throw new ShouldNotHappenException();
217-
}
218-
219177
/**
220178
* @param Node\Param[] $params
221179
* @return ExportedParameterNode[]
@@ -243,7 +201,7 @@ private function exportParameterNodes(array $params): array
243201
}
244202
$nodes[] = new ExportedParameterNode(
245203
$param->var->name,
246-
$this->printType($type),
204+
NodeTypePrinter::printType($type),
247205
$param->byRef,
248206
$param->variadic,
249207
$param->default !== null,
@@ -321,7 +279,7 @@ private function exportClassStatement(Node\Stmt $node, string $fileName, string
321279
$node->isAbstract(),
322280
$node->isFinal(),
323281
$node->isStatic(),
324-
$this->printType($node->returnType),
282+
NodeTypePrinter::printType($node->returnType),
325283
$this->exportParameterNodes($node->params),
326284
$this->exportAttributeNodes($node->attrGroups),
327285
);
@@ -343,7 +301,7 @@ private function exportClassStatement(Node\Stmt $node, string $fileName, string
343301
null,
344302
$docComment !== null ? $docComment->getText() : null,
345303
),
346-
$this->printType($node->type),
304+
NodeTypePrinter::printType($node->type),
347305
$node->isPublic(),
348306
$node->isPrivate(),
349307
$node->isStatic(),

‎src/Node/Printer/NodeTypePrinter.php

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
<?php declare(strict_types = 1);
2+
3+
namespace PHPStan\Node\Printer;
4+
5+
use PhpParser\Node;
6+
use PHPStan\ShouldNotHappenException;
7+
use function array_map;
8+
use function implode;
9+
10+
final class NodeTypePrinter
11+
{
12+
13+
public static function printType(Node\Name|Node\Identifier|Node\ComplexType|null $type): ?string
14+
{
15+
if ($type === null) {
16+
return null;
17+
}
18+
19+
if ($type instanceof Node\NullableType) {
20+
return '?' . self::printType($type->type);
21+
}
22+
23+
if ($type instanceof Node\UnionType) {
24+
return implode('|', array_map(static function ($innerType): string {
25+
$printedType = self::printType($innerType);
26+
if ($printedType === null) {
27+
throw new ShouldNotHappenException();
28+
}
29+
30+
return $printedType;
31+
}, $type->types));
32+
}
33+
34+
if ($type instanceof Node\IntersectionType) {
35+
return implode('&', array_map(static function ($innerType): string {
36+
$printedType = self::printType($innerType);
37+
if ($printedType === null) {
38+
throw new ShouldNotHappenException();
39+
}
40+
41+
return $printedType;
42+
}, $type->types));
43+
}
44+
45+
if ($type instanceof Node\Identifier || $type instanceof Node\Name) {
46+
return $type->toString();
47+
}
48+
49+
throw new ShouldNotHappenException();
50+
}
51+
52+
}

‎src/Php/PhpVersion.php

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -343,4 +343,9 @@ public function highlightStringDoesNotReturnFalse(): bool
343343
return $this->versionId >= 80400;
344344
}
345345

346+
public function deprecatesImplicitlyNullableParameterTypes(): bool
347+
{
348+
return $this->versionId >= 80400;
349+
}
350+
346351
}

‎src/Rules/FunctionDefinitionCheck.php

Lines changed: 84 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
namespace PHPStan\Rules;
44

55
use PhpParser\Node;
6+
use PhpParser\Node\ComplexType;
67
use PhpParser\Node\Expr\ConstFetch;
78
use PhpParser\Node\Expr\Variable;
89
use PhpParser\Node\FunctionLike;
@@ -15,6 +16,7 @@
1516
use PhpParser\Node\Stmt\Function_;
1617
use PhpParser\Node\UnionType;
1718
use PHPStan\Analyser\Scope;
19+
use PHPStan\Node\Printer\NodeTypePrinter;
1820
use PHPStan\Php\PhpVersion;
1921
use PHPStan\Reflection\FunctionReflection;
2022
use PHPStan\Reflection\ParameterReflection;
@@ -41,6 +43,7 @@
4143
use function in_array;
4244
use function is_string;
4345
use function sprintf;
46+
use function strtolower;
4447

4548
final class FunctionDefinitionCheck
4649
{
@@ -103,7 +106,7 @@ public function checkAnonymousFunction(
103106
{
104107
$errors = [];
105108
$unionTypeReported = false;
106-
foreach ($parameters as $param) {
109+
foreach ($parameters as $i => $param) {
107110
if ($param->type === null) {
108111
continue;
109112
}
@@ -123,6 +126,18 @@ public function checkAnonymousFunction(
123126
if (!$param->var instanceof Variable || !is_string($param->var->name)) {
124127
throw new ShouldNotHappenException();
125128
}
129+
130+
$implicitlyNullableTypeError = $this->checkImplicitlyNullableType(
131+
$param->type,
132+
$param->default,
133+
$i + 1,
134+
$param->getStartLine(),
135+
$param->var->name,
136+
);
137+
if ($implicitlyNullableTypeError !== null) {
138+
$errors[] = $implicitlyNullableTypeError;
139+
}
140+
126141
$type = $scope->getFunctionType($param->type, false, false);
127142
if ($type->isVoid()->yes()) {
128143
$errors[] = RuleErrorBuilder::message(sprintf($parameterMessage, $param->var->name, 'void'))
@@ -333,6 +348,18 @@ private function checkParametersAcceptor(
333348
}
334349
}
335350

351+
foreach ($parameterNodes as $i => $parameterNode) {
352+
if (!$parameterNode->var instanceof Variable || !is_string($parameterNode->var->name)) {
353+
throw new ShouldNotHappenException();
354+
}
355+
$implicitlyNullableTypeError = $this->checkImplicitlyNullableType($parameterNode->type, $parameterNode->default, $i + 1, $parameterNode->getStartLine(), $parameterNode->var->name);
356+
if ($implicitlyNullableTypeError === null) {
357+
continue;
358+
}
359+
360+
$errors[] = $implicitlyNullableTypeError;
361+
}
362+
336363
if ($this->phpVersion->deprecatesRequiredParameterAfterOptional()) {
337364
$errors = array_merge($errors, $this->checkRequiredParameterAfterOptional($parameterNodes));
338365
}
@@ -654,4 +681,60 @@ private function getReturnTypeReferencedClasses(ParametersAcceptor $parametersAc
654681
);
655682
}
656683

684+
private function checkImplicitlyNullableType(
685+
Identifier|Name|ComplexType|null $type,
686+
?Node\Expr $default,
687+
int $order,
688+
int $line,
689+
string $name,
690+
): ?IdentifierRuleError
691+
{
692+
if (!$default instanceof ConstFetch) {
693+
return null;
694+
}
695+
696+
if ($default->name->toLowerString() !== 'null') {
697+
return null;
698+
}
699+
700+
if ($type === null) {
701+
return null;
702+
}
703+
704+
if ($type instanceof NullableType || $type instanceof IntersectionType) {
705+
return null;
706+
}
707+
708+
if (!$this->phpVersion->deprecatesImplicitlyNullableParameterTypes()) {
709+
return null;
710+
}
711+
712+
if ($type instanceof Identifier && strtolower($type->name) === 'mixed') {
713+
return null;
714+
}
715+
if ($type instanceof Name && $type->toLowerString() === 'mixed') {
716+
return null;
717+
}
718+
719+
if ($type instanceof UnionType) {
720+
foreach ($type->types as $innerType) {
721+
if ($innerType instanceof Identifier && strtolower($innerType->name) === 'null') {
722+
return null;
723+
}
724+
if ($innerType instanceof Name && $innerType->toLowerString() === 'null') {
725+
return null;
726+
}
727+
}
728+
}
729+
730+
return RuleErrorBuilder::message(sprintf(
731+
'Deprecated in PHP 8.4: Parameter #%d $%s (%s) is implicitly nullable via default value null.',
732+
$order,
733+
$name,
734+
NodeTypePrinter::printType($type),
735+
))->line($line)
736+
->identifier('parameter.implicitlyNullable')
737+
->build();
738+
}
739+
657740
}

‎tests/PHPStan/Rules/Functions/ExistingClassesInClosureTypehintsRuleTest.php

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -330,4 +330,26 @@ public function testIntersectionTypes(int $phpVersion, array $errors): void
330330
$this->analyse([__DIR__ . '/data/closure-intersection-types.php'], $errors);
331331
}
332332

333+
public function testDeprecatedImplicitlyNullableParameterType(): void
334+
{
335+
if (PHP_VERSION_ID < 80400) {
336+
self::markTestSkipped('Test requires PHP 8.4.');
337+
}
338+
339+
$this->analyse([__DIR__ . '/data/closure-implicitly-nullable.php'], [
340+
[
341+
'Deprecated in PHP 8.4: Parameter #3 $c (int) is implicitly nullable via default value null.',
342+
13,
343+
],
344+
[
345+
'Deprecated in PHP 8.4: Parameter #5 $e (int|string) is implicitly nullable via default value null.',
346+
15,
347+
],
348+
[
349+
'Deprecated in PHP 8.4: Parameter #7 $g (stdClass) is implicitly nullable via default value null.',
350+
17,
351+
],
352+
]);
353+
}
354+
333355
}

‎tests/PHPStan/Rules/Functions/data/closure-implicitly-nullable.php

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
<?php // lint >= 8.0
2+
3+
namespace ClosureImplicitNullable;
4+
5+
class Foo
6+
{
7+
8+
public function doFoo(): void
9+
{
10+
$c = function (
11+
$a = null,
12+
int $b = 1,
13+
int $c = null,
14+
mixed $d = null,
15+
int|string $e = null,
16+
int|string|null $f = null,
17+
\stdClass $g = null,
18+
?\stdClass $h = null,
19+
): void {
20+
21+
};
22+
}
23+
24+
}

‎tests/PHPStan/Rules/Methods/ExistingClassesInTypehintsRuleTest.php

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -526,4 +526,26 @@ public function testSelfOut(): void
526526
]);
527527
}
528528

529+
public function testDeprecatedImplicitlyNullableParameterType(): void
530+
{
531+
if (PHP_VERSION_ID < 80400) {
532+
self::markTestSkipped('Test requires PHP 8.4.');
533+
}
534+
535+
$this->analyse([__DIR__ . '/data/method-implicitly-nullable.php'], [
536+
[
537+
'Deprecated in PHP 8.4: Parameter #3 $c (int) is implicitly nullable via default value null.',
538+
13,
539+
],
540+
[
541+
'Deprecated in PHP 8.4: Parameter #5 $e (int|string) is implicitly nullable via default value null.',
542+
15,
543+
],
544+
[
545+
'Deprecated in PHP 8.4: Parameter #7 $g (stdClass) is implicitly nullable via default value null.',
546+
17,
547+
],
548+
]);
549+
}
550+
529551
}

‎tests/PHPStan/Rules/Methods/data/method-implicitly-nullable.php

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
<?php
2+
3+
namespace MethodImplicitNullable;
4+
5+
use stdClass;
6+
7+
class Foo
8+
{
9+
10+
public function doFoo(
11+
$a = null,
12+
int $b = 1,
13+
int $c = null,
14+
mixed $d = null,
15+
int|string $e = null,
16+
int|string|null $f = null,
17+
stdClass $g = null,
18+
?stdClass $h = null,
19+
): void
20+
{
21+
}
22+
23+
}

0 commit comments

Comments
 (0)