rector/packages/NodeTypeResolver/src/PerNodeTypeResolver/ParamTypeResolver.php

139 lines
3.9 KiB
PHP
Raw Normal View History

2019-10-13 05:59:52 +00:00
<?php
declare(strict_types=1);
2018-08-06 21:57:05 +00:00
namespace Rector\NodeTypeResolver\PerNodeTypeResolver;
use PhpParser\Node;
2020-01-27 23:28:16 +00:00
use PhpParser\Node\Expr\Variable;
2019-03-10 23:47:43 +00:00
use PhpParser\Node\FunctionLike;
2018-08-06 21:57:05 +00:00
use PhpParser\Node\Param;
2020-01-27 23:28:16 +00:00
use PhpParser\NodeTraverser;
use PHPStan\Type\MixedType;
2019-09-04 12:10:29 +00:00
use PHPStan\Type\ObjectType;
use PHPStan\Type\Type;
2018-08-06 21:57:05 +00:00
use Rector\NodeTypeResolver\Contract\PerNodeTypeResolver\PerNodeTypeResolverInterface;
use Rector\NodeTypeResolver\Node\AttributeKey;
2020-01-27 23:28:16 +00:00
use Rector\NodeTypeResolver\NodeTypeResolver;
2019-03-10 23:47:43 +00:00
use Rector\NodeTypeResolver\PhpDoc\NodeAnalyzer\DocBlockManipulator;
2019-01-14 18:21:23 +00:00
use Rector\PhpParser\Node\Resolver\NameResolver;
2020-01-27 23:28:16 +00:00
use Rector\PhpParser\NodeTraverser\CallableNodeTraverser;
2018-08-06 21:57:05 +00:00
2019-09-01 20:38:31 +00:00
/**
2019-09-03 09:11:45 +00:00
* @see \Rector\NodeTypeResolver\Tests\PerNodeTypeResolver\ParamTypeResolver\ParamTypeResolverTest
2019-09-01 20:38:31 +00:00
*/
2018-08-06 21:57:05 +00:00
final class ParamTypeResolver implements PerNodeTypeResolverInterface
{
2019-01-14 18:21:23 +00:00
/**
* @var NameResolver
*/
private $nameResolver;
2019-03-10 23:47:43 +00:00
/**
* @var DocBlockManipulator
*/
private $docBlockManipulator;
2020-01-27 23:28:16 +00:00
/**
* @var CallableNodeTraverser
*/
private $callableNodeTraverser;
/**
* @var NodeTypeResolver
*/
private $nodeTypeResolver;
public function __construct(
NameResolver $nameResolver,
DocBlockManipulator $docBlockManipulator,
CallableNodeTraverser $callableNodeTraverser
) {
2019-01-14 18:21:23 +00:00
$this->nameResolver = $nameResolver;
2019-03-10 23:47:43 +00:00
$this->docBlockManipulator = $docBlockManipulator;
2020-01-27 23:28:16 +00:00
$this->callableNodeTraverser = $callableNodeTraverser;
}
/**
* @required
*/
public function autowirePropertyTypeResolver(NodeTypeResolver $nodeTypeResolver): void
{
$this->nodeTypeResolver = $nodeTypeResolver;
2019-01-14 18:21:23 +00:00
}
2018-08-06 21:57:05 +00:00
/**
* @return string[]
*/
public function getNodeClasses(): array
{
return [Param::class];
}
/**
2020-01-27 23:28:16 +00:00
* @param Param $node
2018-08-06 21:57:05 +00:00
*/
2020-01-27 23:28:16 +00:00
public function resolve(Node $node): Type
2018-08-06 21:57:05 +00:00
{
2020-01-27 23:28:16 +00:00
if ($node->type !== null) {
if (! $node->type instanceof Node\Identifier) {
$resolveTypeName = $this->nameResolver->getName($node->type);
if ($resolveTypeName) {
// @todo map the other way every type :)
return new ObjectType($resolveTypeName);
}
2019-03-10 23:47:43 +00:00
}
}
2020-01-27 23:28:16 +00:00
$resolvedType = $this->resolveParamStaticType($node);
if (! $resolvedType instanceof MixedType) {
return $resolvedType;
}
2019-03-10 23:47:43 +00:00
/** @var FunctionLike $parentNode */
2020-01-27 23:28:16 +00:00
$parentNode = $node->getAttribute(AttributeKey::PARENT_NODE);
2019-03-10 23:47:43 +00:00
2020-01-27 23:28:16 +00:00
return $this->resolveTypesFromFunctionDocBlock($node, $parentNode);
2019-03-10 23:47:43 +00:00
}
2019-09-04 12:10:29 +00:00
private function resolveTypesFromFunctionDocBlock(Param $param, FunctionLike $functionLike): Type
2019-03-10 23:47:43 +00:00
{
/** @var string $paramName */
$paramName = $this->nameResolver->getName($param);
2019-01-14 18:21:23 +00:00
2019-09-11 11:00:43 +00:00
return $this->docBlockManipulator->getParamTypeByName($functionLike, '$' . $paramName);
2018-08-06 21:57:05 +00:00
}
2020-01-27 23:28:16 +00:00
private function resolveParamStaticType(Param $param): Type
{
$classMethod = $param->getAttribute(AttributeKey::METHOD_NODE);
if ($classMethod === null) {
return new MixedType();
}
/** @var string $paramName */
$paramName = $this->nameResolver->getName($param);
$paramStaticType = new MixedType();
// special case for param inside method/function
$this->callableNodeTraverser->traverseNodesWithCallable(
(array) $classMethod->stmts,
function (Node $node) use ($paramName, &$paramStaticType): ?int {
if (! $node instanceof Variable) {
return null;
}
if (! $this->nameResolver->isName($node, $paramName)) {
return null;
}
$paramStaticType = $this->nodeTypeResolver->resolve($node);
return NodeTraverser::STOP_TRAVERSAL;
}
);
return $paramStaticType;
}
2018-08-06 21:57:05 +00:00
}