reflectionProvider = $reflectionProvider; } public function getRuleDefinition() : RuleDefinition { return new RuleDefinition('Replace string class names by ::class constant', [new ConfiguredCodeSample(<<<'CODE_SAMPLE' class AnotherClass { } class SomeClass { public function run() { return 'AnotherClass'; } } CODE_SAMPLE , <<<'CODE_SAMPLE' class AnotherClass { } class SomeClass { public function run() { return \AnotherClass::class; } } CODE_SAMPLE , ['ClassName', 'AnotherClassName', self::SHOULD_KEEP_PRE_SLASH => \false])]); } /** * @return array> */ public function getNodeTypes() : array { return [String_::class, FuncCall::class, ClassConst::class]; } /** * @param String_|FuncCall|ClassConst $node * @return \PhpParser\Node\Expr\BinaryOp\Concat|\PhpParser\Node\Expr\ClassConstFetch|null|int */ public function refactor(Node $node) { // allow class strings to be part of class const arrays, as probably on purpose if ($node instanceof ClassConst) { $this->decorateClassConst($node); return null; } // keep allowed string as condition if ($node instanceof FuncCall) { if ($this->isName($node, 'is_a')) { return NodeTraverser::DONT_TRAVERSE_CHILDREN; } return null; } if ($node->getAttribute(self::IS_UNDER_CLASS_CONST) === \true) { return null; } $classLikeName = $node->value; // remove leading slash $classLikeName = \ltrim($classLikeName, '\\'); if ($classLikeName === '') { return null; } if ($this->shouldSkip($classLikeName)) { return null; } $fullyQualified = new FullyQualified($classLikeName); if ($this->shouldKeepPreslash && $classLikeName !== $node->value) { $preSlashCount = \strlen($node->value) - \strlen($classLikeName); $preSlash = \str_repeat('\\', $preSlashCount); $string = new String_($preSlash); return new Concat($string, new ClassConstFetch($fullyQualified, 'class')); } return new ClassConstFetch($fullyQualified, 'class'); } /** * @param mixed[] $configuration */ public function configure(array $configuration) : void { if (isset($configuration[self::SHOULD_KEEP_PRE_SLASH]) && \is_bool($configuration[self::SHOULD_KEEP_PRE_SLASH])) { $this->shouldKeepPreslash = $configuration[self::SHOULD_KEEP_PRE_SLASH]; unset($configuration[self::SHOULD_KEEP_PRE_SLASH]); } Assert::allString($configuration); $this->classesToSkip = $configuration; } public function provideMinPhpVersion() : int { return PhpVersionFeature::CLASSNAME_CONSTANT; } private function shouldSkip(string $classLikeName) : bool { // skip short class names, mostly invalid use of strings if (\strpos($classLikeName, '\\') === \false) { return \true; } // possibly string if (\ctype_lower($classLikeName[0])) { return \true; } if (!$this->reflectionProvider->hasClass($classLikeName)) { return \true; } foreach ($this->classesToSkip as $classToSkip) { if (\strpos($classToSkip, '*') !== \false) { if (\fnmatch($classToSkip, $classLikeName, \FNM_NOESCAPE)) { return \true; } continue; } if ($this->nodeNameResolver->isStringName($classLikeName, $classToSkip)) { return \true; } } return \false; } private function decorateClassConst(ClassConst $classConst) : void { $this->traverseNodesWithCallable($classConst->consts, static function (Node $subNode) { if ($subNode instanceof String_) { $subNode->setAttribute(self::IS_UNDER_CLASS_CONST, \true); } return null; }); } }