Skip to content

Skip overridden methods in DocblockReturnArrayFromDirectArrayInstanceRector #9656

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Copilot wants to merge 3 commits into from
Closed

Skip overridden methods in DocblockReturnArrayFromDirectArrayInstanceRector #9656

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
760a069
Initial plan
Copilot Feb 17, 2026
c34394f
Fix issue #9599: Skip adding docblock to overridden methods
Copilot Feb 17, 2026
403f0c1
Simplify shouldSkipOverriddenMethod to use hasParentClassMethod
Copilot Feb 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 17 additions & 1 deletion ...larationDocblocks/Rector/ClassMethod/DocblockReturnArrayFromDirectArrayInstanceRector.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
use Rector\TypeDeclarationDocblocks\NodeFinder\ReturnNodeFinder;
use Rector\TypeDeclarationDocblocks\TagNodeAnalyzer\UsefulArrayTagNodeAnalyzer;
use Rector\TypeDeclarationDocblocks\TypeResolver\ConstantArrayTypeGeneralizer;
use Rector\VendorLocker\ParentClassMethodTypeOverrideGuard;
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
/**
Expand Down Expand Up @@ -45,13 +46,18 @@ final class DocblockReturnArrayFromDirectArrayInstanceRector extends AbstractRec
* @readonly
*/
private UsefulArrayTagNodeAnalyzer $usefulArrayTagNodeAnalyzer;
public function __construct(PhpDocInfoFactory $phpDocInfoFactory, PhpDocTypeChanger $phpDocTypeChanger, ConstantArrayTypeGeneralizer $constantArrayTypeGeneralizer, ReturnNodeFinder $returnNodeFinder, UsefulArrayTagNodeAnalyzer $usefulArrayTagNodeAnalyzer)
/**
* @readonly
*/
private ParentClassMethodTypeOverrideGuard $parentClassMethodTypeOverrideGuard;
public function __construct(PhpDocInfoFactory $phpDocInfoFactory, PhpDocTypeChanger $phpDocTypeChanger, ConstantArrayTypeGeneralizer $constantArrayTypeGeneralizer, ReturnNodeFinder $returnNodeFinder, UsefulArrayTagNodeAnalyzer $usefulArrayTagNodeAnalyzer, ParentClassMethodTypeOverrideGuard $parentClassMethodTypeOverrideGuard)
{
$this->phpDocInfoFactory = $phpDocInfoFactory;
$this->phpDocTypeChanger = $phpDocTypeChanger;
$this->constantArrayTypeGeneralizer = $constantArrayTypeGeneralizer;
$this->returnNodeFinder = $returnNodeFinder;
$this->usefulArrayTagNodeAnalyzer = $usefulArrayTagNodeAnalyzer;
$this->parentClassMethodTypeOverrideGuard = $parentClassMethodTypeOverrideGuard;
}
public function getNodeTypes(): array
{
Expand Down Expand Up @@ -98,6 +104,10 @@ public function refactor(Node $node): ?Node
if ($this->usefulArrayTagNodeAnalyzer->isUsefulArrayTag($phpDocInfo->getReturnTagValue())) {
return null;
}
// skip if method overrides parent method with return docblock
if ($node instanceof ClassMethod && $this->shouldSkipOverriddenMethod($node)) {
return null;
}
$soleReturn = $this->returnNodeFinder->findOnlyReturnWithExpr($node);
if (!$soleReturn instanceof Return_) {
return null;
Expand Down Expand Up @@ -133,4 +143,10 @@ private function shouldSkipReturnMixedAndEmptyArray(PhpDocInfo $phpDocInfo, Arra
// better than array{}
return $returnTagValueNode->type instanceof ArrayTypeNode;
}
private function shouldSkipOverriddenMethod(ClassMethod $classMethod): bool
{
// Check if this method overrides a parent method
// If parent method exists, skip adding docblock as it should inherit documentation from parent
return $this->parentClassMethodTypeOverrideGuard->hasParentClassMethod($classMethod);
}
}