*/ private const PREVIOUS_TO_NEW_FUNCTIONS = ['reset' => self::ARRAY_KEY_FIRST, 'end' => self::ARRAY_KEY_LAST]; public function __construct(ReflectionProvider $reflectionProvider, BetterNodeFinder $betterNodeFinder) { $this->reflectionProvider = $reflectionProvider; $this->betterNodeFinder = $betterNodeFinder; } public function getRuleDefinition() : RuleDefinition { return new RuleDefinition('Make use of array_key_first() and array_key_last()', [new CodeSample(<<<'CODE_SAMPLE' reset($items); $firstKey = key($items); CODE_SAMPLE , <<<'CODE_SAMPLE' $firstKey = array_key_first($items); CODE_SAMPLE ), new CodeSample(<<<'CODE_SAMPLE' end($items); $lastKey = key($items); CODE_SAMPLE , <<<'CODE_SAMPLE' $lastKey = array_key_last($items); CODE_SAMPLE )]); } /** * @return array> */ public function getNodeTypes() : array { return [StmtsAwareInterface::class]; } /** * @param StmtsAwareInterface $node */ public function refactor(Node $node) : ?StmtsAwareInterface { return $this->processArrayKeyFirstLast($node, \false); } public function provideMinPhpVersion() : int { return PhpVersionFeature::ARRAY_KEY_FIRST_LAST; } public function providePolyfillPackage() : string { return PolyfillPackage::PHP_73; } private function processArrayKeyFirstLast(StmtsAwareInterface $stmtsAware, bool $hasChanged, int $jumpToKey = 0) : ?StmtsAwareInterface { if ($stmtsAware->stmts === null) { return null; } /** @var int $totalKeys */ \end($stmtsAware->stmts); /** @var int $totalKeys */ $totalKeys = \key($stmtsAware->stmts); \reset($stmtsAware->stmts); for ($key = $jumpToKey; $key < $totalKeys; ++$key) { if (!isset($stmtsAware->stmts[$key], $stmtsAware->stmts[$key + 1])) { break; } if (!$stmtsAware->stmts[$key] instanceof Expression) { continue; } /** @var Expression $stmt */ $stmt = $stmtsAware->stmts[$key]; if ($this->shouldSkip($stmt)) { continue; } $nextStmt = $stmtsAware->stmts[$key + 1]; /** @var FuncCall $resetOrEndFuncCall */ $resetOrEndFuncCall = $stmt->expr; $keyFuncCall = $this->resolveKeyFuncCall($nextStmt, $resetOrEndFuncCall); if (!$keyFuncCall instanceof FuncCall) { continue; } if ($this->hasInternalPointerChangeNext($stmtsAware, $key + 1, $totalKeys, $keyFuncCall)) { continue; } $newName = self::PREVIOUS_TO_NEW_FUNCTIONS[$this->getName($stmt->expr)]; $keyFuncCall->name = new Name($newName); unset($stmtsAware->stmts[$key]); $hasChanged = \true; return $this->processArrayKeyFirstLast($stmtsAware, $hasChanged, $key + 2); } if ($hasChanged) { return $stmtsAware; } return null; } private function resolveKeyFuncCall(Stmt $nextStmt, FuncCall $resetOrEndFuncCall) : ?FuncCall { if ($resetOrEndFuncCall->isFirstClassCallable()) { return null; } /** @var FuncCall|null */ return $this->betterNodeFinder->findFirst($nextStmt, function (Node $subNode) use($resetOrEndFuncCall) : bool { if (!$subNode instanceof FuncCall) { return \false; } if (!$this->isName($subNode, 'key')) { return \false; } if ($subNode->isFirstClassCallable()) { return \false; } return $this->nodeComparator->areNodesEqual($resetOrEndFuncCall->getArgs()[0], $subNode->getArgs()[0]); }); } private function hasInternalPointerChangeNext(StmtsAwareInterface $stmtsAware, int $nextKey, int $totalKeys, FuncCall $funcCall) : bool { for ($key = $nextKey; $key <= $totalKeys; ++$key) { if (!isset($stmtsAware->stmts[$key])) { continue; } $hasPrevCallNext = (bool) $this->betterNodeFinder->findFirst($stmtsAware->stmts[$key], function (Node $subNode) use($funcCall) : bool { if (!$subNode instanceof FuncCall) { return \false; } if (!$this->isNames($subNode, ['prev', 'next'])) { return \false; } if ($subNode->isFirstClassCallable()) { return \true; } return $this->nodeComparator->areNodesEqual($subNode->getArgs()[0]->value, $funcCall->getArgs()[0]->value); }); if ($hasPrevCallNext) { return \true; } } return \false; } private function shouldSkip(Expression $expression) : bool { if (!$expression->expr instanceof FuncCall) { return \true; } if (!$this->isNames($expression->expr, ['reset', 'end'])) { return \true; } if (!$this->reflectionProvider->hasFunction(new Name(self::ARRAY_KEY_FIRST), null)) { return \true; } return !$this->reflectionProvider->hasFunction(new Name(self::ARRAY_KEY_LAST), null); } }