2019-10-13 05:59:52 +00:00
|
|
|
<?php
|
|
|
|
|
|
|
|
declare(strict_types=1);
|
2018-08-06 21:57:05 +00:00
|
|
|
|
2020-02-10 08:58:04 +00:00
|
|
|
namespace Rector\NodeTypeResolver\NodeTypeResolver;
|
2018-08-06 21:57:05 +00:00
|
|
|
|
|
|
|
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;
|
2020-01-27 23:45:52 +00:00
|
|
|
use PhpParser\Node\Identifier;
|
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\Type;
|
2020-01-31 08:18:45 +00:00
|
|
|
use Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfo;
|
2020-08-11 10:59:04 +00:00
|
|
|
use Rector\Core\Exception\ShouldNotHappenException;
|
2020-02-09 22:47:00 +00:00
|
|
|
use Rector\NodeNameResolver\NodeNameResolver;
|
2020-02-10 08:58:04 +00:00
|
|
|
use Rector\NodeTypeResolver\Contract\NodeTypeResolverInterface;
|
2019-04-13 09:20:27 +00:00
|
|
|
use Rector\NodeTypeResolver\Node\AttributeKey;
|
2020-01-27 23:28:16 +00:00
|
|
|
use Rector\NodeTypeResolver\NodeTypeResolver;
|
2020-05-06 15:29:25 +00:00
|
|
|
use Rector\StaticTypeMapper\StaticTypeMapper;
|
2021-01-16 21:45:18 +00:00
|
|
|
use Symplify\Astral\NodeTraverser\SimpleCallableNodeTraverser;
|
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
|
|
|
*/
|
2020-02-10 08:58:04 +00:00
|
|
|
final class ParamTypeResolver implements NodeTypeResolverInterface
|
2018-08-06 21:57:05 +00:00
|
|
|
{
|
2019-01-14 18:21:23 +00:00
|
|
|
/**
|
2020-02-09 11:31:31 +00:00
|
|
|
* @var NodeNameResolver
|
2019-01-14 18:21:23 +00:00
|
|
|
*/
|
2020-02-09 11:31:31 +00:00
|
|
|
private $nodeNameResolver;
|
2019-01-14 18:21:23 +00:00
|
|
|
|
2020-01-27 23:28:16 +00:00
|
|
|
/**
|
2021-01-16 21:45:18 +00:00
|
|
|
* @var SimpleCallableNodeTraverser
|
2020-01-27 23:28:16 +00:00
|
|
|
*/
|
2021-01-16 21:45:18 +00:00
|
|
|
private $simpleCallableNodeTraverser;
|
2020-01-27 23:28:16 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @var NodeTypeResolver
|
|
|
|
*/
|
|
|
|
private $nodeTypeResolver;
|
|
|
|
|
2020-05-06 15:29:25 +00:00
|
|
|
/**
|
|
|
|
* @var StaticTypeMapper
|
|
|
|
*/
|
|
|
|
private $staticTypeMapper;
|
|
|
|
|
2021-01-16 21:45:18 +00:00
|
|
|
public function __construct(
|
|
|
|
SimpleCallableNodeTraverser $simpleCallableNodeTraverser,
|
|
|
|
NodeNameResolver $nodeNameResolver
|
|
|
|
) {
|
2020-02-09 11:31:31 +00:00
|
|
|
$this->nodeNameResolver = $nodeNameResolver;
|
2021-01-16 21:45:18 +00:00
|
|
|
$this->simpleCallableNodeTraverser = $simpleCallableNodeTraverser;
|
2020-01-27 23:28:16 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @required
|
|
|
|
*/
|
2020-10-02 10:29:18 +00:00
|
|
|
public function autowireParamTypeResolver(
|
2020-05-06 15:29:25 +00:00
|
|
|
NodeTypeResolver $nodeTypeResolver,
|
|
|
|
StaticTypeMapper $staticTypeMapper
|
|
|
|
): void {
|
2020-01-27 23:28:16 +00:00
|
|
|
$this->nodeTypeResolver = $nodeTypeResolver;
|
2020-05-06 15:29:25 +00:00
|
|
|
$this->staticTypeMapper = $staticTypeMapper;
|
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-12-20 12:50:55 +00:00
|
|
|
$paramType = $this->resolveFromParamType($node);
|
2020-01-27 23:45:52 +00:00
|
|
|
if (! $paramType instanceof MixedType) {
|
|
|
|
return $paramType;
|
2019-03-10 23:47:43 +00:00
|
|
|
}
|
|
|
|
|
2020-01-27 23:45:52 +00:00
|
|
|
$firstVariableUseType = $this->resolveFromFirstVariableUse($node);
|
|
|
|
if (! $firstVariableUseType instanceof MixedType) {
|
|
|
|
return $firstVariableUseType;
|
2020-01-27 23:28:16 +00:00
|
|
|
}
|
|
|
|
|
2020-01-27 23:45:52 +00:00
|
|
|
return $this->resolveFromFunctionDocBlock($node);
|
2018-08-06 21:57:05 +00:00
|
|
|
}
|
2020-01-27 23:28:16 +00:00
|
|
|
|
2020-12-20 12:50:55 +00:00
|
|
|
private function resolveFromParamType(Param $param): Type
|
2020-02-01 16:04:38 +00:00
|
|
|
{
|
2020-12-20 12:50:55 +00:00
|
|
|
if ($param->type === null) {
|
|
|
|
return new MixedType();
|
|
|
|
}
|
|
|
|
|
|
|
|
if ($param->type instanceof Identifier) {
|
|
|
|
return new MixedType();
|
2020-02-01 16:04:38 +00:00
|
|
|
}
|
|
|
|
|
2020-12-20 12:50:55 +00:00
|
|
|
return $this->staticTypeMapper->mapPhpParserNodePHPStanType($param->type);
|
2020-02-01 16:04:38 +00:00
|
|
|
}
|
|
|
|
|
2020-01-27 23:45:52 +00:00
|
|
|
private function resolveFromFirstVariableUse(Param $param): Type
|
2020-01-27 23:28:16 +00:00
|
|
|
{
|
|
|
|
$classMethod = $param->getAttribute(AttributeKey::METHOD_NODE);
|
|
|
|
if ($classMethod === null) {
|
|
|
|
return new MixedType();
|
|
|
|
}
|
|
|
|
|
2020-02-09 11:31:31 +00:00
|
|
|
$paramName = $this->nodeNameResolver->getName($param);
|
2020-01-27 23:28:16 +00:00
|
|
|
$paramStaticType = new MixedType();
|
|
|
|
|
|
|
|
// special case for param inside method/function
|
2021-01-16 21:45:18 +00:00
|
|
|
$this->simpleCallableNodeTraverser->traverseNodesWithCallable(
|
2020-01-27 23:28:16 +00:00
|
|
|
(array) $classMethod->stmts,
|
|
|
|
function (Node $node) use ($paramName, &$paramStaticType): ?int {
|
|
|
|
if (! $node instanceof Variable) {
|
|
|
|
return null;
|
|
|
|
}
|
|
|
|
|
2020-02-09 11:31:31 +00:00
|
|
|
if (! $this->nodeNameResolver->isName($node, $paramName)) {
|
2020-01-27 23:28:16 +00:00
|
|
|
return null;
|
|
|
|
}
|
|
|
|
|
|
|
|
$paramStaticType = $this->nodeTypeResolver->resolve($node);
|
|
|
|
|
|
|
|
return NodeTraverser::STOP_TRAVERSAL;
|
|
|
|
}
|
|
|
|
);
|
|
|
|
|
|
|
|
return $paramStaticType;
|
|
|
|
}
|
2020-01-27 23:45:52 +00:00
|
|
|
|
|
|
|
private function resolveFromFunctionDocBlock(Param $param): Type
|
|
|
|
{
|
2020-08-11 10:59:04 +00:00
|
|
|
$phpDocInfo = $this->getFunctionLikePhpDocInfo($param);
|
|
|
|
if ($phpDocInfo === null) {
|
|
|
|
return new MixedType();
|
|
|
|
}
|
2020-01-27 23:45:52 +00:00
|
|
|
|
2020-02-09 11:31:31 +00:00
|
|
|
$paramName = $this->nodeNameResolver->getName($param);
|
2020-08-11 10:59:04 +00:00
|
|
|
return $phpDocInfo->getParamType($paramName);
|
|
|
|
}
|
2020-01-27 23:45:52 +00:00
|
|
|
|
2020-08-11 10:59:04 +00:00
|
|
|
private function getFunctionLikePhpDocInfo(Param $param): ?PhpDocInfo
|
|
|
|
{
|
|
|
|
$parentNode = $param->getAttribute(AttributeKey::PARENT_NODE);
|
|
|
|
if (! $parentNode instanceof FunctionLike) {
|
|
|
|
throw new ShouldNotHappenException();
|
|
|
|
}
|
2020-01-31 08:18:45 +00:00
|
|
|
|
2020-08-11 10:59:04 +00:00
|
|
|
return $parentNode->getAttribute(AttributeKey::PHP_DOC_INFO);
|
2020-01-27 23:45:52 +00:00
|
|
|
}
|
2018-08-06 21:57:05 +00:00
|
|
|
}
|