%PDF-
%PDF-
Mini Shell
Mini Shell
<?php
declare (strict_types=1);
namespace Rector\Php80\Rector\Class_;
use PhpParser\Node;
use PhpParser\Node\Expr;
use PhpParser\Node\Expr\Cast\String_ as CastString_;
use PhpParser\Node\Name;
use PhpParser\Node\Name\FullyQualified;
use PhpParser\Node\Scalar\String_;
use PhpParser\Node\Stmt\Class_;
use PhpParser\Node\Stmt\ClassMethod;
use PhpParser\Node\Stmt\Return_;
use PHPStan\Type\StringType;
use Rector\Core\NodeAnalyzer\ClassAnalyzer;
use Rector\Core\Rector\AbstractRector;
use Rector\Core\ValueObject\MethodName;
use Rector\Core\ValueObject\PhpVersionFeature;
use Rector\FamilyTree\Reflection\FamilyRelationsAnalyzer;
use Rector\TypeDeclaration\TypeInferer\ReturnTypeInferer;
use Rector\VersionBonding\Contract\MinPhpVersionInterface;
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
/**
* @changelog https://wiki.php.net/rfc/stringable
*
* @see \Rector\Tests\Php80\Rector\Class_\StringableForToStringRector\StringableForToStringRectorTest
*/
final class StringableForToStringRector extends AbstractRector implements MinPhpVersionInterface
{
/**
* @var string
*/
private const STRINGABLE = 'Stringable';
/**
* @readonly
* @var \Rector\FamilyTree\Reflection\FamilyRelationsAnalyzer
*/
private $familyRelationsAnalyzer;
/**
* @readonly
* @var \Rector\TypeDeclaration\TypeInferer\ReturnTypeInferer
*/
private $returnTypeInferer;
/**
* @readonly
* @var \Rector\Core\NodeAnalyzer\ClassAnalyzer
*/
private $classAnalyzer;
public function __construct(FamilyRelationsAnalyzer $familyRelationsAnalyzer, ReturnTypeInferer $returnTypeInferer, ClassAnalyzer $classAnalyzer)
{
$this->familyRelationsAnalyzer = $familyRelationsAnalyzer;
$this->returnTypeInferer = $returnTypeInferer;
$this->classAnalyzer = $classAnalyzer;
}
public function provideMinPhpVersion() : int
{
return PhpVersionFeature::STRINGABLE;
}
public function getRuleDefinition() : RuleDefinition
{
return new RuleDefinition('Add `Stringable` interface to classes with `__toString()` method', [new CodeSample(<<<'CODE_SAMPLE'
class SomeClass
{
public function __toString()
{
return 'I can stringz';
}
}
CODE_SAMPLE
, <<<'CODE_SAMPLE'
class SomeClass implements Stringable
{
public function __toString(): string
{
return 'I can stringz';
}
}
CODE_SAMPLE
)]);
}
/**
* @return array<class-string<Node>>
*/
public function getNodeTypes() : array
{
return [Class_::class];
}
/**
* @param Class_ $node
*/
public function refactor(Node $node) : ?Node
{
$toStringClassMethod = $node->getMethod(MethodName::TO_STRING);
if (!$toStringClassMethod instanceof ClassMethod) {
return null;
}
// warning, classes that implements __toString() will return Stringable interface even if they don't implemen it
// reflection cannot be used for real detection
$classLikeAncestorNames = $this->familyRelationsAnalyzer->getClassLikeAncestorNames($node);
if (\in_array(self::STRINGABLE, $classLikeAncestorNames, \true)) {
return null;
}
if ($this->classAnalyzer->isAnonymousClass($node)) {
return null;
}
$returnType = $this->returnTypeInferer->inferFunctionLike($toStringClassMethod);
if (!$returnType instanceof StringType) {
$this->processNotStringType($toStringClassMethod);
}
// add interface
$node->implements[] = new FullyQualified(self::STRINGABLE);
// add return type
if ($toStringClassMethod->returnType === null) {
$toStringClassMethod->returnType = new Name('string');
}
return $node;
}
private function processNotStringType(ClassMethod $toStringClassMethod) : void
{
if ($toStringClassMethod->isAbstract()) {
return;
}
$hasReturn = $this->betterNodeFinder->hasInstancesOfInFunctionLikeScoped($toStringClassMethod, Return_::class);
if (!$hasReturn) {
$stmts = (array) $toStringClassMethod->stmts;
\end($stmts);
$lastKey = \key($stmts);
$lastKey = $lastKey === null ? 0 : (int) $lastKey + 1;
$toStringClassMethod->stmts[$lastKey] = new Return_(new String_(''));
return;
}
$this->traverseNodesWithCallable((array) $toStringClassMethod->stmts, function (Node $subNode) {
if (!$subNode instanceof Return_) {
return null;
}
if (!$subNode->expr instanceof Expr) {
$subNode->expr = new String_('');
return null;
}
$type = $this->nodeTypeResolver->getType($subNode->expr);
if ($type instanceof StringType) {
return null;
}
$subNode->expr = new CastString_($subNode->expr);
return null;
});
}
}
Zerion Mini Shell 1.0