Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
<?php

namespace Rector\Tests\TypeDeclarationDocblocks\Rector\ClassMethod\AddParamArrayDocblockFromDimFetchAccessRector\Fixture;

final class OverrideDummyArrayParam
{
/**
* @param array $data
*/
public function process(array $data): void
{
$item = $data['key'];

$anotherItem = $data['another_key'];
}
}

?>
-----
<?php

namespace Rector\Tests\TypeDeclarationDocblocks\Rector\ClassMethod\AddParamArrayDocblockFromDimFetchAccessRector\Fixture;

final class OverrideDummyArrayParam
{
/**
* @param array<string, mixed> $data
*/
public function process(array $data): void
{
$item = $data['key'];

$anotherItem = $data['another_key'];
}
}

?>
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,12 @@
use PHPStan\PhpDocParser\Ast\Type\GenericTypeNode;
use PHPStan\PhpDocParser\Ast\Type\IdentifierTypeNode;
use PHPStan\Type\Type;
use Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfo;
use Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfoFactory;
use Rector\Comments\NodeDocBlock\DocBlockUpdater;
use Rector\Rector\AbstractRector;
use Rector\TypeDeclarationDocblocks\NodeFinder\ArrayDimFetchFinder;
use Rector\TypeDeclarationDocblocks\TagNodeAnalyzer\UsefulArrayTagNodeAnalyzer;
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;

Expand All @@ -27,7 +29,8 @@ final class AddParamArrayDocblockFromDimFetchAccessRector extends AbstractRector
public function __construct(
private readonly PhpDocInfoFactory $phpDocInfoFactory,
private readonly ArrayDimFetchFinder $arrayDimFetchFinder,
private readonly DocBlockUpdater $docBlockUpdater
private readonly DocBlockUpdater $docBlockUpdater,
private readonly UsefulArrayTagNodeAnalyzer $usefulArrayTagNodeAnalyzer
) {
}

Expand Down Expand Up @@ -105,7 +108,7 @@ public function refactor(Node $node): ?Node
$paramTagValueNode = $phpDocInfo->getParamTagValueByName($paramName);

// already defined, lets skip it
if ($paramTagValueNode instanceof ParamTagValueNode) {
if ($this->usefulArrayTagNodeAnalyzer->isUsefulArrayTag($paramTagValueNode)) {
continue;
}

Expand All @@ -130,15 +133,13 @@ public function refactor(Node $node): ?Node
}

if ($this->isOnlyStringType($keyTypes)) {
$paramTagValueNode = $this->createParamTagValueNode($paramName, 'string');
$phpDocInfo->addTagValueNode($paramTagValueNode);
$this->createParamTagValueNode($phpDocInfo, $paramName, 'string', $paramTagValueNode);
$hasChanged = true;
continue;
}

if ($this->isOnlyIntegerType($keyTypes)) {
$paramTagValueNode = $this->createParamTagValueNode($paramName, 'int');
$phpDocInfo->addTagValueNode($paramTagValueNode);
$this->createParamTagValueNode($phpDocInfo, $paramName, 'int', $paramTagValueNode);
$hasChanged = true;
continue;
}
Expand Down Expand Up @@ -186,13 +187,22 @@ private function isOnlyIntegerType(array $keyTypes): bool
return true;
}

private function createParamTagValueNode(string $paramName, string $keyTypeValue): ParamTagValueNode
{
private function createParamTagValueNode(
PhpDocInfo $phpDocInfo,
string $paramName,
string $keyTypeValue,
?ParamTagValueNode $paramTagValueNode
): void {
$arrayGenericTypeNode = new GenericTypeNode(new IdentifierTypeNode('array'), [
new IdentifierTypeNode($keyTypeValue),
new IdentifierTypeNode('mixed'),
]);

return new ParamTagValueNode($arrayGenericTypeNode, false, '$' . $paramName, '', false);
if ($paramTagValueNode instanceof ParamTagValueNode) {
$paramTagValueNode->type = $arrayGenericTypeNode;
} else {
$paramTagValueNode = new ParamTagValueNode($arrayGenericTypeNode, false, '$' . $paramName, '', false);
$phpDocInfo->addTagValueNode($paramTagValueNode);
}
}
}