reflectionProvider = $reflectionProvider; $this->classAnalyzer = $classAnalyzer; $this->phpAttributeAnalyzer = $phpAttributeAnalyzer; } public function getRuleDefinition() : RuleDefinition { return new RuleDefinition('Add override attribute to overridden methods', [new CodeSample(<<<'CODE_SAMPLE' class ParentClass { public function foo() { } } class ChildClass extends ParentClass { public function foo() { } } CODE_SAMPLE , <<<'CODE_SAMPLE' class ParentClass { public function foo() { } } class ChildClass extends ParentClass { #[\Override] public function foo() { } } CODE_SAMPLE )]); } /** * @return array> */ public function getNodeTypes() : array { return [Class_::class]; } /** * @param Class_ $node */ public function refactor(Node $node) : ?Node { $this->hasChanged = \false; if ($this->classAnalyzer->isAnonymousClass($node)) { return null; } $className = (string) $this->getName($node); if (!$this->reflectionProvider->hasClass($className)) { return null; } $classReflection = $this->reflectionProvider->getClass($className); $parentClassReflections = \array_merge($classReflection->getParents(), $classReflection->getInterfaces(), $classReflection->getTraits()); $this->processAddOverrideAttribute($node, $parentClassReflections); if (!$this->hasChanged) { return null; } return $node; } public function provideMinPhpVersion() : int { return PhpVersionFeature::OVERRIDE_ATTRIBUTE; } /** * @param ClassReflection[] $parentClassReflections */ private function processAddOverrideAttribute(Class_ $class, array $parentClassReflections) : void { if ($parentClassReflections === []) { return; } foreach ($class->getMethods() as $classMethod) { if ($classMethod->name->toString() === '__construct') { continue; } if ($classMethod->isPrivate()) { continue; } // ignore if it already uses the attribute if ($this->phpAttributeAnalyzer->hasPhpAttribute($classMethod, 'Override')) { continue; } // Private methods should be ignored foreach ($parentClassReflections as $parentClassReflection) { if (!$parentClassReflection->hasNativeMethod($classMethod->name->toString())) { continue; } // ignore if it is a private method on the parent $parentMethod = $parentClassReflection->getNativeMethod($classMethod->name->toString()); if ($parentMethod->isPrivate()) { continue; } if ($parentClassReflection->isTrait() && !$parentMethod->isAbstract()) { continue; } $classMethod->attrGroups[] = new AttributeGroup([new Attribute(new FullyQualified('Override'))]); $this->hasChanged = \true; continue 2; } } } }