mirror of https://github.com/rectorphp/rector.git
80 lines
2.4 KiB
PHP
80 lines
2.4 KiB
PHP
<?php
|
|
|
|
declare (strict_types=1);
|
|
namespace Rector\Php73\Rector\String_;
|
|
|
|
use PhpParser\Node;
|
|
use PhpParser\Node\Scalar\String_;
|
|
use Rector\NodeTypeResolver\Node\AttributeKey;
|
|
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/flexible_heredoc_nowdoc_syntaxes
|
|
* @see \Rector\Tests\Php73\Rector\String_\SensitiveHereNowDocRector\SensitiveHereNowDocRectorTest
|
|
*/
|
|
final class SensitiveHereNowDocRector extends AbstractRector implements MinPhpVersionInterface
|
|
{
|
|
/**
|
|
* @var string
|
|
*/
|
|
private const WRAP_SUFFIX = '_WRAP';
|
|
public function provideMinPhpVersion() : int
|
|
{
|
|
return PhpVersionFeature::SENSITIVE_HERE_NOW_DOC;
|
|
}
|
|
public function getRuleDefinition() : RuleDefinition
|
|
{
|
|
return new RuleDefinition('Changes heredoc/nowdoc that contains closing word to safe wrapper name', [new CodeSample(<<<'CODE_SAMPLE'
|
|
$value = <<<A
|
|
A
|
|
A
|
|
CODE_SAMPLE
|
|
, <<<'CODE_SAMPLE'
|
|
$value = <<<A_WRAP
|
|
A
|
|
A_WRAP
|
|
CODE_SAMPLE
|
|
)]);
|
|
}
|
|
/**
|
|
* @return array<class-string<Node>>
|
|
*/
|
|
public function getNodeTypes() : array
|
|
{
|
|
return [String_::class];
|
|
}
|
|
/**
|
|
* @param String_ $node
|
|
*/
|
|
public function refactor(Node $node) : ?Node
|
|
{
|
|
$kind = $node->getAttribute(AttributeKey::KIND);
|
|
if (!\in_array($kind, [String_::KIND_HEREDOC, String_::KIND_NOWDOC], \true)) {
|
|
return null;
|
|
}
|
|
// the doc label is not in the string → ok
|
|
/** @var string $docLabel */
|
|
$docLabel = $node->getAttribute(AttributeKey::DOC_LABEL);
|
|
if (\strpos($node->value, $docLabel) === \false) {
|
|
return null;
|
|
}
|
|
$node->setAttribute(AttributeKey::DOC_LABEL, $this->uniquateDocLabel($node->value, $docLabel));
|
|
// invoke redraw
|
|
$node->setAttribute(AttributeKey::ORIGINAL_NODE, null);
|
|
return $node;
|
|
}
|
|
private function uniquateDocLabel(string $value, string $docLabel) : string
|
|
{
|
|
$docLabel .= self::WRAP_SUFFIX;
|
|
$docLabelCounterTemplate = $docLabel . '_%d';
|
|
$i = 0;
|
|
while (\strpos($value, $docLabel) !== \false) {
|
|
$docLabel = \sprintf($docLabelCounterTemplate, ++$i);
|
|
}
|
|
return $docLabel;
|
|
}
|
|
}
|