Skip to content

Commit 83496b5

Browse files
authored
[TypeDeclarationDocblocks] Skip ClassMethodArrayDocblockParamFromLocalCallsRector on methods overriding parent/interface (#8357)
1 parent cb1fbe1 commit 83496b5

3 files changed

Lines changed: 37 additions & 1 deletion

File tree

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
<?php
2+
3+
namespace Rector\Tests\TypeDeclarationDocblocks\Rector\Class_\ClassMethodArrayDocblockParamFromLocalCallsRector\Fixture;
4+
5+
use Rector\Tests\TypeDeclarationDocblocks\Rector\Class_\ClassMethodArrayDocblockParamFromLocalCallsRector\Source\SomeSearchInterface;
6+
7+
final class SkipInterfaceWiderParam implements SomeSearchInterface
8+
{
9+
public function findOneMatching(array $criteria): ?object
10+
{
11+
return null;
12+
}
13+
14+
public function go(string $id): ?object
15+
{
16+
return $this->findOneMatching(['id' => $id]);
17+
}
18+
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<?php
2+
3+
namespace Rector\Tests\TypeDeclarationDocblocks\Rector\Class_\ClassMethodArrayDocblockParamFromLocalCallsRector\Source;
4+
5+
interface SomeSearchInterface
6+
{
7+
/**
8+
* @param array{alias?: string, id?: string} $criteria
9+
*/
10+
public function findOneMatching(array $criteria): ?object;
11+
}

‎rules/TypeDeclarationDocblocks/Rector/Class_/ClassMethodArrayDocblockParamFromLocalCallsRector.php‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111
use PHPStan\Type\Type;
1212
use PHPStan\Type\TypeCombinator;
1313
use Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfoFactory;
14+
use Rector\NodeManipulator\ClassMethodManipulator;
1415
use Rector\PhpParser\NodeFinder\LocalMethodCallFinder;
1516
use Rector\Rector\AbstractRector;
1617
use Rector\TypeDeclaration\NodeAnalyzer\CallTypesResolver;
@@ -29,7 +30,8 @@ public function __construct(
2930
private readonly CallTypesResolver $callTypesResolver,
3031
private readonly LocalMethodCallFinder $localMethodCallFinder,
3132
private readonly UsefulArrayTagNodeAnalyzer $usefulArrayTagNodeAnalyzer,
32-
private readonly NodeDocblockTypeDecorator $nodeDocblockTypeDecorator
33+
private readonly NodeDocblockTypeDecorator $nodeDocblockTypeDecorator,
34+
private readonly ClassMethodManipulator $classMethodManipulator
3335
) {
3436
}
3537

@@ -89,6 +91,11 @@ public function refactor(Node $node): ?Node
8991
continue;
9092
}
9193

94+
// parent/interface method may declare a wider @param contract; local calls are narrower, so skip to keep LSP
95+
if ($this->classMethodManipulator->hasParentMethodOrInterfaceMethod($node, $this->getName($classMethod))) {
96+
continue;
97+
}
98+
9299
$classMethodPhpDocInfo = $this->phpDocInfoFactory->createFromNodeOrEmpty($classMethod);
93100

94101
$methodCalls = $this->localMethodCallFinder->match($node, $classMethod);

0 commit comments

Comments
 (0)