Skip to content

Commit 0b5944b

Browse files
calebdwcalebdw
committed
feat: get array types working (pass variable around)
1 parent e5fd47e commit 0b5944b

99 files changed

Lines changed: 953 additions & 189 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.github/workflows/e2e-tests.yml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -744,6 +744,10 @@ jobs:
744744
echo "FAIL: tmp was created by a worker, meaning sys_temp_dir='tmp~1' was incorrectly evaluated to 'tmp'"
745745
exit 1
746746
fi
747+
- script: |
748+
cd e2e/parameter-type-extension
749+
composer install
750+
../../bin/phpstan analyze
747751
748752
steps:
749753
- name: Harden the runner (Audit all outbound calls)

‎e2e/parameter-type-extension/.gitignore‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
/vendor
2+
/composer.lock

‎e2e/parameter-type-extension/composer.json‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"autoload": {
3+
"psr-4": {
4+
"App\\": "src/"
5+
}
6+
}
7+
}

‎e2e/parameter-type-extension/phpstan-baseline.neon‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
parameters:
2+
ignoreErrors:
3+
-
4+
message: '#^Parameter \#1 \$relations of method App\\Builder\<App\\User\>\:\:with\(\) expects array\<string, Closure\(App\\Relation\<\*, \*, \*\>\)\: mixed\>, array\{car\: Closure\(App\\HasOne\)\: App\\HasOne, monitorable\: Closure\(App\\MorphTo\)\: App\\MorphTo\} given\.$#'
5+
identifier: argument.type
6+
count: 1
7+
path: src/test.php

‎e2e/parameter-type-extension/phpstan.neon.dist‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
includes:
2+
- phpstan-baseline.neon
3+
parameters:
4+
level: 9
5+
paths:
6+
- src
7+
services:
8+
-
9+
class: App\ParameterTypeExtension
10+
tags:
11+
- phpstan.dynamicMethodParameterTypeExtension

‎e2e/parameter-type-extension/src/ParameterTypeExtension.php‎

Lines changed: 110 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,110 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace App;
6+
7+
use PHPStan\Analyser\Scope;
8+
use PHPStan\Reflection\MethodReflection;
9+
use PHPStan\Reflection\ParameterReflection;
10+
use PHPStan\Reflection\PassedByReference;
11+
use PHPStan\Type\ClosureType;
12+
use PHPStan\Type\DynamicMethodParameterTypeExtension;
13+
use PHPStan\Type\MixedType;
14+
use PHPStan\Type\ObjectType;
15+
use PHPStan\Type\Type;
16+
use PhpParser\Node\Expr\MethodCall;
17+
18+
final class ParameterTypeExtension implements DynamicMethodParameterTypeExtension
19+
{
20+
public function isMethodSupported(MethodReflection $methodReflection, ParameterReflection $parameter): bool
21+
{
22+
if (! $methodReflection->getDeclaringClass()->is(Builder::class)) {
23+
return false;
24+
}
25+
26+
return $methodReflection->getName() === 'with';
27+
}
28+
29+
public function getTypeFromMethodCall(
30+
MethodReflection $methodReflection,
31+
MethodCall $methodCall,
32+
ParameterReflection $parameter,
33+
Scope $scope,
34+
): Type|null {
35+
$arg = $methodCall->getArgs()[0] ?? null;
36+
if (!$arg) {
37+
return null;
38+
}
39+
40+
$type = $scope->getType($arg->value)->getConstantArrays()[0] ?? null;
41+
if (!$type) {
42+
return null;
43+
}
44+
45+
$model = $scope->getType($methodCall->var)
46+
->getTemplateType(Builder::class, 'TModel')
47+
->getObjectClassNames()[0] ?? null;
48+
if (!$model) {
49+
return null;
50+
}
51+
52+
foreach ($type->getKeyTypes() as $keyType) {
53+
$relationType = $this->getRelationTypeFromModel($model, (string) $keyType->getValue(), $scope);
54+
if (!$relationType) {
55+
continue;
56+
}
57+
58+
$newType = new ClosureType([
59+
new class('test', $relationType) implements ParameterReflection {
60+
public function __construct(private string $name, private Type $type) {}
61+
public function getName(): string
62+
{
63+
return $this->name;
64+
}
65+
public function isOptional(): bool
66+
{
67+
return false;
68+
}
69+
public function getType(): Type
70+
{
71+
return $this->type;
72+
}
73+
public function passedByReference(): PassedByReference
74+
{
75+
return PassedByReference::createNo();
76+
}
77+
public function isVariadic(): bool
78+
{
79+
return false;
80+
}
81+
public function getDefaultValue(): ?Type
82+
{
83+
return null;
84+
}
85+
},
86+
], new MixedType(), false);
87+
88+
$type = $type->setOffsetValueType($keyType, $newType, false);
89+
}
90+
91+
return $type;
92+
}
93+
94+
public function getRelationTypeFromModel(string $model, string $relation, Scope $scope): ?Type
95+
{
96+
$modelType = new ObjectType($model);
97+
98+
if (! $modelType->hasMethod($relation)->yes()) {
99+
return null;
100+
}
101+
102+
$relationType = $modelType->getMethod($relation, $scope)->getVariants()[0]->getReturnType();
103+
104+
if (! (new ObjectType(Relation::class))->isSuperTypeOf($relationType)->yes()) {
105+
return null;
106+
}
107+
108+
return $relationType;
109+
}
110+
}

‎e2e/parameter-type-extension/src/test.php‎

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
<?php declare(strict_types = 1);
2+
3+
namespace App;
4+
5+
use function PHPStan\Testing\assertType;
6+
7+
abstract class Model {}
8+
9+
class Monitor extends Model {}
10+
11+
class Car extends Model {}
12+
13+
class User extends Model
14+
{
15+
/** @return HasOne<Car, $this> */
16+
public function car(): HasOne
17+
{
18+
return new HasOne(); // @phpstan-ignore return.type
19+
}
20+
21+
/** @return MorphTo<Monitor, $this> */
22+
public function monitorable(): MorphTo
23+
{
24+
return new MorphTo(); // @phpstan-ignore return.type
25+
}
26+
}
27+
28+
/**
29+
* @template TRelatedModel of Model
30+
* @template TDeclaringModel of Model
31+
* @template TResult
32+
*/
33+
class Relation {
34+
/**
35+
* @param list<string> $columns
36+
* @return $this
37+
*/
38+
public function select(array $columns): static
39+
{
40+
return $this;
41+
}
42+
}
43+
44+
/**
45+
* @template TRelatedModel of Model
46+
* @template TDeclaringModel of Model
47+
* @extends Relation<TRelatedModel, TDeclaringModel, ?TRelatedModel>
48+
*/
49+
class HasOne extends Relation {}
50+
51+
/**
52+
* @template TRelatedModel of Model
53+
* @template TDeclaringModel of Model
54+
* @extends Relation<TRelatedModel, TDeclaringModel, ?TRelatedModel>
55+
*/
56+
class MorphTo extends Relation {
57+
/** @return $this */
58+
public function morphWith(): static
59+
{
60+
return $this;
61+
}
62+
}
63+
64+
/** @template TModel of Model */
65+
class Builder
66+
{
67+
/**
68+
* @param array<string, \Closure(Relation<*, *, *>): mixed> $relations
69+
* @return $this
70+
*/
71+
public function with(array $relations): static
72+
{
73+
return $this;
74+
}
75+
}
76+
77+
/** @param Builder<User> $query */
78+
function test(Builder $query): void
79+
{
80+
$query->with([
81+
'car' => function ($r) { assertType('App\HasOne<App\Car, App\User>', $r); },
82+
'monitorable' => function ($r) { assertType('App\MorphTo<App\Monitor, App\User>', $r); },
83+
]);
84+
$query->with([
85+
'car' => fn (HasOne $q) => $q->select(['id']),
86+
'monitorable' => fn (MorphTo $q) => $q->morphWith(),
87+
]);
88+
}

‎src/Analyser/ExprHandler.php‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ public function processExpr(
3232
ExpressionResultStorage $storage,
3333
callable $nodeCallback,
3434
ExpressionContext $context,
35+
?Type $overriddenType,
3536
): ExpressionResult;
3637

3738
/**

‎src/Analyser/ExprHandler/ArrayDimFetchHandler.php‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -83,17 +83,17 @@ public function resolveType(MutatingScope $scope, Expr $expr): Type
8383
);
8484
}
8585

86-
public function processExpr(NodeScopeResolver $nodeScopeResolver, Stmt $stmt, Expr $expr, MutatingScope $scope, ExpressionResultStorage $storage, callable $nodeCallback, ExpressionContext $context): ExpressionResult
86+
public function processExpr(NodeScopeResolver $nodeScopeResolver, Stmt $stmt, Expr $expr, MutatingScope $scope, ExpressionResultStorage $storage, callable $nodeCallback, ExpressionContext $context, ?Type $overriddenType): ExpressionResult
8787
{
8888
$beforeScope = $scope;
8989
if ($expr->dim === null) {
90-
$varResult = $nodeScopeResolver->processExprNode($stmt, $expr->var, $scope, $storage, $nodeCallback, $context->enterDeep());
90+
$varResult = $nodeScopeResolver->processExprNode($stmt, $expr->var, $scope, $storage, $nodeCallback, $context->enterDeep(), null);
9191

9292
return $this->composeResult($nodeScopeResolver, $stmt, $expr, null, $varResult, $storage, $context, $beforeScope);
9393
}
9494

95-
$dimResult = $nodeScopeResolver->processExprNode($stmt, $expr->dim, $scope, $storage, $nodeCallback, $context->enterDeep());
96-
$varResult = $nodeScopeResolver->processExprNode($stmt, $expr->var, $dimResult->getScope(), $storage, $nodeCallback, $context->enterDeep());
95+
$dimResult = $nodeScopeResolver->processExprNode($stmt, $expr->dim, $scope, $storage, $nodeCallback, $context->enterDeep(), null);
96+
$varResult = $nodeScopeResolver->processExprNode($stmt, $expr->var, $dimResult->getScope(), $storage, $nodeCallback, $context->enterDeep(), null);
9797

9898
return $this->composeResult($nodeScopeResolver, $stmt, $expr, $dimResult, $varResult, $storage, $context, $beforeScope);
9999
}

‎src/Analyser/ExprHandler/ArrayHandler.php‎

Lines changed: 25 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,12 @@
2424
use PHPStan\Node\LiteralArrayNode;
2525
use PHPStan\Reflection\InitializerExprTypeResolver;
2626
use PHPStan\Type\CallableType;
27+
use PHPStan\Type\Constant\ConstantIntegerType;
2728
use PHPStan\Type\Type;
2829
use PHPStan\Type\TypeCombinator;
2930
use function array_merge;
3031
use function count;
32+
use function is_int;
3133

3234
/**
3335
* @implements ExprHandler<Array_>
@@ -72,27 +74,47 @@ public function resolveType(MutatingScope $scope, Expr $expr): Type
7274
return $type;
7375
}
7476

75-
public function processExpr(NodeScopeResolver $nodeScopeResolver, Stmt $stmt, Expr $expr, MutatingScope $scope, ExpressionResultStorage $storage, callable $nodeCallback, ExpressionContext $context): ExpressionResult
77+
public function processExpr(NodeScopeResolver $nodeScopeResolver, Stmt $stmt, Expr $expr, MutatingScope $scope, ExpressionResultStorage $storage, callable $nodeCallback, ExpressionContext $context, ?Type $overriddenType): ExpressionResult
7678
{
7779
$beforeScope = $scope;
7880
$itemNodes = [];
7981
$hasYield = false;
8082
$throwPoints = [];
8183
$impurePoints = [];
8284
$isAlwaysTerminating = false;
85+
$nextAutoIndex = 0;
8386
foreach ($expr->items as $arrayItem) {
8487
$itemNodes[] = new LiteralArrayItem($scope, $arrayItem);
8588
$nodeScopeResolver->callNodeCallback($nodeCallback, $arrayItem, $scope, $storage);
89+
$keyType = new ConstantIntegerType($nextAutoIndex);
8690
if ($arrayItem->key !== null) {
87-
$keyResult = $nodeScopeResolver->processExprNode($stmt, $arrayItem->key, $scope, $storage, $nodeCallback, $context->enterDeep());
91+
$keyType = $scope->getType($arrayItem->key);
92+
$keyResult = $nodeScopeResolver->processExprNode($stmt, $arrayItem->key, $scope, $storage, $nodeCallback, $context->enterDeep(), null);
8893
$hasYield = $hasYield || $keyResult->hasYield();
8994
$throwPoints = array_merge($throwPoints, $keyResult->getThrowPoints());
9095
$impurePoints = array_merge($impurePoints, $keyResult->getImpurePoints());
9196
$isAlwaysTerminating = $isAlwaysTerminating || $keyResult->isAlwaysTerminating();
9297
$scope = $keyResult->getScope();
9398
}
9499

95-
$valueResult = $nodeScopeResolver->processExprNode($stmt, $arrayItem->value, $scope, $storage, $nodeCallback, $context->enterDeep());
100+
// an overridden array type prices each item against the type declared
101+
// for its key, so a nested closure is walked with the parameters the
102+
// extension announced instead of the declared (contravariant) ones
103+
$overriddenValueType = null;
104+
if ($overriddenType !== null && $overriddenType->hasOffsetValueType($keyType)->yes()) {
105+
$overriddenValueType = $overriddenType->getOffsetValueType($keyType);
106+
}
107+
108+
if ($arrayItem->key === null) {
109+
$nextAutoIndex++;
110+
} else {
111+
$keyIntegers = $keyType->getConstantScalarValues();
112+
if (count($keyIntegers) === 1 && is_int($keyIntegers[0])) {
113+
$nextAutoIndex = $keyIntegers[0] + 1;
114+
}
115+
}
116+
117+
$valueResult = $nodeScopeResolver->processExprNode($stmt, $arrayItem->value, $scope, $storage, $nodeCallback, $context->enterDeep(), $overriddenValueType);
96118
$hasYield = $hasYield || $valueResult->hasYield();
97119
$throwPoints = array_merge($throwPoints, $valueResult->getThrowPoints());
98120
$impurePoints = array_merge($impurePoints, $valueResult->getImpurePoints());

0 commit comments

Comments
 (0)