%PDF-
%PDF-
Mini Shell
Mini Shell
<?php
declare (strict_types=1);
namespace Rector\Php73\Rector\String_;
use PhpParser\Node;
use PhpParser\Node\Scalar\String_;
use Rector\Core\Rector\AbstractRector;
use Rector\Core\ValueObject\PhpVersionFeature;
use Rector\NodeTypeResolver\Node\AttributeKey;
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';
/**
* @var string
*/
private const ATTRIBUTE_DOC_LABEL = 'docLabel';
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(self::ATTRIBUTE_DOC_LABEL);
if (\strpos($node->value, $docLabel) === \false) {
return null;
}
$node->setAttribute(self::ATTRIBUTE_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;
}
}
Zerion Mini Shell 1.0