rector/rules/Renaming/Rector/PropertyFetch/RenamePropertyRector.php

107 lines
3.9 KiB
PHP
Raw Normal View History

2019-10-13 05:59:52 +00:00
<?php
declare (strict_types=1);
namespace Rector\Renaming\Rector\PropertyFetch;
2017-10-21 22:04:15 +00:00
use PhpParser\Node;
use PhpParser\Node\Expr\PropertyFetch;
use PhpParser\Node\Identifier;
use PhpParser\Node\Stmt\ClassLike;
use PhpParser\Node\Stmt\Property;
use PhpParser\Node\VarLikeIdentifier;
use PHPStan\Type\ObjectType;
use Rector\Contract\Rector\ConfigurableRectorInterface;
use Rector\Rector\AbstractRector;
use Rector\Renaming\ValueObject\RenameProperty;
use Symplify\RuleDocGenerator\ValueObject\CodeSample\ConfiguredCodeSample;
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
use RectorPrefix202404\Webmozart\Assert\Assert;
2019-09-03 09:11:45 +00:00
/**
* @see \Rector\Tests\Renaming\Rector\PropertyFetch\RenamePropertyRector\RenamePropertyRectorTest
2019-09-03 09:11:45 +00:00
*/
final class RenamePropertyRector extends AbstractRector implements ConfigurableRectorInterface
2017-10-21 22:04:15 +00:00
{
/**
* @var RenameProperty[]
2017-10-21 22:04:15 +00:00
*/
private $renamedProperties = [];
/**
* @var bool
*/
private $hasChanged = \false;
public function getRuleDefinition() : RuleDefinition
2018-04-08 11:51:26 +00:00
{
return new RuleDefinition('Replaces defined old properties by new ones.', [new ConfiguredCodeSample('$someObject->someOldProperty;', '$someObject->someNewProperty;', [new RenameProperty('SomeClass', 'someOldProperty', 'someNewProperty')])]);
2018-04-08 11:51:26 +00:00
}
2018-08-14 22:12:41 +00:00
/**
* @return array<class-string<Node>>
2018-08-14 22:12:41 +00:00
*/
public function getNodeTypes() : array
2017-10-21 22:04:15 +00:00
{
return [PropertyFetch::class, ClassLike::class];
2017-10-21 22:04:15 +00:00
}
/**
* @param PropertyFetch|ClassLike $node
2017-10-21 22:04:15 +00:00
*/
public function refactor(Node $node) : ?Node
2017-10-21 22:04:15 +00:00
{
if ($node instanceof ClassLike) {
$this->hasChanged = \false;
foreach ($this->renamedProperties as $renamedProperty) {
$this->renameProperty($node, $renamedProperty);
}
if ($this->hasChanged) {
return $node;
}
return null;
2017-10-25 16:04:34 +00:00
}
return $this->refactorPropertyFetch($node);
2017-10-21 22:04:15 +00:00
}
/**
* @param mixed[] $configuration
*/
public function configure(array $configuration) : void
2020-07-29 23:39:41 +00:00
{
Assert::allIsAOf($configuration, RenameProperty::class);
$this->renamedProperties = $configuration;
2020-07-29 23:39:41 +00:00
}
private function renameProperty(ClassLike $classLike, RenameProperty $renameProperty) : void
{
$classLikeName = (string) $this->nodeNameResolver->getName($classLike);
$renamePropertyObjectType = $renameProperty->getObjectType();
$className = $renamePropertyObjectType->getClassName();
$classLikeNameObjectType = new ObjectType($classLikeName);
$classNameObjectType = new ObjectType($className);
$isSuperType = $classNameObjectType->isSuperTypeOf($classLikeNameObjectType)->yes();
if ($classLikeName !== $className && !$isSuperType) {
return;
}
$property = $classLike->getProperty($renameProperty->getOldProperty());
if (!$property instanceof Property) {
return;
}
$newProperty = $renameProperty->getNewProperty();
$targetNewProperty = $classLike->getProperty($newProperty);
if ($targetNewProperty instanceof Property) {
return;
}
$this->hasChanged = \true;
$property->props[0]->name = new VarLikeIdentifier($newProperty);
}
private function refactorPropertyFetch(PropertyFetch $propertyFetch) : ?PropertyFetch
{
foreach ($this->renamedProperties as $renamedProperty) {
$oldProperty = $renamedProperty->getOldProperty();
if (!$this->isName($propertyFetch, $oldProperty)) {
continue;
}
if (!$this->isObjectType($propertyFetch->var, $renamedProperty->getObjectType())) {
continue;
}
$propertyFetch->name = new Identifier($renamedProperty->getNewProperty());
return $propertyFetch;
}
return null;
}
2017-10-21 22:04:15 +00:00
}