rector/src/PhpParser/Node/NodeFactory.php
2022-06-10 14:43:16 +00:00

654 lines
20 KiB
PHP

<?php
declare(strict_types=1);
namespace Rector\Core\PhpParser\Node;
use PhpParser\BuilderFactory;
use PhpParser\BuilderHelpers;
use PhpParser\Node;
use PhpParser\Node\Arg;
use PhpParser\Node\Const_;
use PhpParser\Node\Expr;
use PhpParser\Node\Expr\Array_;
use PhpParser\Node\Expr\ArrayItem;
use PhpParser\Node\Expr\Assign;
use PhpParser\Node\Expr\BinaryOp\BooleanAnd;
use PhpParser\Node\Expr\BinaryOp\Concat;
use PhpParser\Node\Expr\BinaryOp\NotIdentical;
use PhpParser\Node\Expr\Cast;
use PhpParser\Node\Expr\ClassConstFetch;
use PhpParser\Node\Expr\Closure;
use PhpParser\Node\Expr\ConstFetch;
use PhpParser\Node\Expr\Error;
use PhpParser\Node\Expr\FuncCall;
use PhpParser\Node\Expr\MethodCall;
use PhpParser\Node\Expr\PropertyFetch;
use PhpParser\Node\Expr\StaticCall;
use PhpParser\Node\Expr\StaticPropertyFetch;
use PhpParser\Node\Expr\Variable;
use PhpParser\Node\Identifier;
use PhpParser\Node\Name;
use PhpParser\Node\Name\FullyQualified;
use PhpParser\Node\Param;
use PhpParser\Node\Scalar;
use PhpParser\Node\Scalar\String_;
use PhpParser\Node\Stmt\Class_;
use PhpParser\Node\Stmt\ClassConst;
use PhpParser\Node\Stmt\ClassMethod;
use PhpParser\Node\Stmt\Property;
use PhpParser\Node\Stmt\Return_;
use PhpParser\Node\Stmt\Use_;
use PhpParser\Node\Stmt\UseUse;
use PHPStan\PhpDocParser\Ast\PhpDoc\GenericTagValueNode;
use PHPStan\PhpDocParser\Ast\PhpDoc\PhpDocTagNode;
use PHPStan\Reflection\MethodReflection;
use PHPStan\Type\MixedType;
use PHPStan\Type\Type;
use Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfoFactory;
use Rector\BetterPhpDocParser\PhpDocManipulator\PhpDocTypeChanger;
use Rector\Core\Configuration\CurrentNodeProvider;
use Rector\Core\Enum\ObjectReference;
use Rector\Core\Exception\NotImplementedYetException;
use Rector\Core\Exception\ShouldNotHappenException;
use Rector\Core\NodeDecorator\PropertyTypeDecorator;
use Rector\Core\Php\PhpVersionProvider;
use Rector\Core\PhpParser\AstResolver;
use Rector\Core\ValueObject\MethodName;
use Rector\Core\ValueObject\PhpVersionFeature;
use Rector\NodeNameResolver\NodeNameResolver;
use Rector\NodeTypeResolver\Node\AttributeKey;
use Rector\PHPStanStaticTypeMapper\Enum\TypeKind;
use Rector\PostRector\ValueObject\PropertyMetadata;
use Rector\StaticTypeMapper\StaticTypeMapper;
use Symplify\Astral\ValueObject\NodeBuilder\MethodBuilder;
use Symplify\Astral\ValueObject\NodeBuilder\ParamBuilder;
use Symplify\Astral\ValueObject\NodeBuilder\PropertyBuilder;
/**
* @see \Rector\Core\Tests\PhpParser\Node\NodeFactoryTest
*/
final class NodeFactory
{
/**
* @var string
*/
private const THIS = 'this';
public function __construct(
private readonly BuilderFactory $builderFactory,
private readonly PhpDocInfoFactory $phpDocInfoFactory,
private readonly PhpVersionProvider $phpVersionProvider,
private readonly StaticTypeMapper $staticTypeMapper,
private readonly NodeNameResolver $nodeNameResolver,
private readonly PhpDocTypeChanger $phpDocTypeChanger,
private readonly CurrentNodeProvider $currentNodeProvider,
private readonly AstResolver $reflectionAstResolver,
private readonly PropertyTypeDecorator $propertyTypeDecorator
) {
}
/**
* Creates "SomeClass::CONSTANT"
*/
public function createShortClassConstFetch(string $shortClassName, string $constantName): ClassConstFetch
{
$name = new Name($shortClassName);
return $this->createClassConstFetchFromName($name, $constantName);
}
/**
* @param string|ObjectReference::* $className
* Creates "\SomeClass::CONSTANT"
*/
public function createClassConstFetch(string $className, string $constantName): ClassConstFetch
{
$name = $this->createName($className);
return $this->createClassConstFetchFromName($name, $constantName);
}
/**
* @param string|ObjectReference::* $className
* Creates "\SomeClass::class"
*/
public function createClassConstReference(string $className): ClassConstFetch
{
return $this->createClassConstFetch($className, 'class');
}
/**
* Creates "['item', $variable]"
*
* @param mixed[] $items
*/
public function createArray(array $items): Array_
{
$arrayItems = [];
$defaultKey = 0;
foreach ($items as $key => $item) {
$customKey = $key !== $defaultKey ? $key : null;
$arrayItems[] = $this->createArrayItem($item, $customKey);
++$defaultKey;
}
return new Array_($arrayItems);
}
/**
* Creates "($args)"
*
* @param mixed[] $values
* @return Arg[]
*/
public function createArgs(array $values): array
{
foreach ($values as $value) {
$this->normalizeArgValue($value);
}
return $this->builderFactory->args($values);
}
/**
* Creates $this->property = $property;
*/
public function createPropertyAssignment(string $propertyName): Assign
{
$variable = new Variable($propertyName);
return $this->createPropertyAssignmentWithExpr($propertyName, $variable);
}
public function createPropertyAssignmentWithExpr(string $propertyName, Expr $expr): Assign
{
$propertyFetch = $this->createPropertyFetch(self::THIS, $propertyName);
return new Assign($propertyFetch, $expr);
}
/**
* @param mixed $argument
*/
public function createArg($argument): Arg
{
return new Arg(BuilderHelpers::normalizeValue($argument));
}
public function createPublicMethod(string $name): ClassMethod
{
$methodBuilder = new MethodBuilder($name);
$methodBuilder->makePublic();
return $methodBuilder->getNode();
}
public function createParamFromNameAndType(string $name, ?Type $type): Param
{
$paramBuilder = new ParamBuilder($name);
if ($type !== null) {
$typeNode = $this->staticTypeMapper->mapPHPStanTypeToPhpParserNode($type, TypeKind::PARAM);
if ($typeNode !== null) {
$paramBuilder->setType($typeNode);
}
}
return $paramBuilder->getNode();
}
public function createPublicInjectPropertyFromNameAndType(string $name, ?Type $type): Property
{
$propertyBuilder = new PropertyBuilder($name);
$propertyBuilder->makePublic();
$property = $propertyBuilder->getNode();
$this->propertyTypeDecorator->decorate($property, $type);
// add @inject
$phpDocInfo = $this->phpDocInfoFactory->createFromNodeOrEmpty($property);
$phpDocInfo->addPhpDocTagNode(new PhpDocTagNode('@inject', new GenericTagValueNode('')));
return $property;
}
public function createPrivatePropertyFromNameAndType(string $name, ?Type $type): Property
{
$propertyBuilder = new PropertyBuilder($name);
$propertyBuilder->makePrivate();
$property = $propertyBuilder->getNode();
$this->propertyTypeDecorator->decorate($property, $type);
return $property;
}
/**
* @param mixed[] $arguments
*/
public function createLocalMethodCall(string $method, array $arguments = []): MethodCall
{
$variable = new Variable('this');
return $this->createMethodCall($variable, $method, $arguments);
}
/**
* @param mixed[] $arguments
*/
public function createMethodCall(Expr|string $exprOrVariableName, string $method, array $arguments = []): MethodCall
{
$callerExpr = $this->createMethodCaller($exprOrVariableName);
return $this->builderFactory->methodCall($callerExpr, $method, $arguments);
}
public function createPropertyFetch(string | Expr $variableNameOrExpr, string $property): PropertyFetch
{
$fetcherExpr = is_string($variableNameOrExpr) ? new Variable($variableNameOrExpr) : $variableNameOrExpr;
return $this->builderFactory->propertyFetch($fetcherExpr, $property);
}
/**
* @param Param[] $params
*/
public function createParentConstructWithParams(array $params): StaticCall
{
return new StaticCall(
new Name(ObjectReference::PARENT),
new Identifier(MethodName::CONSTRUCT),
$this->createArgsFromParams($params)
);
}
public function createProperty(string $name): Property
{
$propertyBuilder = new PropertyBuilder($name);
$property = $propertyBuilder->getNode();
$this->phpDocInfoFactory->createFromNode($property);
return $property;
}
public function createPrivateProperty(string $name): Property
{
$propertyBuilder = new PropertyBuilder($name);
$propertyBuilder->makePrivate();
$property = $propertyBuilder->getNode();
$this->phpDocInfoFactory->createFromNode($property);
return $property;
}
public function createPublicProperty(string $name): Property
{
$propertyBuilder = new PropertyBuilder($name);
$propertyBuilder->makePublic();
$property = $propertyBuilder->getNode();
$this->phpDocInfoFactory->createFromNode($property);
return $property;
}
public function createGetterClassMethod(string $propertyName, Type $type): ClassMethod
{
$methodBuilder = new MethodBuilder('get' . ucfirst($propertyName));
$methodBuilder->makePublic();
$propertyFetch = new PropertyFetch(new Variable(self::THIS), $propertyName);
$return = new Return_($propertyFetch);
$methodBuilder->addStmt($return);
$typeNode = $this->staticTypeMapper->mapPHPStanTypeToPhpParserNode($type, TypeKind::RETURN);
if ($typeNode !== null) {
$methodBuilder->setReturnType($typeNode);
}
return $methodBuilder->getNode();
}
public function createSetterClassMethod(string $propertyName, Type $type): ClassMethod
{
$methodBuilder = new MethodBuilder('set' . ucfirst($propertyName));
$methodBuilder->makePublic();
$variable = new Variable($propertyName);
$param = $this->createParamWithType($variable, $type);
$methodBuilder->addParam($param);
$propertyFetch = new PropertyFetch(new Variable(self::THIS), $propertyName);
$assign = new Assign($propertyFetch, $variable);
$methodBuilder->addStmt($assign);
if ($this->phpVersionProvider->isAtLeastPhpVersion(PhpVersionFeature::VOID_TYPE)) {
$methodBuilder->setReturnType(new Name('void'));
}
return $methodBuilder->getNode();
}
/**
* @param Expr[] $exprs
*/
public function createConcat(array $exprs): ?Concat
{
if (count($exprs) < 2) {
return null;
}
$previousConcat = array_shift($exprs);
foreach ($exprs as $expr) {
$previousConcat = new Concat($previousConcat, $expr);
}
if (! $previousConcat instanceof Concat) {
throw new ShouldNotHappenException();
}
return $previousConcat;
}
public function createClosureFromClassMethod(ClassMethod $classMethod): Closure
{
$classMethodName = $this->nodeNameResolver->getName($classMethod);
$args = $this->createArgs($classMethod->params);
$methodCall = new MethodCall(new Variable(self::THIS), $classMethodName, $args);
$return = new Return_($methodCall);
return new Closure([
'params' => $classMethod->params,
'stmts' => [$return],
'returnType' => $classMethod->returnType,
]);
}
/**
* @param string[] $names
* @return Use_[]
*/
public function createUsesFromNames(array $names): array
{
$uses = [];
foreach ($names as $name) {
$useUse = new UseUse(new Name($name));
$uses[] = new Use_([$useUse]);
}
return $uses;
}
/**
* @param string|ObjectReference::* $class
* @param Node[] $args
*/
public function createStaticCall(string $class, string $method, array $args = []): StaticCall
{
$name = $this->createName($class);
$args = $this->createArgs($args);
return new StaticCall($name, $method, $args);
}
/**
* @param mixed[] $arguments
*/
public function createFuncCall(string $name, array $arguments = []): FuncCall
{
$arguments = $this->createArgs($arguments);
return new FuncCall(new Name($name), $arguments);
}
public function createSelfFetchConstant(string $constantName): ClassConstFetch
{
$name = new Name(ObjectReference::SELF);
return new ClassConstFetch($name, $constantName);
}
/**
* @param Param[] $params
* @return Arg[]
*/
public function createArgsFromParams(array $params): array
{
$args = [];
foreach ($params as $param) {
$args[] = new Arg($param->var);
}
return $args;
}
public function createNull(): ConstFetch
{
return new ConstFetch(new Name('null'));
}
public function createPromotedPropertyParam(PropertyMetadata $propertyMetadata): Param
{
$paramBuilder = new ParamBuilder($propertyMetadata->getName());
$propertyType = $propertyMetadata->getType();
if ($propertyType !== null) {
$typeNode = $this->staticTypeMapper->mapPHPStanTypeToPhpParserNode($propertyType, TypeKind::PROPERTY);
if ($typeNode !== null) {
$paramBuilder->setType($typeNode);
}
}
$param = $paramBuilder->getNode();
$propertyFlags = $propertyMetadata->getFlags();
$param->flags = $propertyFlags !== 0 ? $propertyFlags : Class_::MODIFIER_PRIVATE;
return $param;
}
public function createFalse(): ConstFetch
{
return new ConstFetch(new Name('false'));
}
public function createTrue(): ConstFetch
{
return new ConstFetch(new Name('true'));
}
public function createClosureFromMethodReflection(MethodReflection $methodReflection): Closure
{
$classMethod = $this->reflectionAstResolver->resolveClassMethodFromMethodReflection($methodReflection);
if (! $classMethod instanceof ClassMethod) {
throw new ShouldNotHappenException();
}
return $this->createClosureFromClassMethod($classMethod);
}
/**
* @param string|ObjectReference::* $constantName
*/
public function createClassConstFetchFromName(Name $className, string $constantName): ClassConstFetch
{
$classConstFetch = $this->builderFactory->classConstFetch($className, $constantName);
$classNameString = $className->toString();
if (in_array($classNameString, [ObjectReference::SELF, ObjectReference::STATIC], true)) {
$currentNode = $this->currentNodeProvider->getNode();
if ($currentNode !== null) {
$classConstFetch->class->setAttribute(AttributeKey::RESOLVED_NAME, $className);
}
} else {
$classConstFetch->class->setAttribute(AttributeKey::RESOLVED_NAME, $classNameString);
}
return $classConstFetch;
}
/**
* @param array<NotIdentical|BooleanAnd> $newNodes
*/
public function createReturnBooleanAnd(array $newNodes): ?Expr
{
if ($newNodes === []) {
return null;
}
if (count($newNodes) === 1) {
return $newNodes[0];
}
return $this->createBooleanAndFromNodes($newNodes);
}
public function createClassConstant(string $name, Expr $expr, int $modifier): ClassConst
{
$expr = BuilderHelpers::normalizeValue($expr);
$const = new Const_($name, $expr);
$classConst = new ClassConst([$const]);
$classConst->flags |= $modifier;
// add @var type by default
$staticType = $this->staticTypeMapper->mapPhpParserNodePHPStanType($expr);
if (! $staticType instanceof MixedType) {
$phpDocInfo = $this->phpDocInfoFactory->createFromNodeOrEmpty($classConst);
$this->phpDocTypeChanger->changeVarType($phpDocInfo, $staticType);
}
return $classConst;
}
/**
* @param mixed $item
*/
private function createArrayItem($item, string | int | null $key = null): ArrayItem
{
$arrayItem = null;
if ($item instanceof Variable
|| $item instanceof MethodCall
|| $item instanceof StaticCall
|| $item instanceof FuncCall
|| $item instanceof Concat
|| $item instanceof Scalar
|| $item instanceof Cast
) {
$arrayItem = new ArrayItem($item);
} elseif ($item instanceof Identifier) {
$string = new String_($item->toString());
$arrayItem = new ArrayItem($string);
} elseif (is_scalar($item) || $item instanceof Array_) {
$itemValue = BuilderHelpers::normalizeValue($item);
$arrayItem = new ArrayItem($itemValue);
} elseif (is_array($item)) {
$arrayItem = new ArrayItem($this->createArray($item));
}
if ($item === null || $item instanceof ClassConstFetch) {
$itemValue = BuilderHelpers::normalizeValue($item);
$arrayItem = new ArrayItem($itemValue);
}
if ($item instanceof Arg) {
$arrayItem = new ArrayItem($item->value);
}
if ($arrayItem instanceof ArrayItem) {
$this->decorateArrayItemWithKey($key, $arrayItem);
return $arrayItem;
}
$nodeClass = is_object($item) ? $item::class : $item;
throw new NotImplementedYetException(sprintf(
'Not implemented yet. Go to "%s()" and add check for "%s" node.',
__METHOD__,
(string) $nodeClass
));
}
/**
* @param mixed $value
* @return mixed|Error|Variable
*/
private function normalizeArgValue($value)
{
if ($value instanceof Param) {
return $value->var;
}
return $value;
}
private function decorateArrayItemWithKey(int | string | null $key, ArrayItem $arrayItem): void
{
if ($key !== null) {
$arrayItem->key = BuilderHelpers::normalizeValue($key);
}
}
/**
* @param NotIdentical[]|BooleanAnd[] $exprs
*/
private function createBooleanAndFromNodes(array $exprs): BooleanAnd
{
/** @var NotIdentical|BooleanAnd $booleanAnd */
$booleanAnd = array_shift($exprs);
foreach ($exprs as $expr) {
$booleanAnd = new BooleanAnd($booleanAnd, $expr);
}
/** @var BooleanAnd $booleanAnd */
return $booleanAnd;
}
private function createParamWithType(Variable $variable, Type $type): Param
{
$param = new Param($variable);
$phpParserTypeNode = $this->staticTypeMapper->mapPHPStanTypeToPhpParserNode($type, TypeKind::PARAM);
$param->type = $phpParserTypeNode;
return $param;
}
/**
* @param string|ObjectReference::* $className
*/
private function createName(string $className): Name|FullyQualified
{
if (in_array($className, [ObjectReference::PARENT, ObjectReference::SELF, ObjectReference::STATIC], true)) {
return new Name($className);
}
return new FullyQualified($className);
}
private function createMethodCaller(
Expr|string $exprOrVariableName
): PropertyFetch|Variable|MethodCall|StaticPropertyFetch|Expr {
if (is_string($exprOrVariableName)) {
return new Variable($exprOrVariableName);
}
if ($exprOrVariableName instanceof PropertyFetch) {
return new PropertyFetch($exprOrVariableName->var, $exprOrVariableName->name);
}
if ($exprOrVariableName instanceof StaticPropertyFetch) {
return new StaticPropertyFetch($exprOrVariableName->class, $exprOrVariableName->name);
}
if ($exprOrVariableName instanceof MethodCall) {
return new MethodCall($exprOrVariableName->var, $exprOrVariableName->name, $exprOrVariableName->args);
}
return $exprOrVariableName;
}
}