feature: add handling for void magic methods

Author: parijke

rules-tests/DeadCode/Rector/ClassMethod/RemoveUselessReturnTagRector/Fixture/remove_return_clone.php.inc

@@ -0,0 +1,30 @@
+<?php
+
+namespace Rector\Tests\DeadCode\Rector\ClassMethod\RemoveUselessReturnTagRector\Fixture;
+
+class RemoveReturnClone
+{
+    /**
+     * @return void
+     */
+    function __clone()
+    {
+        //
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\DeadCode\Rector\ClassMethod\RemoveUselessReturnTagRector\Fixture;
+
+class RemoveReturnClone
+{
+    function __clone()
+    {
+        //
+    }
+}
+
+?>

rules-tests/DeadCode/Rector/ClassMethod/RemoveUselessReturnTagRector/Fixture/remove_return_construct.php.inc

@@ -0,0 +1,30 @@
+<?php
+
+namespace Rector\Tests\DeadCode\Rector\ClassMethod\RemoveUselessReturnTagRector\Fixture;
+
+class RemoveReturnConstruct
+{
+    /**
+     * @return void
+     */
+    function __construct()
+    {
+        //
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\DeadCode\Rector\ClassMethod\RemoveUselessReturnTagRector\Fixture;
+
+class RemoveReturnConstruct
+{
+    function __construct()
+    {
+        //
+    }
+}
+
+?>

rules-tests/DeadCode/Rector/ClassMethod/RemoveUselessReturnTagRector/Fixture/remove_return_destruct.php.inc

@@ -0,0 +1,30 @@
+<?php
+
+namespace Rector\Tests\DeadCode\Rector\ClassMethod\RemoveUselessReturnTagRector\Fixture;
+
+class RemoveReturnDestruct
+{
+    /**
+     * @return void
+     */
+    function __destruct()
+    {
+        //
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\DeadCode\Rector\ClassMethod\RemoveUselessReturnTagRector\Fixture;
+
+class RemoveReturnDestruct
+{
+    function __destruct()
+    {
+        //
+    }
+}
+
+?>

rules/DeadCode/PhpDoc/DeadReturnTagValueNodeAnalyzer.php

@@ -42,6 +42,10 @@ public function isDead(ReturnTagValueNode $returnTagValueNode, ClassMethod|Funct
     {
         $returnType = $functionLike->getReturnType();
 
+        if ($this->isVoidMagicMethod($functionLike)) {
+            return true;
+        }
+
         if ($returnType === null) {
             return false;
         }
@@ -94,6 +98,17 @@ public function isDead(ReturnTagValueNode $returnTagValueNode, ClassMethod|Funct
         return ! $this->hasTrueFalsePseudoType($returnTagValueNode->type);
     }
 
+    public function isVoidMagicMethod(ClassMethod|Function_ $functionLike): bool
+    {
+        $voidMagicMethods = ['__construct', '__destruct', '__clone'];
+
+        return $functionLike instanceof ClassMethod && in_array(
+            $functionLike->name->toString(),
+            $voidMagicMethods,
+            true
+        );
+    }
+
     private function isVoidReturnType(Node $node): bool
     {
         return $node instanceof Identifier && $node->toString() === 'void';