rector/rules/Renaming/Rector/FuncCall/RenameFunctionRector.php

77 lines
3.0 KiB
PHP
Raw Normal View History

2019-10-13 05:59:52 +00:00
<?php
declare (strict_types=1);
namespace Rector\Renaming\Rector\FuncCall;
use PhpParser\Node;
use PhpParser\Node\Expr\FuncCall;
2019-02-19 15:56:41 +00:00
use PhpParser\Node\Name;
use PhpParser\Node\Name\FullyQualified;
2020-07-29 13:55:33 +00:00
use Rector\Core\Contract\Rector\ConfigurableRectorInterface;
use Rector\Core\Rector\AbstractRector;
use Rector\NodeTypeResolver\Node\AttributeKey;
use Symplify\RuleDocGenerator\ValueObject\CodeSample\ConfiguredCodeSample;
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
use RectorPrefix20211128\Webmozart\Assert\Assert;
2019-09-03 09:11:45 +00:00
/**
* @see \Rector\Tests\Renaming\Rector\FuncCall\RenameFunctionRector\RenameFunctionRectorTest
2019-09-03 09:11:45 +00:00
*/
final class RenameFunctionRector extends \Rector\Core\Rector\AbstractRector implements \Rector\Core\Contract\Rector\ConfigurableRectorInterface
{
/**
2020-07-29 13:55:33 +00:00
* @var string
*/
public const OLD_FUNCTION_TO_NEW_FUNCTION = 'old_function_to_new_function';
/**
* @var array<string, string>
*/
2020-07-29 13:55:33 +00:00
private $oldFunctionToNewFunction = [];
public function getRuleDefinition() : \Symplify\RuleDocGenerator\ValueObject\RuleDefinition
{
return new \Symplify\RuleDocGenerator\ValueObject\RuleDefinition('Turns defined function call new one.', [new \Symplify\RuleDocGenerator\ValueObject\CodeSample\ConfiguredCodeSample('view("...", []);', 'Laravel\\Templating\\render("...", []);', [self::OLD_FUNCTION_TO_NEW_FUNCTION => ['view' => 'Laravel\\Templating\\render']])]);
}
/**
* @return array<class-string<Node>>
*/
public function getNodeTypes() : array
{
return [\PhpParser\Node\Expr\FuncCall::class];
}
/**
* @param FuncCall $node
*/
public function refactor(\PhpParser\Node $node) : ?\PhpParser\Node
{
2018-10-22 17:39:10 +00:00
foreach ($this->oldFunctionToNewFunction as $oldFunction => $newFunction) {
if (!$this->isName($node, $oldFunction)) {
2018-10-22 17:39:10 +00:00
continue;
}
// not to refactor here
$isVirtual = $node->name->getAttribute(\Rector\NodeTypeResolver\Node\AttributeKey::VIRTUAL_NODE);
if ($isVirtual) {
continue;
}
$node->name = $this->createName($newFunction);
return $node;
2018-10-22 17:39:10 +00:00
}
return null;
}
2020-07-29 13:55:33 +00:00
/**
* @param array<string, mixed[]> $configuration
2020-07-29 13:55:33 +00:00
*/
public function configure(array $configuration) : void
2020-07-29 13:55:33 +00:00
{
$oldFunctionToNewFunction = $configuration[self::OLD_FUNCTION_TO_NEW_FUNCTION] ?? $configuration ?: [];
\RectorPrefix20211128\Webmozart\Assert\Assert::allString($oldFunctionToNewFunction);
\RectorPrefix20211128\Webmozart\Assert\Assert::allString(\array_values($oldFunctionToNewFunction));
$this->oldFunctionToNewFunction = $oldFunctionToNewFunction;
2020-07-29 13:55:33 +00:00
}
private function createName(string $newFunction) : \PhpParser\Node\Name
{
if (\strpos($newFunction, '\\') !== \false) {
return new \PhpParser\Node\Name\FullyQualified($newFunction);
}
return new \PhpParser\Node\Name($newFunction);
}
}