docBlockUpdater = $docBlockUpdater;
$this->phpDocInfoFactory = $phpDocInfoFactory;
}
public function getRuleDefinition() : RuleDefinition
{
return new RuleDefinition('Remove @var/@param/@return null docblock', [new CodeSample(<<<'CODE_SAMPLE'
class SomeClass
{
/**
* @return null
*/
public function foo()
{
return null;
}
}
CODE_SAMPLE
, <<<'CODE_SAMPLE'
class SomeClass
{
public function foo()
{
return null;
}
}
CODE_SAMPLE
)]);
}
/**
* @return array>
*/
public function getNodeTypes() : array
{
return [ClassMethod::class, Function_::class, Expression::class, Property::class];
}
/**
* @param ClassMethod|Function_|Expression|Property $node
*/
public function refactor(Node $node) : ?Node
{
if ($node instanceof Expression || $node instanceof Property) {
return $this->processVarTagNull($node);
}
$phpdocInfo = $this->phpDocInfoFactory->createFromNodeOrEmpty($node);
$removedParamNames = [];
foreach ($node->params as $param) {
$paramName = $this->getName($param);
$paramTagValueNode = $phpdocInfo->getParamTagValueByName($paramName);
if ($paramTagValueNode instanceof ParamTagValueNode && $this->isNull($paramTagValueNode)) {
$removedParamNames[] = $paramTagValueNode->parameterName;
}
}
$hasRemoved = \false;
if ($removedParamNames !== []) {
$this->removeParamNullTag($phpdocInfo, $removedParamNames);
$this->docBlockUpdater->updateRefactoredNodeWithPhpDocInfo($node);
$hasRemoved = \true;
}
$returnTagValueNode = $phpdocInfo->getReturnTagValue();
if ($returnTagValueNode instanceof ReturnTagValueNode && $this->isNull($returnTagValueNode)) {
$phpdocInfo->removeByType(ReturnTagValueNode::class);
$this->docBlockUpdater->updateRefactoredNodeWithPhpDocInfo($node);
$hasRemoved = \true;
}
if (!$hasRemoved) {
return null;
}
return $node;
}
/**
* @param \PHPStan\PhpDocParser\Ast\PhpDoc\VarTagValueNode|\PHPStan\PhpDocParser\Ast\PhpDoc\ParamTagValueNode|\PHPStan\PhpDocParser\Ast\PhpDoc\ReturnTagValueNode $tag
*/
private function isNull($tag) : bool
{
return $tag->type instanceof IdentifierTypeNode && $tag->type->__toString() === 'null' && $tag->description === '';
}
/**
* @param string[] $paramNames
*/
private function removeParamNullTag(PhpDocInfo $phpDocInfo, array $paramNames) : void
{
$phpDocNodeTraverser = new PhpDocNodeTraverser();
$phpDocNodeTraverser->traverseWithCallable($phpDocInfo->getPhpDocNode(), '', static function (AstNode $astNode) use($paramNames) : ?int {
if (!$astNode instanceof PhpDocTagNode) {
return null;
}
if (!$astNode->value instanceof ParamTagValueNode) {
return null;
}
if (\in_array($astNode->value->parameterName, $paramNames, \true)) {
return PhpDocNodeTraverser::NODE_REMOVE;
}
return null;
});
}
/**
* @param \PhpParser\Node\Stmt\Expression|\PhpParser\Node\Stmt\Property $node
*/
private function processVarTagNull($node) : ?Node
{
$phpdocInfo = $this->phpDocInfoFactory->createFromNodeOrEmpty($node);
$varTagValueNode = $phpdocInfo->getVarTagValueNode();
if ($varTagValueNode instanceof VarTagValueNode && $this->isNull($varTagValueNode)) {
$phpdocInfo->removeByType(VarTagValueNode::class);
$this->docBlockUpdater->updateRefactoredNodeWithPhpDocInfo($node);
return $node;
}
return null;
}
}