2019-12-19 22:07:06 +00:00
< ? php
2021-05-09 20:15:43 +00:00
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_ ;
2021-03-07 21:07:50 +00:00
use PHPStan\Analyser\Scope ;
use PHPStan\Reflection\ClassReflection ;
2020-07-29 23:39:41 +00:00
use Rector\Core\Contract\Rector\ConfigurableRectorInterface ;
2020-02-06 21:48:18 +00:00
use Rector\Core\Rector\AbstractRector ;
2021-03-07 21:07:50 +00:00
use Rector\NodeTypeResolver\Node\AttributeKey ;
2020-11-16 17:50:38 +00:00
use Symplify\RuleDocGenerator\ValueObject\CodeSample\ConfiguredCodeSample ;
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition ;
2021-12-06 06:57:16 +00:00
use RectorPrefix20211206\Webmozart\Assert\Assert ;
2019-12-19 22:07:06 +00:00
/**
2021-03-12 22:20:25 +00:00
* @ see \Rector\Tests\Transform\Rector\Class_\AddInterfaceByTraitRector\AddInterfaceByTraitRectorTest
2019-12-19 22:07:06 +00:00
*/
2021-05-10 22:23:08 +00:00
final class AddInterfaceByTraitRector extends \Rector\Core\Rector\AbstractRector implements \Rector\Core\Contract\Rector\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' ;
2019-12-19 22:07:06 +00:00
/**
2021-03-07 21:07:50 +00:00
* @ var array < string , string >
2019-12-19 22:07:06 +00:00
*/
private $interfaceByTrait = [];
2021-05-10 22:23:08 +00:00
public function getRuleDefinition () : \Symplify\RuleDocGenerator\ValueObject\RuleDefinition
2019-12-19 22:07:06 +00:00
{
2021-05-10 22:23:08 +00:00
return new \Symplify\RuleDocGenerator\ValueObject\RuleDefinition ( 'Add interface by used trait' , [ new \Symplify\RuleDocGenerator\ValueObject\CodeSample\ConfiguredCodeSample ( <<< 'CODE_SAMPLE'
2019-12-19 22:07:06 +00:00
class SomeClass
{
use SomeTrait ;
}
2020-09-15 08:23:13 +00:00
CODE_SAMPLE
2021-05-09 20:15:43 +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
2021-05-09 20:15:43 +00:00
, [ self :: INTERFACE_BY_TRAIT => [ '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
*/
2021-05-09 20:15:43 +00:00
public function getNodeTypes () : array
2019-12-19 22:07:06 +00:00
{
2021-05-10 22:23:08 +00:00
return [ \PhpParser\Node\Stmt\Class_ :: class ];
2019-12-19 22:07:06 +00:00
}
/**
2021-07-05 22:50:18 +00:00
* @ param Class_ $node
2019-12-19 22:07:06 +00:00
*/
2021-07-05 22:50:18 +00:00
public function refactor ( \PhpParser\Node $node ) : ? \PhpParser\Node
2019-12-19 22:07:06 +00:00
{
2021-03-07 21:07:50 +00:00
/** @var Scope $scope */
2021-05-10 22:23:08 +00:00
$scope = $node -> getAttribute ( \Rector\NodeTypeResolver\Node\AttributeKey :: SCOPE );
2021-03-07 21:07:50 +00:00
$classReflection = $scope -> getClassReflection ();
2021-05-10 22:23:08 +00:00
if ( ! $classReflection instanceof \PHPStan\Reflection\ClassReflection ) {
2019-12-19 22:07:06 +00:00
return null ;
}
2021-03-07 21:07:50 +00:00
foreach ( $this -> interfaceByTrait as $traitName => $interfaceName ) {
2021-05-09 20:15:43 +00:00
if ( ! $classReflection -> hasTraitUse ( $traitName )) {
2020-05-03 14:16:10 +00:00
continue ;
}
2021-03-07 21:07:50 +00:00
foreach ( $node -> implements as $implement ) {
if ( $this -> isName ( $implement , $interfaceName )) {
continue 2 ;
}
2019-12-19 22:07:06 +00:00
}
2021-05-10 22:23:08 +00:00
$node -> implements [] = new \PhpParser\Node\Name\FullyQualified ( $interfaceName );
2019-12-19 22:07:06 +00:00
}
return $node ;
}
2021-03-07 21:07:50 +00:00
/**
2021-11-27 13:43:28 +00:00
* @ todo complex configuration , introduce value object !
2021-11-28 17:01:20 +00:00
* @ param mixed [] $configuration
2021-03-07 21:07:50 +00:00
*/
2021-05-09 20:15:43 +00:00
public function configure ( array $configuration ) : void
2020-07-29 23:39:41 +00:00
{
2021-11-28 17:01:20 +00:00
$interfaceByTrait = $configuration [ self :: INTERFACE_BY_TRAIT ] ? ? $configuration ;
2021-12-06 06:57:16 +00:00
\RectorPrefix20211206\Webmozart\Assert\Assert :: isArray ( $interfaceByTrait );
\RectorPrefix20211206\Webmozart\Assert\Assert :: allString ( \array_keys ( $interfaceByTrait ));
\RectorPrefix20211206\Webmozart\Assert\Assert :: allString ( $interfaceByTrait );
2021-11-27 13:43:28 +00:00
$this -> interfaceByTrait = $interfaceByTrait ;
2020-07-29 23:39:41 +00:00
}
2019-12-19 22:07:06 +00:00
}