isClassMethodUsedAnalyzer = $isClassMethodUsedAnalyzer; $this->reflectionResolver = $reflectionResolver; $this->betterNodeFinder = $betterNodeFinder; } public function getRuleDefinition() : RuleDefinition { return new RuleDefinition('Remove unused private method', [new CodeSample(<<<'CODE_SAMPLE' final class SomeController { public function run() { return 5; } private function skip() { return 10; } } CODE_SAMPLE , <<<'CODE_SAMPLE' final class SomeController { public function run() { return 5; } } CODE_SAMPLE )]); } /** * @return array> */ public function getNodeTypes() : array { return [Class_::class]; } /** * @param Class_ $node */ public function refactorWithScope(Node $node, Scope $scope) : ?Node { $classMethods = $node->getMethods(); if ($classMethods === []) { return null; } $filter = static function (ClassMethod $classMethod) : bool { return $classMethod->isPrivate(); }; $privateMethods = \array_filter($classMethods, $filter); if ($privateMethods === []) { return null; } if ($this->hasDynamicMethodCallOnFetchThis($classMethods)) { return null; } $hasChanged = \false; $classReflection = $this->reflectionResolver->resolveClassReflection($node); foreach ($privateMethods as $privateMethod) { if ($this->shouldSkip($privateMethod, $classReflection)) { continue; } if ($this->isClassMethodUsedAnalyzer->isClassMethodUsed($node, $privateMethod, $scope)) { continue; } unset($node->stmts[$privateMethod->getAttribute(AttributeKey::STMT_KEY)]); $hasChanged = \true; } if ($hasChanged) { return $node; } return null; } private function shouldSkip(ClassMethod $classMethod, ?ClassReflection $classReflection) : bool { if (!$classReflection instanceof ClassReflection) { return \true; } // unreliable to detect trait, interface, anonymous class: doesn't make sense if ($classReflection->isTrait()) { return \true; } if ($classReflection->isInterface()) { return \true; } if ($classReflection->isAnonymous()) { return \true; } // skip magic methods - @see https://www.php.net/manual/en/language.oop5.magic.php if ($classMethod->isMagic()) { return \true; } return $classReflection->hasMethod(MethodName::CALL); } /** * @param ClassMethod[] $classMethods */ private function hasDynamicMethodCallOnFetchThis(array $classMethods) : bool { foreach ($classMethods as $classMethod) { $isFound = (bool) $this->betterNodeFinder->findFirst((array) $classMethod->getStmts(), function (Node $subNode) : bool { if (!$subNode instanceof MethodCall) { return \false; } if (!$subNode->var instanceof Variable) { return \false; } if (!$this->nodeNameResolver->isName($subNode->var, 'this')) { return \false; } return $subNode->name instanceof Variable; }); if ($isFound) { return \true; } } return \false; } }