[PHPStan] Use NodeVisitor::* on RectorInterface::refactor() @return method and update rules to use specific of its constant (#7409)

* [PHPStan] Use NodeVisitor::* on RectorInterface::refactor() @return method and update rules to use specific of its constant

* [PHPStan] Use NodeVisitor::* on RectorInterface::refactor() @return method and update rules to use specific of its constant

Author: samsonasik

rules/CodeQuality/Rector/FuncCall/SetTypeToCastRector.php

@@ -95,6 +95,7 @@ public function getNodeTypes(): array
 
     /**
      * @param FuncCall|Expression|Assign|ArrayItem|Node\Arg $node
+     * @return null|NodeVisitor::DONT_TRAVERSE_CHILDREN|Expression|Assign|Cast
      */
     public function refactor(Node $node): null|int|Expression|Assign|Cast
     {

rules/Php55/Rector/String_/StringClassNameToClassConstantRector.php

@@ -99,6 +99,7 @@ public function getNodeTypes(): array
 
     /**
      * @param String_|FuncCall|ClassConst $node
+     * @return Concat|ClassConstFetch|null|NodeVisitor::DONT_TRAVERSE_CHILDREN
      */
     public function refactor(Node $node): Concat|ClassConstFetch|null|int
     {

rules/Php70/Rector/Break_/BreakNotInLoopOrSwitchToReturnRector.php

@@ -87,6 +87,7 @@ public function getNodeTypes(): array
 
     /**
      * @param Switch_|Break_ $node
+     * @return Return_|null|NodeVisitor::REMOVE_NODE
      */
     public function refactor(Node $node): Return_|null|int
     {

rules/Php72/Rector/Unset_/UnsetCastRector.php

@@ -55,6 +55,7 @@ public function getNodeTypes(): array
 
     /**
      * @param Unset_|Assign|Expression $node
+     * @return NodeVisitor::REMOVE_NODE|Node|null
      */
     public function refactor(Node $node): int|null|Node
     {

rules/Php81/Rector/Array_/FirstClassCallableRector.php

@@ -88,6 +88,7 @@ public function getNodeTypes(): array
 
     /**
      * @param Property|ClassConst|Array_ $node
+     * @return StaticCall|MethodCall|null|NodeVisitor::DONT_TRAVERSE_CURRENT_AND_CHILDREN
      */
     public function refactor(Node $node): int|null|StaticCall|MethodCall
     {

rules/Renaming/Rector/Name/RenameClassRector.php

@@ -95,6 +95,7 @@ public function getNodeTypes(): array
 
     /**
      * @param ClassConstFetch|FunctionLike|FullyQualified|Name|ClassLike|Expression|Property|If_ $node
+     * @return null|NodeVisitor::DONT_TRAVERSE_CHILDREN|Node
      */
     public function refactor(Node $node): int|null|Node
     {
@@ -125,6 +126,7 @@ public function configure(array $configuration): void
 
     /**
      * @param array<string, string> $oldToNewClasses
+     * @return null|NodeVisitor::DONT_TRAVERSE_CHILDREN
      */
     private function processClassConstFetch(ClassConstFetch $classConstFetch, array $oldToNewClasses): int|null
     {

rules/Transform/Rector/FuncCall/WrapFuncCallWithPhpVersionIdCheckerRector.php

@@ -68,6 +68,7 @@ public function getNodeTypes(): array
 
     /**
      * @param StmtsAwareInterface $node
+     * @return null|Node|NodeVisitor::DONT_TRAVERSE_CHILDREN
      */
     public function refactor(Node $node): null|Node|int
     {

src/Contract/Rector/RectorInterface.php

@@ -20,16 +20,7 @@ public function getNodeTypes(): array;
 
     /**
      * Process Node of matched type
-     * @return Node|Node[]|null|int
-     *
-     * For int return, choose:
-     *
-     *   ✔️ To decorate current node and its children to not be traversed on current rule, return one of:
-     *          - NodeVisitor::DONT_TRAVERSE_CHILDREN
-     *          - NodeVisitor::DONT_TRAVERSE_CURRENT_AND_CHILDREN
-     *
-     *   ✔️ To remove node of Node\Stmt or Node\Param, return:
-     *          - NodeVisitor::REMOVE_NODE
+     * @return Node|Node[]|null|NodeVisitor::*
      */
     public function refactor(Node $node);
 }

src/Rector/AbstractRector.php

@@ -188,7 +188,7 @@ final public function enterNode(Node $node): int|Node|null
         }
 
         if ($isIntRefactoredNode) {
-            // @see NodeTraverser::* codes, e.g. removal of node of stopping the traversing
+            // @see NodeVisitor::* codes, e.g. removal of node of stopping the traversing
             if ($refactoredNode === NodeVisitor::REMOVE_NODE) {
                 // log here, so we can remove the node in leaveNode() method
                 $this->toBeRemovedNodeId = spl_object_id($originalNode);

tests/Issues/InfiniteLoop/Rector/MethodCall/InfinityLoopRector.php

@@ -26,6 +26,7 @@ public function getNodeTypes(): array
 
     /**
      * @param Assign|MethodCall $node
+     * @return Assign|int|null|NodeVisitor::DONT_TRAVERSE_CURRENT_AND_CHILDREN
      */
     public function refactor(Node $node): Assign|null|int
     {