Skip to content

Commit 8bbbf1b

Browse files
authored
[TypeDeclarationDocblocks] Return empty "[]" as "mixed[]" instead of "array{}" on bare "@return array" (#8432)
1 parent c8f5dae commit 8bbbf1b

2 files changed

Lines changed: 56 additions & 0 deletions

File tree

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
<?php
2+
3+
namespace Rector\Tests\TypeDeclarationDocblocks\Rector\ClassMethod\DocblockReturnArrayFromDirectArrayInstanceRector\Fixture;
4+
5+
class BareArrayEmptyToMixed
6+
{
7+
/**
8+
* @return array
9+
*/
10+
public function getRefreshTokenKeys()
11+
{
12+
return [];
13+
}
14+
}
15+
16+
?>
17+
-----
18+
<?php
19+
20+
namespace Rector\Tests\TypeDeclarationDocblocks\Rector\ClassMethod\DocblockReturnArrayFromDirectArrayInstanceRector\Fixture;
21+
22+
class BareArrayEmptyToMixed
23+
{
24+
/**
25+
* @return mixed[]
26+
*/
27+
public function getRefreshTokenKeys()
28+
{
29+
return [];
30+
}
31+
}
32+
33+
?>

‎rules/TypeDeclarationDocblocks/Rector/ClassMethod/DocblockReturnArrayFromDirectArrayInstanceRector.php‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,12 @@
1111
use PhpParser\Node\Stmt\Return_;
1212
use PHPStan\PhpDocParser\Ast\PhpDoc\ReturnTagValueNode;
1313
use PHPStan\PhpDocParser\Ast\Type\ArrayTypeNode;
14+
use PHPStan\PhpDocParser\Ast\Type\IdentifierTypeNode;
1415
use PHPStan\Type\Constant\ConstantArrayType;
1516
use Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfo;
1617
use Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfoFactory;
1718
use Rector\BetterPhpDocParser\PhpDocManipulator\PhpDocTypeChanger;
19+
use Rector\BetterPhpDocParser\ValueObject\Type\SpacingAwareArrayTypeNode;
1820
use Rector\Rector\AbstractRector;
1921
use Rector\TypeDeclarationDocblocks\NodeFinder\ReturnNodeFinder;
2022
use Rector\TypeDeclarationDocblocks\TagNodeAnalyzer\UsefulArrayTagNodeAnalyzer;
@@ -114,6 +116,17 @@ public function refactor(Node $node): ?Node
114116
return null;
115117
}
116118

119+
// bare "@return array" with "return []" -> "mixed[]", better than "array{}"
120+
if ($soleReturn->expr->items === [] && $this->hasBareArrayReturnTag($phpDocInfo)) {
121+
$this->phpDocTypeChanger->changeReturnTypeNode(
122+
$node,
123+
$phpDocInfo,
124+
new SpacingAwareArrayTypeNode(new IdentifierTypeNode('mixed'))
125+
);
126+
127+
return $node;
128+
}
129+
117130
// resolve simple type
118131
$returnedType = $this->getType($soleReturn->expr);
119132
if (! $returnedType instanceof ConstantArrayType) {
@@ -147,4 +160,14 @@ private function shouldSkipReturnMixedAndEmptyArray(PhpDocInfo $phpDocInfo, Arra
147160
// better than array{}
148161
return $returnTagValueNode->type instanceof ArrayTypeNode;
149162
}
163+
164+
private function hasBareArrayReturnTag(PhpDocInfo $phpDocInfo): bool
165+
{
166+
$returnTagValueNode = $phpDocInfo->getReturnTagValue();
167+
if (! $returnTagValueNode instanceof ReturnTagValueNode) {
168+
return false;
169+
}
170+
171+
return $returnTagValueNode->type instanceof IdentifierTypeNode && $returnTagValueNode->type->name === 'array';
172+
}
150173
}

0 commit comments

Comments
 (0)