terminatedNodeAnalyzer = $terminatedNodeAnalyzer; $this->valueResolver = $valueResolver; } public function getRuleDefinition() : RuleDefinition { return new RuleDefinition('Returns int from Command::execute() command', [new CodeSample(<<<'CODE_SAMPLE' use Symfony\Component\Console\Command\Command; class SomeCommand extends Command { public function execute(InputInterface $input, OutputInterface $output) { return null; } } CODE_SAMPLE , <<<'CODE_SAMPLE' use Symfony\Component\Console\Command\Command; class SomeCommand extends Command { public function execute(InputInterface $input, OutputInterface $output): int { return 0; } } CODE_SAMPLE )]); } /** * @return array> */ public function getNodeTypes() : array { return [Class_::class]; } /** * @param Class_ $node */ public function refactor(Node $node) : ?Node { if (!$this->isObjectType($node, new ObjectType('Symfony\\Component\\Console\\Command\\Command'))) { return null; } $executeClassMethod = $node->getMethod('execute'); if (!$executeClassMethod instanceof ClassMethod) { return null; } $this->refactorReturnTypeDeclaration($executeClassMethod); $this->addReturn0ToExecuteClassMethod($executeClassMethod); if ($this->hasChanged) { return $node; } return null; } private function refactorReturnTypeDeclaration(ClassMethod $classMethod) : void { // already set if ($classMethod->returnType !== null && $this->isName($classMethod->returnType, 'int')) { return; } $classMethod->returnType = new Identifier('int'); $this->hasChanged = \true; } private function addReturn0ToExecuteClassMethod(ClassMethod $classMethod) : void { if ($classMethod->stmts === null) { return; } $this->traverseNodesWithCallable($classMethod->stmts, function (Node $node) : ?int { // skip anonymous class/function if ($node instanceof FunctionLike || $node instanceof Class_) { return NodeTraverser::DONT_TRAVERSE_CURRENT_AND_CHILDREN; } if (!$node instanceof Return_) { return null; } if ($this->isReturnIntegerType($node->expr)) { return null; } if ($node->expr instanceof Ternary && $this->isIntegerTernaryIfElse($node->expr)) { return null; } $this->setReturnTo0InsteadOfNull($node); return null; }); $this->processReturn0ToMethod($classMethod); } private function isReturnIntegerType(?Expr $expr) : bool { if ($expr instanceof Expr) { $returnedType = $this->getType($expr); if ($returnedType instanceof IntegerType) { return \true; } } return \false; } private function isIntegerTernaryIfElse(Ternary $ternary) : bool { /** @var Expr|null $if */ $if = $ternary->if; if (!$if instanceof Expr) { $if = $ternary->cond; } /** @var Expr $else */ $else = $ternary->else; $ifType = $this->getType($if); $elseType = $this->getType($else); return $ifType instanceof IntegerType && $elseType instanceof IntegerType; } private function processReturn0ToMethod(ClassMethod $classMethod) : void { $stmts = (array) $classMethod->stmts; \end($stmts); $lastKey = \key($stmts); \reset($stmts); $return = new Return_(new LNumber(0)); if ($lastKey !== null && (isset($classMethod->stmts[$lastKey]) && $this->terminatedNodeAnalyzer->isAlwaysTerminated($classMethod, $classMethod->stmts[$lastKey], $return))) { return; } $classMethod->stmts[] = $return; } private function setReturnTo0InsteadOfNull(Return_ $return) : void { if (!$return->expr instanceof Expr) { $return->expr = new LNumber(0); return; } if ($this->valueResolver->isNull($return->expr)) { $return->expr = new LNumber(0); return; } if ($return->expr instanceof Coalesce && $this->valueResolver->isNull($return->expr->right)) { $return->expr->right = new LNumber(0); return; } if ($return->expr instanceof Ternary) { $hasChanged = $this->isSuccessfulRefactorTernaryReturn($return->expr); if ($hasChanged) { return; } } $staticType = $this->getType($return->expr); if (!$staticType instanceof IntegerType) { $return->expr = new Int_($return->expr); } } private function isSuccessfulRefactorTernaryReturn(Ternary $ternary) : bool { $hasChanged = \false; if ($ternary->if instanceof Expr && $this->valueResolver->isNull($ternary->if)) { $ternary->if = new LNumber(0); $hasChanged = \true; } if ($this->valueResolver->isNull($ternary->else)) { $ternary->else = new LNumber(0); $hasChanged = \true; } return $hasChanged; } }