Skip to content

Commit 607f7f8

Browse files
VincentLangletVincentLanglet
authored
Improve return type of array map by invoking dynamic function return type extensions for the callback
1 parent 0ec9fb4 commit 607f7f8

File tree

3 files changed

+102
-32
lines changed

3 files changed

+102
-32
lines changed

‎src/Analyser/MutatingScope.php‎

Lines changed: 47 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2335,12 +2335,31 @@ static function (Node $node, Scope $scope) use ($arrowScope, &$arrowFunctionImpu
23352335
return new ErrorType();
23362336
}
23372337

2338-
return ParametersAcceptorSelector::selectFromArgs(
2338+
$parametersAcceptor = ParametersAcceptorSelector::selectFromArgs(
23392339
$this,
23402340
$node->getArgs(),
23412341
$calledOnType->getCallableParametersAcceptors($this),
23422342
null,
2343-
)->getReturnType();
2343+
);
2344+
2345+
$functionName = null;
2346+
if ($node->name instanceof String_) {
2347+
/** @var non-empty-string $name */
2348+
$name = $node->name->value;
2349+
$functionName = new Name($name);
2350+
} elseif ($node->name instanceof FuncCall && $node->name->name instanceof Name) {
2351+
$functionName = $node->name->name;
2352+
}
2353+
2354+
if ($functionName !== null && $this->reflectionProvider->hasFunction($functionName, $this)) {
2355+
$functionReflection = $this->reflectionProvider->getFunction($functionName, $this);
2356+
$resolvedType = $this->getDynamicFunctionReturnType($parametersAcceptor, $node, $functionReflection);
2357+
if ($resolvedType !== null) {
2358+
return $resolvedType;
2359+
}
2360+
}
2361+
2362+
return $parametersAcceptor->getReturnType();
23442363
}
23452364

23462365
if (!$this->reflectionProvider->hasFunction($node->name, $this)) {
@@ -2369,19 +2388,9 @@ static function (Node $node, Scope $scope) use ($arrowScope, &$arrowFunctionImpu
23692388
);
23702389
$normalizedNode = ArgumentsNormalizer::reorderFuncArguments($parametersAcceptor, $node);
23712390
if ($normalizedNode !== null) {
2372-
foreach ($this->dynamicReturnTypeExtensionRegistry->getDynamicFunctionReturnTypeExtensions() as $dynamicFunctionReturnTypeExtension) {
2373-
if (!$dynamicFunctionReturnTypeExtension->isFunctionSupported($functionReflection)) {
2374-
continue;
2375-
}
2376-
2377-
$resolvedType = $dynamicFunctionReturnTypeExtension->getTypeFromFunctionCall(
2378-
$functionReflection,
2379-
$normalizedNode,
2380-
$this,
2381-
);
2382-
if ($resolvedType !== null) {
2383-
return $resolvedType;
2384-
}
2391+
$resolvedType = $this->getDynamicFunctionReturnType($parametersAcceptor, $normalizedNode, $functionReflection);
2392+
if ($resolvedType !== null) {
2393+
return $resolvedType;
23852394
}
23862395
}
23872396

@@ -2391,6 +2400,29 @@ static function (Node $node, Scope $scope) use ($arrowScope, &$arrowFunctionImpu
23912400
return new MixedType();
23922401
}
23932402

2403+
private function getDynamicFunctionReturnType(ParametersAcceptor $parametersAcceptor, FuncCall $node, FunctionReflection $functionReflection): ?Type
2404+
{
2405+
$normalizedNode = ArgumentsNormalizer::reorderFuncArguments($parametersAcceptor, $node);
2406+
if ($normalizedNode !== null) {
2407+
foreach ($this->dynamicReturnTypeExtensionRegistry->getDynamicFunctionReturnTypeExtensions() as $dynamicFunctionReturnTypeExtension) {
2408+
if (!$dynamicFunctionReturnTypeExtension->isFunctionSupported($functionReflection)) {
2409+
continue;
2410+
}
2411+
2412+
$resolvedType = $dynamicFunctionReturnTypeExtension->getTypeFromFunctionCall(
2413+
$functionReflection,
2414+
$node,
2415+
$this,
2416+
);
2417+
if ($resolvedType !== null) {
2418+
return $resolvedType;
2419+
}
2420+
}
2421+
}
2422+
2423+
return null;
2424+
}
2425+
23942426
private function getNullsafeShortCircuitingType(Expr $expr, Type $type): Type
23952427
{
23962428
if ($expr instanceof Expr\NullsafePropertyFetch || $expr instanceof Expr\NullsafeMethodCall) {

‎src/Type/Php/ArrayMapFunctionReturnTypeExtension.php‎

Lines changed: 10 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@
66
use PhpParser\Node\Expr\FuncCall;
77
use PHPStan\Analyser\Scope;
88
use PHPStan\DependencyInjection\AutowiredService;
9+
use PHPStan\Node\Expr\TypeExpr;
910
use PHPStan\Reflection\FunctionReflection;
10-
use PHPStan\Reflection\ParametersAcceptorSelector;
1111
use PHPStan\Type\Accessory\AccessoryArrayListType;
1212
use PHPStan\Type\Accessory\NonEmptyArrayType;
1313
use PHPStan\Type\ArrayType;
@@ -41,21 +41,18 @@ public function getTypeFromFunctionCall(FunctionReflection $functionReflection,
4141
}
4242

4343
$singleArrayArgument = !isset($functionCall->getArgs()[2]);
44-
$callableType = $scope->getType($functionCall->getArgs()[0]->value);
44+
$callback = $functionCall->getArgs()[0]->value;
45+
$callableType = $scope->getType($callback);
4546
$callableIsNull = $callableType->isNull()->yes();
4647

47-
$callableParametersAcceptors = null;
48-
4948
if ($callableType->isCallable()->yes()) {
50-
$callableParametersAcceptors = $callableType->getCallableParametersAcceptors($scope);
51-
$valueType = ParametersAcceptorSelector::selectFromTypes(
49+
$valueType = $scope->getType(new FuncCall(
50+
$callback,
5251
array_map(
53-
static fn (Node\Arg $arg) => $scope->getType($arg->value)->getIterableValueType(),
52+
static fn (Node\Arg $arg) => new Node\Arg(new TypeExpr($scope->getType($arg->value)->getIterableValueType())),
5453
array_slice($functionCall->getArgs(), 1),
5554
),
56-
$callableParametersAcceptors,
57-
false,
58-
)->getReturnType();
55+
));
5956
} elseif ($callableIsNull) {
6057
$arrayBuilder = ConstantArrayTypeBuilder::createEmpty();
6158
$argTypes = [];
@@ -134,13 +131,9 @@ public function getTypeFromFunctionCall(FunctionReflection $functionReflection,
134131
foreach ($constantArray->getKeyTypes() as $i => $keyType) {
135132
$returnedArrayBuilder->setOffsetValueType(
136133
$keyType,
137-
$callableParametersAcceptors !== null
138-
? ParametersAcceptorSelector::selectFromTypes(
139-
[$valueTypes[$i]],
140-
$callableParametersAcceptors,
141-
false,
142-
)->getReturnType()
143-
: $valueType,
134+
$scope->getType(new FuncCall($callback, [
135+
new Node\Arg(new TypeExpr($valueTypes[$i])),
136+
])),
144137
$constantArray->isOptionalKey($i),
145138
);
146139
}

‎tests/PHPStan/Analyser/nsrt/array-map.php‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,3 +72,48 @@ static function(string $string): string {
7272

7373
assertType('array{foo?: string, bar?: string, baz?: string}', $mapped);
7474
}
75+
76+
class Foo
77+
{
78+
/**
79+
* @template T of int
80+
* @param T $n
81+
* @return (T is 3 ? 'Fizz' : (T is 5 ? 'Buzz' : T))
82+
*/
83+
public static function fizzbuzz(int $n): int|string
84+
{
85+
return match ($n) {
86+
3 => 'Fizz',
87+
5 => 'Buzz',
88+
default => $n,
89+
};
90+
}
91+
92+
public function doFoo(): void
93+
{
94+
$a = range(0, 1);
95+
96+
assertType("array{'0', '1'}", array_map('strval', $a));
97+
assertType("array{'0', '1'}", array_map(strval(...), $a));
98+
assertType("array{'0'|'1', '0'|'1'}", array_map(fn ($v) => strval($v), $a));
99+
assertType("array{'0'|'1', '0'|'1'}", array_map(fn ($v) => (string)$v, $a));
100+
}
101+
102+
public function doFizzBuzz(): void
103+
{
104+
assertType("array{1, 2, 'Fizz', 4, 'Buzz', 6}", array_map([__CLASS__, 'fizzbuzz'], range(1, 6)));
105+
assertType("array{1, 2, 'Fizz', 4, 'Buzz', 6}", array_map([$this, 'fizzbuzz'], range(1, 6)));
106+
assertType("array{1, 2, 'Fizz', 4, 'Buzz', 6}", array_map(self::fizzbuzz(...), range(1, 6)));
107+
assertType("array{1, 2, 'Fizz', 4, 'Buzz', 6}", array_map($this->fizzbuzz(...), range(1, 6)));
108+
}
109+
110+
/**
111+
* @param array<string, 'a'|'b'|'A'|'B'> $array
112+
*/
113+
public function doUppercase(array $array): void
114+
{
115+
assertType("array<string, 'A'|'B'>", array_map(strtoupper(...), $array));
116+
assertType("array{'A', 'B'}", array_map(strtoupper(...), ['A', 'B']));
117+
}
118+
119+
}

0 commit comments

Comments
 (0)