|
| 1 | +<?php |
| 2 | + |
| 3 | +declare(strict_types=1); |
| 4 | + |
| 5 | +namespace Drupal\PHPStan\Custom; |
| 6 | + |
| 7 | +use PhpParser\Node; |
| 8 | +use PhpParser\Node\Stmt\Class_; |
| 9 | +use PhpParser\Node\Stmt\TraitUse; |
| 10 | +use PHPStan\Analyser\Scope; |
| 11 | +use PHPStan\Reflection\ReflectionProvider; |
| 12 | +use PHPStan\Rules\Rule; |
| 13 | +use PHPStan\Rules\RuleErrorBuilder; |
| 14 | +use function array_filter; |
| 15 | +use function array_merge; |
| 16 | +use function array_unique; |
| 17 | +use function basename; |
| 18 | +use function count; |
| 19 | +use function in_array; |
| 20 | +use function sprintf; |
| 21 | +use function str_replace; |
| 22 | + |
| 23 | +/** |
| 24 | + * Disallows redundant trait usage when a trait is already included via another. |
| 25 | + * |
| 26 | + * This rule checks classes that use multiple traits and ensures that they don't |
| 27 | + * use a trait that is already being used by another trait. For example, if |
| 28 | + * trait A uses trait B, then a class shouldn't use both A and B. |
| 29 | + * |
| 30 | + * @implements Rule<Class_> |
| 31 | + */ |
| 32 | +class NoRedundantTraitUseRule implements Rule { |
| 33 | + |
| 34 | + private const ERROR_MESSAGE = 'Class uses trait "%s" redundantly as it is already included via trait "%s".'; |
| 35 | + |
| 36 | + /** |
| 37 | + * The reflection provider. |
| 38 | + * |
| 39 | + * @var \PHPStan\Reflection\ReflectionProvider |
| 40 | + */ |
| 41 | + private ReflectionProvider $reflectionProvider; |
| 42 | + |
| 43 | + /** |
| 44 | + * Constructs a new NoRedundantTraitUseRule. |
| 45 | + * |
| 46 | + * @param \PHPStan\Reflection\ReflectionProvider $reflectionProvider |
| 47 | + * The reflection provider. |
| 48 | + */ |
| 49 | + public function __construct(ReflectionProvider $reflectionProvider) { |
| 50 | + $this->reflectionProvider = $reflectionProvider; |
| 51 | + } |
| 52 | + |
| 53 | + /** |
| 54 | + * {@inheritdoc} |
| 55 | + */ |
| 56 | + public function getNodeType(): string { |
| 57 | + return Class_::class; |
| 58 | + } |
| 59 | + |
| 60 | + /** |
| 61 | + * {@inheritdoc} |
| 62 | + */ |
| 63 | + public function processNode(Node $node, Scope $scope): array { |
| 64 | + $errors = []; |
| 65 | + |
| 66 | + // Get all trait use statements from the class. |
| 67 | + $traitUseNodes = array_filter($node->stmts, static fn ($stmt): bool => $stmt instanceof TraitUse); |
| 68 | + |
| 69 | + if (count($traitUseNodes) < 2) { |
| 70 | + // Need at least 2 traits to have redundancy. |
| 71 | + return []; |
| 72 | + } |
| 73 | + |
| 74 | + // Collect all directly used trait names with their resolved names. |
| 75 | + $directlyUsedTraits = []; |
| 76 | + foreach ($traitUseNodes as $traitUseNode) { |
| 77 | + foreach ($traitUseNode->traits as $trait) { |
| 78 | + $traitName = $scope->resolveName($trait); |
| 79 | + $directlyUsedTraits[] = $traitName; |
| 80 | + } |
| 81 | + } |
| 82 | + |
| 83 | + // Build a map of trait -> [traits it uses] with full resolution. |
| 84 | + $traitDependencies = []; |
| 85 | + foreach ($directlyUsedTraits as $traitName) { |
| 86 | + try { |
| 87 | + if ($this->reflectionProvider->hasClass($traitName)) { |
| 88 | + $traitReflection = $this->reflectionProvider->getClass($traitName); |
| 89 | + if ($traitReflection->isTrait()) { |
| 90 | + $traitDependencies[$traitName] = $this->getAllTraitsUsedByTrait($traitName, []); |
| 91 | + } |
| 92 | + } |
| 93 | + } |
| 94 | + catch (\Throwable $e) { |
| 95 | + // Skip traits that can't be reflected. |
| 96 | + continue; |
| 97 | + } |
| 98 | + } |
| 99 | + |
| 100 | + // Check for redundancies. |
| 101 | + foreach ($directlyUsedTraits as $traitA) { |
| 102 | + foreach ($directlyUsedTraits as $traitB) { |
| 103 | + if ($traitA === $traitB) { |
| 104 | + continue; |
| 105 | + } |
| 106 | + |
| 107 | + // Check if traitA uses traitB (directly or transitively). |
| 108 | + if (isset($traitDependencies[$traitA]) && in_array($traitB, $traitDependencies[$traitA], TRUE)) { |
| 109 | + $shortNameA = basename(str_replace('\\', '/', $traitA)); |
| 110 | + $shortNameB = basename(str_replace('\\', '/', $traitB)); |
| 111 | + |
| 112 | + $errors[] = RuleErrorBuilder::message(sprintf(self::ERROR_MESSAGE, $shortNameB, $shortNameA)) |
| 113 | + ->line($node->getStartLine()) |
| 114 | + ->identifier('traits.redundantTraitUse') |
| 115 | + ->build(); |
| 116 | + |
| 117 | + // Only report each redundant trait once. |
| 118 | + break; |
| 119 | + } |
| 120 | + } |
| 121 | + } |
| 122 | + |
| 123 | + return $errors; |
| 124 | + } |
| 125 | + |
| 126 | + /** |
| 127 | + * Get all traits used by a given trait recursively. |
| 128 | + * |
| 129 | + * @param string $traitName |
| 130 | + * The fully qualified trait name. |
| 131 | + * @param array<string> $visited |
| 132 | + * Array to track visited traits (for cycle detection). |
| 133 | + * |
| 134 | + * @return array<string> |
| 135 | + * Array of all trait names used by the given trait (directly and |
| 136 | + * transitively). |
| 137 | + */ |
| 138 | + private function getAllTraitsUsedByTrait(string $traitName, array $visited = []): array { |
| 139 | + // Prevent infinite loops. |
| 140 | + if (in_array($traitName, $visited, TRUE)) { |
| 141 | + return []; |
| 142 | + } |
| 143 | + |
| 144 | + $visited[] = $traitName; |
| 145 | + |
| 146 | + try { |
| 147 | + if (!$this->reflectionProvider->hasClass($traitName)) { |
| 148 | + return []; |
| 149 | + } |
| 150 | + |
| 151 | + $traitReflection = $this->reflectionProvider->getClass($traitName); |
| 152 | + if (!$traitReflection->isTrait()) { |
| 153 | + return []; |
| 154 | + } |
| 155 | + |
| 156 | + $allTraits = []; |
| 157 | + |
| 158 | + // Get direct traits used by this trait. |
| 159 | + foreach ($traitReflection->getTraits() as $trait) { |
| 160 | + $usedTraitName = $trait->getName(); |
| 161 | + $allTraits[] = $usedTraitName; |
| 162 | + |
| 163 | + // Recursively get traits used by the used trait. |
| 164 | + $nestedTraits = $this->getAllTraitsUsedByTrait($usedTraitName, $visited); |
| 165 | + $allTraits = array_merge($allTraits, $nestedTraits); |
| 166 | + } |
| 167 | + |
| 168 | + return array_unique($allTraits); |
| 169 | + } |
| 170 | + catch (\Throwable $e) { |
| 171 | + return []; |
| 172 | + } |
| 173 | + } |
| 174 | + |
| 175 | +} |
0 commit comments