2019-12-19 22:07:06 +00:00
|
|
|
<?php
|
|
|
|
|
|
|
|
declare(strict_types=1);
|
|
|
|
|
2021-02-20 22:48:31 +00:00
|
|
|
namespace Rector\Transform\Rector\Class_;
|
2019-12-19 22:07:06 +00:00
|
|
|
|
|
|
|
use PhpParser\Node;
|
|
|
|
use PhpParser\Node\Name\FullyQualified;
|
|
|
|
use PhpParser\Node\Stmt\Class_;
|
2020-07-29 23:39:41 +00:00
|
|
|
use Rector\Core\Contract\Rector\ConfigurableRectorInterface;
|
2021-02-08 12:33:17 +00:00
|
|
|
use Rector\Core\NodeManipulator\ClassManipulator;
|
2020-02-06 21:48:18 +00:00
|
|
|
use Rector\Core\Rector\AbstractRector;
|
2020-11-16 17:50:38 +00:00
|
|
|
use Symplify\RuleDocGenerator\ValueObject\CodeSample\ConfiguredCodeSample;
|
|
|
|
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
|
2019-12-19 22:07:06 +00:00
|
|
|
|
|
|
|
/**
|
2021-02-20 22:48:31 +00:00
|
|
|
* @see \Rector\Transform\Tests\Rector\Class_\AddInterfaceByTraitRector\AddInterfaceByTraitRectorTest
|
2019-12-19 22:07:06 +00:00
|
|
|
*/
|
2020-07-29 23:39:41 +00:00
|
|
|
final class AddInterfaceByTraitRector extends AbstractRector implements ConfigurableRectorInterface
|
2019-12-19 22:07:06 +00:00
|
|
|
{
|
2020-07-29 23:39:41 +00:00
|
|
|
/**
|
|
|
|
* @var string
|
|
|
|
*/
|
2021-02-20 22:48:31 +00:00
|
|
|
public const INTERFACE_BY_TRAIT = 'interface_by_trait';
|
2020-07-29 23:39:41 +00:00
|
|
|
|
2019-12-19 22:07:06 +00:00
|
|
|
/**
|
|
|
|
* @var string[]
|
|
|
|
*/
|
|
|
|
private $interfaceByTrait = [];
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @var ClassManipulator
|
|
|
|
*/
|
|
|
|
private $classManipulator;
|
|
|
|
|
2020-07-29 23:39:41 +00:00
|
|
|
public function __construct(ClassManipulator $classManipulator)
|
2019-12-19 22:07:06 +00:00
|
|
|
{
|
|
|
|
$this->classManipulator = $classManipulator;
|
|
|
|
}
|
|
|
|
|
2020-11-16 17:50:38 +00:00
|
|
|
public function getRuleDefinition(): RuleDefinition
|
2019-12-19 22:07:06 +00:00
|
|
|
{
|
2020-11-16 17:50:38 +00:00
|
|
|
return new RuleDefinition('Add interface by used trait', [
|
2019-12-19 22:07:06 +00:00
|
|
|
new ConfiguredCodeSample(
|
2020-09-15 08:23:13 +00:00
|
|
|
<<<'CODE_SAMPLE'
|
2019-12-19 22:07:06 +00:00
|
|
|
class SomeClass
|
|
|
|
{
|
|
|
|
use SomeTrait;
|
|
|
|
}
|
2020-09-15 08:23:13 +00:00
|
|
|
CODE_SAMPLE
|
2019-12-19 22:07:06 +00:00
|
|
|
,
|
2020-09-15 08:23:13 +00:00
|
|
|
<<<'CODE_SAMPLE'
|
2019-12-19 22:07:06 +00:00
|
|
|
class SomeClass implements SomeInterface
|
|
|
|
{
|
|
|
|
use SomeTrait;
|
|
|
|
}
|
2020-09-15 08:23:13 +00:00
|
|
|
CODE_SAMPLE
|
2019-12-19 22:07:06 +00:00
|
|
|
, [
|
2020-08-12 09:44:34 +00:00
|
|
|
self::INTERFACE_BY_TRAIT => [
|
2019-11-26 07:45:39 +00:00
|
|
|
'SomeTrait' => 'SomeInterface',
|
|
|
|
],
|
|
|
|
]),
|
2019-12-19 22:07:06 +00:00
|
|
|
]);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2021-02-27 00:06:15 +00:00
|
|
|
* @return array<class-string<Node>>
|
2019-12-19 22:07:06 +00:00
|
|
|
*/
|
|
|
|
public function getNodeTypes(): array
|
|
|
|
{
|
|
|
|
return [Class_::class];
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @param Class_ $node
|
|
|
|
*/
|
|
|
|
public function refactor(Node $node): ?Node
|
|
|
|
{
|
2021-03-03 21:51:04 +00:00
|
|
|
if ($this->classAnalyzer->isAnonymousClass($node)) {
|
2019-12-19 22:07:06 +00:00
|
|
|
return null;
|
|
|
|
}
|
|
|
|
|
|
|
|
$usedTraitNames = $this->classManipulator->getUsedTraits($node);
|
|
|
|
if ($usedTraitNames === []) {
|
|
|
|
return null;
|
|
|
|
}
|
|
|
|
|
2019-12-19 22:55:50 +00:00
|
|
|
$implementedInterfaceNames = $this->classManipulator->getImplementedInterfaceNames($node);
|
|
|
|
|
2019-12-19 22:07:06 +00:00
|
|
|
foreach (array_keys($usedTraitNames) as $traitName) {
|
2020-05-03 14:16:10 +00:00
|
|
|
if (! isset($this->interfaceByTrait[$traitName])) {
|
|
|
|
continue;
|
|
|
|
}
|
2019-12-19 22:07:06 +00:00
|
|
|
|
2020-05-03 14:16:10 +00:00
|
|
|
$interfaceNameToAdd = $this->interfaceByTrait[$traitName];
|
2019-12-19 22:55:50 +00:00
|
|
|
|
2020-05-03 14:16:10 +00:00
|
|
|
if (in_array($interfaceNameToAdd, $implementedInterfaceNames, true)) {
|
|
|
|
continue;
|
2019-12-19 22:07:06 +00:00
|
|
|
}
|
2020-05-03 14:16:10 +00:00
|
|
|
|
|
|
|
$node->implements[] = new FullyQualified($interfaceNameToAdd);
|
2019-12-19 22:07:06 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
return $node;
|
|
|
|
}
|
2020-07-29 23:39:41 +00:00
|
|
|
|
|
|
|
public function configure(array $configuration): void
|
|
|
|
{
|
|
|
|
$this->interfaceByTrait = $configuration[self::INTERFACE_BY_TRAIT] ?? [];
|
|
|
|
}
|
2019-12-19 22:07:06 +00:00
|
|
|
}
|