mirror of
https://github.com/rectorphp/rector.git
synced 2024-05-28 23:10:51 +00:00
816016aac7
294bea2d18
[FileProcessor] Run untill the file is fixed completelly (#432)
137 lines
4.6 KiB
PHP
137 lines
4.6 KiB
PHP
<?php
|
|
|
|
declare (strict_types=1);
|
|
namespace Rector\DowngradePhp73\Rector\FuncCall;
|
|
|
|
use PhpParser\BuilderHelpers;
|
|
use PhpParser\Node;
|
|
use PhpParser\Node\Arg;
|
|
use PhpParser\Node\Expr\Array_;
|
|
use PhpParser\Node\Expr\ArrayItem;
|
|
use PhpParser\Node\Expr\FuncCall;
|
|
use PhpParser\Node\Scalar\String_;
|
|
use Rector\Core\Exception\ShouldNotHappenException;
|
|
use Rector\Core\Rector\AbstractRector;
|
|
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
|
|
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
|
|
/**
|
|
* @see \Rector\Tests\DowngradePhp73\Rector\FuncCall\SetCookieOptionsArrayToArgumentsRector\SetCookieOptionsArrayToArgumentsRectorTest
|
|
*/
|
|
final class SetCookieOptionsArrayToArgumentsRector extends \Rector\Core\Rector\AbstractRector
|
|
{
|
|
/**
|
|
* Conversion table from argument index to options name
|
|
* @var array<string, int>
|
|
*/
|
|
private const ARGUMENT_ORDER = ['expires' => 2, 'path' => 3, 'domain' => 4, 'secure' => 5, 'httponly' => 6];
|
|
/**
|
|
* Conversion table from argument index to options name
|
|
* @var array<int, int|string|bool>
|
|
*/
|
|
private const ARGUMENT_DEFAULT_VALUES = [2 => 0, 3 => '', 4 => '', 5 => \false, 6 => \false];
|
|
/**
|
|
* @var int
|
|
*/
|
|
private $highestIndex = 1;
|
|
public function getRuleDefinition() : \Symplify\RuleDocGenerator\ValueObject\RuleDefinition
|
|
{
|
|
return new \Symplify\RuleDocGenerator\ValueObject\RuleDefinition('Convert setcookie option array to arguments', [new \Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample(<<<'CODE_SAMPLE'
|
|
setcookie('name', $value, ['expires' => 360]);
|
|
CODE_SAMPLE
|
|
, <<<'CODE_SAMPLE'
|
|
setcookie('name', $value, 360);
|
|
CODE_SAMPLE
|
|
)]);
|
|
}
|
|
/**
|
|
* @return array<class-string<Node>>
|
|
*/
|
|
public function getNodeTypes() : array
|
|
{
|
|
return [\PhpParser\Node\Expr\FuncCall::class];
|
|
}
|
|
/**
|
|
* @param FuncCall $node
|
|
*/
|
|
public function refactor(\PhpParser\Node $node) : ?\PhpParser\Node
|
|
{
|
|
if ($this->shouldSkip($node)) {
|
|
return null;
|
|
}
|
|
$node->args = $this->composeNewArgs($node);
|
|
return $node;
|
|
}
|
|
private function shouldSkip(\PhpParser\Node\Expr\FuncCall $funcCall) : bool
|
|
{
|
|
if (!$this->isNames($funcCall, ['setcookie', 'setrawcookie'])) {
|
|
return \true;
|
|
}
|
|
$argsCount = \count($funcCall->args);
|
|
if ($argsCount <= 2) {
|
|
return \true;
|
|
}
|
|
if (!isset($funcCall->args[2])) {
|
|
return \true;
|
|
}
|
|
return !$funcCall->args[2]->value instanceof \PhpParser\Node\Expr\Array_;
|
|
}
|
|
/**
|
|
* @return Arg[]
|
|
*/
|
|
private function composeNewArgs(\PhpParser\Node\Expr\FuncCall $funcCall) : array
|
|
{
|
|
$this->highestIndex = 1;
|
|
$newArgs = [$funcCall->args[0], $funcCall->args[1]];
|
|
/** @var Array_ $optionsArray */
|
|
$optionsArray = $funcCall->args[2]->value;
|
|
/** @var ArrayItem|null $arrayItem */
|
|
foreach ($optionsArray->items as $arrayItem) {
|
|
if ($arrayItem === null) {
|
|
continue;
|
|
}
|
|
$value = $arrayItem->value;
|
|
/** @var String_ $key */
|
|
$key = $arrayItem->key;
|
|
$name = $key->value;
|
|
if (!$this->isMappableArrayKey($name)) {
|
|
continue;
|
|
}
|
|
$order = self::ARGUMENT_ORDER[$name];
|
|
if ($order > $this->highestIndex) {
|
|
$this->highestIndex = $order;
|
|
}
|
|
$newArgs[$order] = new \PhpParser\Node\Arg($value);
|
|
}
|
|
$newArgs = $this->fillMissingArgumentsWithDefaultValues($newArgs);
|
|
\ksort($newArgs);
|
|
return $newArgs;
|
|
}
|
|
private function isMappableArrayKey(string $key) : bool
|
|
{
|
|
return isset(self::ARGUMENT_ORDER[$key]);
|
|
}
|
|
/**
|
|
* @param Arg[] $args
|
|
* @return Arg[]
|
|
*/
|
|
private function fillMissingArgumentsWithDefaultValues(array $args) : array
|
|
{
|
|
for ($i = 1; $i < $this->highestIndex; ++$i) {
|
|
if (isset($args[$i])) {
|
|
continue;
|
|
}
|
|
$args[$i] = $this->createDefaultValueArg($i);
|
|
}
|
|
return $args;
|
|
}
|
|
private function createDefaultValueArg(int $argumentIndex) : \PhpParser\Node\Arg
|
|
{
|
|
if (!\array_key_exists($argumentIndex, self::ARGUMENT_DEFAULT_VALUES)) {
|
|
throw new \Rector\Core\Exception\ShouldNotHappenException();
|
|
}
|
|
$argumentDefaultValue = self::ARGUMENT_DEFAULT_VALUES[$argumentIndex];
|
|
$expr = \PhpParser\BuilderHelpers::normalizeValue($argumentDefaultValue);
|
|
return new \PhpParser\Node\Arg($expr);
|
|
}
|
|
}
|