2020-11-13 13:58:17 +00:00
|
|
|
<?php
|
|
|
|
|
2021-05-09 20:15:43 +00:00
|
|
|
declare (strict_types=1);
|
2022-06-06 17:12:56 +00:00
|
|
|
namespace Rector\DeadCode\Rector\ClassMethod;
|
2020-11-13 13:58:17 +00:00
|
|
|
|
2022-06-06 17:12:56 +00:00
|
|
|
use PhpParser\Node;
|
|
|
|
use PhpParser\Node\Stmt\ClassMethod;
|
2023-12-05 09:55:15 +00:00
|
|
|
use PhpParser\Node\Stmt\Function_;
|
2023-09-20 12:41:26 +00:00
|
|
|
use Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfoFactory;
|
2023-09-11 13:16:45 +00:00
|
|
|
use Rector\Comments\NodeDocBlock\DocBlockUpdater;
|
2022-06-06 17:12:56 +00:00
|
|
|
use Rector\DeadCode\PhpDoc\TagRemover\ReturnTagRemover;
|
2024-01-02 02:40:38 +00:00
|
|
|
use Rector\Rector\AbstractRector;
|
2022-06-07 09:18:30 +00:00
|
|
|
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
|
|
|
|
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
|
2020-11-13 13:58:17 +00:00
|
|
|
/**
|
2021-03-21 18:41:17 +00:00
|
|
|
* @see \Rector\Tests\DeadCode\Rector\ClassMethod\RemoveUselessReturnTagRector\RemoveUselessReturnTagRectorTest
|
2020-11-13 13:58:17 +00:00
|
|
|
*/
|
2022-06-07 08:22:29 +00:00
|
|
|
final class RemoveUselessReturnTagRector extends AbstractRector
|
2020-11-13 13:58:17 +00:00
|
|
|
{
|
|
|
|
/**
|
2023-06-11 23:01:39 +00:00
|
|
|
* @readonly
|
2021-05-10 23:39:21 +00:00
|
|
|
* @var \Rector\DeadCode\PhpDoc\TagRemover\ReturnTagRemover
|
2020-11-13 13:58:17 +00:00
|
|
|
*/
|
2021-01-30 15:06:43 +00:00
|
|
|
private $returnTagRemover;
|
2023-09-11 13:16:45 +00:00
|
|
|
/**
|
|
|
|
* @readonly
|
|
|
|
* @var \Rector\Comments\NodeDocBlock\DocBlockUpdater
|
|
|
|
*/
|
|
|
|
private $docBlockUpdater;
|
2023-09-20 12:41:26 +00:00
|
|
|
/**
|
|
|
|
* @readonly
|
|
|
|
* @var \Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfoFactory
|
|
|
|
*/
|
|
|
|
private $phpDocInfoFactory;
|
|
|
|
public function __construct(ReturnTagRemover $returnTagRemover, DocBlockUpdater $docBlockUpdater, PhpDocInfoFactory $phpDocInfoFactory)
|
2021-01-30 15:06:43 +00:00
|
|
|
{
|
|
|
|
$this->returnTagRemover = $returnTagRemover;
|
2023-09-11 13:16:45 +00:00
|
|
|
$this->docBlockUpdater = $docBlockUpdater;
|
2023-09-20 12:41:26 +00:00
|
|
|
$this->phpDocInfoFactory = $phpDocInfoFactory;
|
2020-12-04 23:22:12 +00:00
|
|
|
}
|
2022-06-07 08:22:29 +00:00
|
|
|
public function getRuleDefinition() : RuleDefinition
|
2020-11-13 13:58:17 +00:00
|
|
|
{
|
2022-06-07 08:22:29 +00:00
|
|
|
return new RuleDefinition('Remove @return docblock with same type as defined in PHP', [new CodeSample(<<<'CODE_SAMPLE'
|
2020-11-13 13:58:17 +00:00
|
|
|
use stdClass;
|
|
|
|
|
|
|
|
class SomeClass
|
|
|
|
{
|
|
|
|
/**
|
|
|
|
* @return stdClass
|
|
|
|
*/
|
2020-12-05 00:31:05 +00:00
|
|
|
public function foo(): stdClass
|
2020-11-13 13:58:17 +00:00
|
|
|
{
|
|
|
|
}
|
|
|
|
}
|
|
|
|
CODE_SAMPLE
|
2021-05-09 20:15:43 +00:00
|
|
|
, <<<'CODE_SAMPLE'
|
2020-11-13 13:58:17 +00:00
|
|
|
use stdClass;
|
|
|
|
|
|
|
|
class SomeClass
|
|
|
|
{
|
2020-12-05 00:31:05 +00:00
|
|
|
public function foo(): stdClass
|
2020-11-13 13:58:17 +00:00
|
|
|
{
|
|
|
|
}
|
|
|
|
}
|
|
|
|
CODE_SAMPLE
|
2021-05-09 20:15:43 +00:00
|
|
|
)]);
|
2020-11-13 13:58:17 +00:00
|
|
|
}
|
|
|
|
/**
|
2021-02-27 00:06:15 +00:00
|
|
|
* @return array<class-string<Node>>
|
2020-11-13 13:58:17 +00:00
|
|
|
*/
|
2021-05-09 20:15:43 +00:00
|
|
|
public function getNodeTypes() : array
|
2020-11-13 13:58:17 +00:00
|
|
|
{
|
2023-12-05 09:55:15 +00:00
|
|
|
return [ClassMethod::class, Function_::class];
|
2020-11-13 13:58:17 +00:00
|
|
|
}
|
|
|
|
/**
|
2023-12-05 09:55:15 +00:00
|
|
|
* @param ClassMethod|Function_ $node
|
2020-11-13 13:58:17 +00:00
|
|
|
*/
|
2022-06-07 08:22:29 +00:00
|
|
|
public function refactor(Node $node) : ?Node
|
2020-11-13 13:58:17 +00:00
|
|
|
{
|
2021-01-18 21:45:13 +00:00
|
|
|
$phpDocInfo = $this->phpDocInfoFactory->createFromNodeOrEmpty($node);
|
2021-12-13 16:47:47 +00:00
|
|
|
$hasChanged = $this->returnTagRemover->removeReturnTagIfUseless($phpDocInfo, $node);
|
|
|
|
if (!$hasChanged) {
|
|
|
|
return null;
|
2020-11-13 13:58:17 +00:00
|
|
|
}
|
2023-09-11 13:16:45 +00:00
|
|
|
$this->docBlockUpdater->updateRefactoredNodeWithPhpDocInfo($node);
|
2021-12-13 16:47:47 +00:00
|
|
|
return $node;
|
2020-11-18 10:02:10 +00:00
|
|
|
}
|
2020-11-13 13:58:17 +00:00
|
|
|
}
|