rector/rules/Php73/Rector/FuncCall/StringifyStrNeedlesRector.php

76 lines
2.3 KiB
PHP

<?php
declare (strict_types=1);
namespace Rector\Php73\Rector\FuncCall;
use PhpParser\Node;
use PhpParser\Node\Arg;
use PhpParser\Node\Expr\Cast\String_;
use PhpParser\Node\Expr\FuncCall;
use PhpParser\Node\Scalar\Encapsed;
use Rector\Rector\AbstractRector;
use Rector\ValueObject\PhpVersionFeature;
use Rector\VersionBonding\Contract\MinPhpVersionInterface;
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
/**
* @changelog https://wiki.php.net/rfc/deprecations_php_7_3#string_search_functions_with_integer_needle
* @see \Rector\Tests\Php73\Rector\FuncCall\StringifyStrNeedlesRector\StringifyStrNeedlesRectorTest
*/
final class StringifyStrNeedlesRector extends AbstractRector implements MinPhpVersionInterface
{
/**
* @var string[]
*/
private const NEEDLE_STRING_SENSITIVE_FUNCTIONS = ['strpos', 'strrpos', 'stripos', 'strstr', 'stripos', 'strripos', 'strstr', 'strchr', 'strrchr', 'stristr'];
public function provideMinPhpVersion() : int
{
return PhpVersionFeature::DEPRECATE_INT_IN_STR_NEEDLES;
}
public function getRuleDefinition() : RuleDefinition
{
return new RuleDefinition('Makes needles explicit strings', [new CodeSample(<<<'CODE_SAMPLE'
$needle = 5;
$fivePosition = strpos('725', $needle);
CODE_SAMPLE
, <<<'CODE_SAMPLE'
$needle = 5;
$fivePosition = strpos('725', (string) $needle);
CODE_SAMPLE
)]);
}
/**
* @return array<class-string<Node>>
*/
public function getNodeTypes() : array
{
return [FuncCall::class];
}
/**
* @param FuncCall $node
*/
public function refactor(Node $node) : ?Node
{
if (!$this->isNames($node, self::NEEDLE_STRING_SENSITIVE_FUNCTIONS)) {
return null;
}
if (!isset($node->args[1])) {
return null;
}
if (!$node->args[1] instanceof Arg) {
return null;
}
// is argument string?
$needleArgValue = $node->args[1]->value;
$needleType = $this->getType($needleArgValue);
if ($needleType->isString()->yes()) {
return null;
}
if ($needleArgValue instanceof Encapsed) {
return null;
}
$node->args[1]->value = new String_($node->args[1]->value);
return $node;
}
}