Skip to content

Commit 2fc7cd8

Browse files
zonuexezonuexe
committed
Resolve self/parent/static in Closure::bind() scope for static calls, properties and instantiation
Extend the Closure::bind() scope binding beyond class constants to the natural remaining surface: - MutatingScope::resolveName()/resolveTypeByName() now honour the bind scope annotated on self/parent/static class-name nodes, so static method-call return types, static property types and `new self/parent/static` resolve against the bound class even outside a class context (the closure body's type is inferred in the enclosing scope where the closure-bind scope classes are otherwise absent). - StaticMethodCallCheck, AccessStaticPropertiesCheck and InstantiationRule no longer report "outside of class scope" for self/parent/static inside a bound closure, resolving accessibility against the bound class. - ClosureBindArgVisitor now only rescopes the closure body (1st argument), not the $newThis/$newScope arguments, avoiding a self-referential scope annotation on a `self::class` scope argument. Continues the reconstruction of PR phpstan#4081 on 2.2.x.
1 parent f4b4be5 commit 2fc7cd8

12 files changed

Lines changed: 281 additions & 104 deletions

‎src/Analyser/MutatingScope.php‎

Lines changed: 59 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@
3838
use PHPStan\Node\IssetExpr;
3939
use PHPStan\Node\Printer\ExprPrinter;
4040
use PHPStan\Node\VirtualNode;
41+
use PHPStan\Parser\ClosureBindArgVisitor;
4142
use PHPStan\Parser\Parser;
4243
use PHPStan\Php\PhpVersion;
4344
use PHPStan\Php\PhpVersionFactory;
@@ -1315,8 +1316,22 @@ private function promoteNativeTypes(): self
13151316
public function resolveName(Name $name): string
13161317
{
13171318
$originalClass = (string) $name;
1319+
$lowerClass = strtolower($originalClass);
1320+
1321+
$bindScopeClassName = $this->resolveClosureBindScopeClassName($name);
1322+
if ($bindScopeClassName !== null) {
1323+
if (in_array($lowerClass, ['self', 'static'], true)) {
1324+
return $bindScopeClassName;
1325+
}
1326+
if ($lowerClass === 'parent' && $this->reflectionProvider->hasClass($bindScopeClassName)) {
1327+
$parentClassReflection = $this->reflectionProvider->getClass($bindScopeClassName)->getParentClass();
1328+
if ($parentClassReflection !== null) {
1329+
return $parentClassReflection->getName();
1330+
}
1331+
}
1332+
}
1333+
13181334
if ($this->isInClass()) {
1319-
$lowerClass = strtolower($originalClass);
13201335
if (in_array($lowerClass, [
13211336
'self',
13221337
'static',
@@ -1339,17 +1354,26 @@ public function resolveName(Name $name): string
13391354
/** @api */
13401355
public function resolveTypeByName(Name $name): TypeWithClassName
13411356
{
1342-
if ($name->toLowerString() === 'static' && $this->isInClass()) {
1343-
if ($this->inClosureBindScopeClasses !== [] && $this->inClosureBindScopeClasses !== ['static']) {
1344-
if ($this->reflectionProvider->hasClass($this->inClosureBindScopeClasses[0])) {
1345-
return new StaticType($this->reflectionProvider->getClass($this->inClosureBindScopeClasses[0]));
1346-
}
1357+
$bindScopeClassName = $this->resolveClosureBindScopeClassName($name);
1358+
if ($name->toLowerString() === 'static') {
1359+
if ($bindScopeClassName !== null && $this->reflectionProvider->hasClass($bindScopeClassName)) {
1360+
return new StaticType($this->reflectionProvider->getClass($bindScopeClassName));
13471361
}
1362+
if ($this->isInClass()) {
1363+
if ($this->inClosureBindScopeClasses !== [] && $this->inClosureBindScopeClasses !== ['static']) {
1364+
if ($this->reflectionProvider->hasClass($this->inClosureBindScopeClasses[0])) {
1365+
return new StaticType($this->reflectionProvider->getClass($this->inClosureBindScopeClasses[0]));
1366+
}
1367+
}
13481368

1349-
return new StaticType($this->getClassReflection());
1369+
return new StaticType($this->getClassReflection());
1370+
}
13501371
}
13511372

13521373
$originalClass = $this->resolveName($name);
1374+
if ($bindScopeClassName !== null && $this->reflectionProvider->hasClass($originalClass)) {
1375+
return new ObjectType($originalClass);
1376+
}
13531377
if ($this->isInClass()) {
13541378
if ($this->inClosureBindScopeClasses === [$originalClass]) {
13551379
if ($this->reflectionProvider->hasClass($originalClass)) {
@@ -1368,6 +1392,34 @@ public function resolveTypeByName(Name $name): TypeWithClassName
13681392
return new ObjectType($originalClass);
13691393
}
13701394

1395+
/**
1396+
* Resolves the class name that a `self`/`parent`/`static` node is bound to by a
1397+
* surrounding `Closure::bind()` call, annotated by {@see ClosureBindArgVisitor}. Returns
1398+
* null when the node is not inside a bound closure or the bind scope argument does not
1399+
* resolve to a single known class (e.g. the default "static" scope). This works even
1400+
* outside a class context, because the type of a bound closure's body is inferred in the
1401+
* enclosing scope where the closure-bind scope classes are not otherwise available.
1402+
*/
1403+
/** @return non-empty-string|null */
1404+
private function resolveClosureBindScopeClassName(Name $name): ?string
1405+
{
1406+
if (!$name->hasAttribute(ClosureBindArgVisitor::SCOPE_ATTRIBUTE_NAME)) {
1407+
return null;
1408+
}
1409+
1410+
$scopeArg = $name->getAttribute(ClosureBindArgVisitor::SCOPE_ATTRIBUTE_NAME);
1411+
if (!$scopeArg instanceof Expr) {
1412+
return null;
1413+
}
1414+
1415+
$objectClassNames = $this->getType($scopeArg)->getClassStringObjectType()->getObjectClassNames();
1416+
if (count($objectClassNames) !== 1) {
1417+
return null;
1418+
}
1419+
1420+
return $objectClassNames[0];
1421+
}
1422+
13711423
/**
13721424
* @api
13731425
* @param mixed $value

‎src/Parser/ClosureBindArgVisitor.php‎

Lines changed: 32 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
use function array_shift;
1414
use function array_unshift;
1515
use function count;
16+
use function spl_object_id;
1617

1718
#[AutowiredService]
1819
final class ClosureBindArgVisitor extends NodeVisitorAbstract
@@ -25,6 +26,27 @@ final class ClosureBindArgVisitor extends NodeVisitorAbstract
2526
/** @var list<?Expr> */
2627
private array $scopeStack = [];
2728

29+
/**
30+
* Maps the object id of an inline closure/arrow function passed as the 1st argument of
31+
* `Closure::bind()` to that call's scope argument (the 3rd argument, or null for the
32+
* default "static" scope). Only the closure body is rescoped, not the other arguments.
33+
*
34+
* @var array<int, ?Expr>
35+
*/
36+
private array $boundClosures = [];
37+
38+
#[Override]
39+
public function beforeTraverse(array $nodes): ?array
40+
{
41+
// This visitor is a shared service, so its per-file state must be reset for each
42+
// traversal. Otherwise object ids reused across files (spl_object_id() is only unique
43+
// among live objects) could match a stale entry and rescope unrelated nodes.
44+
$this->scopeStack = [];
45+
$this->boundClosures = [];
46+
47+
return null;
48+
}
49+
2850
#[Override]
2951
public function enterNode(Node $node): ?Node
3052
{
@@ -39,10 +61,17 @@ public function enterNode(Node $node): ?Node
3961
$args = $node->getArgs();
4062
if (count($args) > 1) {
4163
$args[0]->setAttribute(self::ATTRIBUTE_NAME, true);
64+
65+
$closure = $args[0]->value;
66+
if ($closure instanceof Expr\Closure || $closure instanceof Expr\ArrowFunction) {
67+
// null means default scope "static"
68+
$this->boundClosures[spl_object_id($closure)] = $args[2]->value ?? null;
69+
}
4270
}
71+
}
4372

44-
// null means default scope "static"
45-
array_unshift($this->scopeStack, $args[2]->value ?? null);
73+
if (array_key_exists(spl_object_id($node), $this->boundClosures)) {
74+
array_unshift($this->scopeStack, $this->boundClosures[spl_object_id($node)]);
4675
}
4776

4877
if ($node instanceof Name
@@ -58,14 +87,7 @@ public function enterNode(Node $node): ?Node
5887
#[Override]
5988
public function leaveNode(Node $node): ?Node
6089
{
61-
if (
62-
$node instanceof Node\Expr\StaticCall
63-
&& $node->class instanceof Node\Name
64-
&& $node->class->toLowerString() === 'closure'
65-
&& $node->name instanceof Identifier
66-
&& $node->name->toLowerString() === 'bind'
67-
&& !$node->isFirstClassCallable()
68-
) {
90+
if (array_key_exists(spl_object_id($node), $this->boundClosures)) {
6991
array_shift($this->scopeStack);
7092
}
7193

‎src/Rules/Classes/InstantiationRule.php‎

Lines changed: 44 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44

55
use PhpParser\Node;
66
use PhpParser\Node\Expr\New_;
7+
use PHPStan\Analyser\ClosureBindScopeResolver;
78
use PHPStan\Analyser\CollectedDataEmitter;
89
use PHPStan\Analyser\NodeCallbackInvoker;
910
use PHPStan\Analyser\Scope;
@@ -57,6 +58,7 @@ public function __construct(
5758
private ClassNameCheck $classCheck,
5859
private RuleLevelHelper $ruleLevelHelper,
5960
private ConsistentConstructorHelper $consistentConstructorHelper,
61+
private ClosureBindScopeResolver $closureBindScopeResolver,
6062
#[AutowiredParameter(ref: '%featureToggles.newOnNonObject%')]
6163
private bool $newOnNonObject,
6264
#[AutowiredParameter(ref: '%tips.discoveringSymbols%')]
@@ -126,8 +128,15 @@ private function checkClassName(string $class, bool $isName, Node $node, Scope&N
126128
$lowercasedClass = strtolower($class);
127129
$messages = [];
128130
$isStatic = false;
131+
$bindScopeClassReflection = $node->class instanceof Node\Name
132+
? $this->closureBindScopeResolver->resolveScopeClass($scope, $node->class)
133+
: null;
129134
if ($lowercasedClass === 'static') {
130-
if (!$scope->isInClass()) {
135+
if ($bindScopeClassReflection !== null) {
136+
$classReflection = $bindScopeClassReflection;
137+
} elseif ($scope->isInClass()) {
138+
$classReflection = $scope->getClassReflection();
139+
} else {
131140
return [
132141
RuleErrorBuilder::message(sprintf('Using %s outside of class scope.', $class))
133142
->identifier('outOfClass.static')
@@ -136,7 +145,6 @@ private function checkClassName(string $class, bool $isName, Node $node, Scope&N
136145
}
137146

138147
$isStatic = true;
139-
$classReflection = $scope->getClassReflection();
140148
if (!$classReflection->isFinal()) {
141149
if (!$classReflection->hasConstructor()) {
142150
return [];
@@ -154,33 +162,48 @@ private function checkClassName(string $class, bool $isName, Node $node, Scope&N
154162
}
155163
}
156164
} elseif ($lowercasedClass === 'self') {
157-
if (!$scope->isInClass()) {
165+
if ($bindScopeClassReflection !== null) {
166+
$classReflection = $bindScopeClassReflection;
167+
} elseif ($scope->isInClass()) {
168+
$classReflection = $scope->getClassReflection();
169+
} else {
158170
return [
159171
RuleErrorBuilder::message(sprintf('Using %s outside of class scope.', $class))
160172
->identifier('outOfClass.self')
161173
->build(),
162174
];
163175
}
164-
$classReflection = $scope->getClassReflection();
165176
} elseif ($lowercasedClass === 'parent') {
166-
if (!$scope->isInClass()) {
167-
return [
168-
RuleErrorBuilder::message(sprintf('Using %s outside of class scope.', $class))
169-
->identifier('outOfClass.parent')
170-
->build(),
171-
];
172-
}
173-
if ($scope->getClassReflection()->getParentClass() === null) {
174-
return [
175-
RuleErrorBuilder::message(sprintf(
176-
'%s::%s() calls new parent but %s does not extend any class.',
177-
$scope->getClassReflection()->getDisplayName(),
178-
$scope->getFunctionName(),
179-
$scope->getClassReflection()->getDisplayName(),
180-
))->identifier('class.noParent')->build(),
181-
];
177+
if ($bindScopeClassReflection !== null) {
178+
if ($bindScopeClassReflection->getParentClass() === null) {
179+
return [
180+
RuleErrorBuilder::message(sprintf(
181+
'Using new parent but %s does not extend any class.',
182+
$bindScopeClassReflection->getDisplayName(),
183+
))->identifier('class.noParent')->build(),
184+
];
185+
}
186+
$classReflection = $bindScopeClassReflection->getParentClass();
187+
} else {
188+
if (!$scope->isInClass()) {
189+
return [
190+
RuleErrorBuilder::message(sprintf('Using %s outside of class scope.', $class))
191+
->identifier('outOfClass.parent')
192+
->build(),
193+
];
194+
}
195+
if ($scope->getClassReflection()->getParentClass() === null) {
196+
return [
197+
RuleErrorBuilder::message(sprintf(
198+
'%s::%s() calls new parent but %s does not extend any class.',
199+
$scope->getClassReflection()->getDisplayName(),
200+
$scope->getFunctionName(),
201+
$scope->getClassReflection()->getDisplayName(),
202+
))->identifier('class.noParent')->build(),
203+
];
204+
}
205+
$classReflection = $scope->getClassReflection()->getParentClass();
182206
}
183-
$classReflection = $scope->getClassReflection()->getParentClass();
184207
} else {
185208
if (!$this->reflectionProvider->hasClass($class)) {
186209
if ($scope->isInClassExists($class)) {

0 commit comments

Comments
 (0)