Skip to content

Commit b9873db

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 #4081 on 2.2.x.
1 parent 38c1c81 commit b9873db

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
@@ -41,6 +41,7 @@
4141
use PHPStan\Node\IssetExpr;
4242
use PHPStan\Node\Printer\ExprPrinter;
4343
use PHPStan\Node\VirtualNode;
44+
use PHPStan\Parser\ClosureBindArgVisitor;
4445
use PHPStan\Parser\Parser;
4546
use PHPStan\Php\PhpVersion;
4647
use PHPStan\Php\PhpVersionFactory;
@@ -1433,8 +1434,22 @@ private function promoteNativeTypes(): self
14331434
public function resolveName(Name $name): string
14341435
{
14351436
$originalClass = (string) $name;
1437+
$lowerClass = strtolower($originalClass);
1438+
1439+
$bindScopeClassName = $this->resolveClosureBindScopeClassName($name);
1440+
if ($bindScopeClassName !== null) {
1441+
if (in_array($lowerClass, ['self', 'static'], true)) {
1442+
return $bindScopeClassName;
1443+
}
1444+
if ($lowerClass === 'parent' && $this->reflectionProvider->hasClass($bindScopeClassName)) {
1445+
$parentClassReflection = $this->reflectionProvider->getClass($bindScopeClassName)->getParentClass();
1446+
if ($parentClassReflection !== null) {
1447+
return $parentClassReflection->getName();
1448+
}
1449+
}
1450+
}
1451+
14361452
if ($this->isInClass()) {
1437-
$lowerClass = strtolower($originalClass);
14381453
if (in_array($lowerClass, [
14391454
'self',
14401455
'static',
@@ -1457,17 +1472,26 @@ public function resolveName(Name $name): string
14571472
/** @api */
14581473
public function resolveTypeByName(Name $name): TypeWithClassName
14591474
{
1460-
if ($name->toLowerString() === 'static' && $this->isInClass()) {
1461-
if ($this->inClosureBindScopeClasses !== [] && $this->inClosureBindScopeClasses !== ['static']) {
1462-
if ($this->reflectionProvider->hasClass($this->inClosureBindScopeClasses[0])) {
1463-
return new StaticType($this->reflectionProvider->getClass($this->inClosureBindScopeClasses[0]));
1464-
}
1475+
$bindScopeClassName = $this->resolveClosureBindScopeClassName($name);
1476+
if ($name->toLowerString() === 'static') {
1477+
if ($bindScopeClassName !== null && $this->reflectionProvider->hasClass($bindScopeClassName)) {
1478+
return new StaticType($this->reflectionProvider->getClass($bindScopeClassName));
14651479
}
1480+
if ($this->isInClass()) {
1481+
if ($this->inClosureBindScopeClasses !== [] && $this->inClosureBindScopeClasses !== ['static']) {
1482+
if ($this->reflectionProvider->hasClass($this->inClosureBindScopeClasses[0])) {
1483+
return new StaticType($this->reflectionProvider->getClass($this->inClosureBindScopeClasses[0]));
1484+
}
1485+
}
14661486

1467-
return new StaticType($this->getClassReflection());
1487+
return new StaticType($this->getClassReflection());
1488+
}
14681489
}
14691490

14701491
$originalClass = $this->resolveName($name);
1492+
if ($bindScopeClassName !== null && $this->reflectionProvider->hasClass($originalClass)) {
1493+
return new ObjectType($originalClass);
1494+
}
14711495
if ($this->isInClass()) {
14721496
if ($this->inClosureBindScopeClasses === [$originalClass]) {
14731497
if ($this->reflectionProvider->hasClass($originalClass)) {
@@ -1486,6 +1510,34 @@ public function resolveTypeByName(Name $name): TypeWithClassName
14861510
return new ObjectType($originalClass);
14871511
}
14881512

1513+
/**
1514+
* Resolves the class name that a `self`/`parent`/`static` node is bound to by a
1515+
* surrounding `Closure::bind()` call, annotated by {@see ClosureBindArgVisitor}. Returns
1516+
* null when the node is not inside a bound closure or the bind scope argument does not
1517+
* resolve to a single known class (e.g. the default "static" scope). This works even
1518+
* outside a class context, because the type of a bound closure's body is inferred in the
1519+
* enclosing scope where the closure-bind scope classes are not otherwise available.
1520+
*/
1521+
/** @return non-empty-string|null */
1522+
private function resolveClosureBindScopeClassName(Name $name): ?string
1523+
{
1524+
if (!$name->hasAttribute(ClosureBindArgVisitor::SCOPE_ATTRIBUTE_NAME)) {
1525+
return null;
1526+
}
1527+
1528+
$scopeArg = $name->getAttribute(ClosureBindArgVisitor::SCOPE_ATTRIBUTE_NAME);
1529+
if (!$scopeArg instanceof Expr) {
1530+
return null;
1531+
}
1532+
1533+
$objectClassNames = $this->getType($scopeArg)->getClassStringObjectType()->getObjectClassNames();
1534+
if (count($objectClassNames) !== 1) {
1535+
return null;
1536+
}
1537+
1538+
return $objectClassNames[0];
1539+
}
1540+
14891541
/**
14901542
* @api
14911543
* @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;
@@ -59,6 +60,7 @@ public function __construct(
5960
private ClassNameCheck $classCheck,
6061
private RuleLevelHelper $ruleLevelHelper,
6162
private ConsistentConstructorHelper $consistentConstructorHelper,
63+
private ClosureBindScopeResolver $closureBindScopeResolver,
6264
#[AutowiredParameter(ref: '%featureToggles.newOnNonObject%')]
6365
private bool $newOnNonObject,
6466
#[AutowiredParameter(ref: '%tips.discoveringSymbols%')]
@@ -128,8 +130,15 @@ private function checkClassName(string $class, bool $isName, Node $node, Scope&N
128130
$lowercasedClass = strtolower($class);
129131
$messages = [];
130132
$isStatic = false;
133+
$bindScopeClassReflection = $node->class instanceof Node\Name
134+
? $this->closureBindScopeResolver->resolveScopeClass($scope, $node->class)
135+
: null;
131136
if ($lowercasedClass === 'static') {
132-
if (!$scope->isInClass()) {
137+
if ($bindScopeClassReflection !== null) {
138+
$classReflection = $bindScopeClassReflection;
139+
} elseif ($scope->isInClass()) {
140+
$classReflection = $scope->getClassReflection();
141+
} else {
133142
return [
134143
RuleErrorBuilder::message(sprintf('Using %s outside of class scope.', $class))
135144
->identifier('outOfClass.static')
@@ -138,7 +147,6 @@ private function checkClassName(string $class, bool $isName, Node $node, Scope&N
138147
}
139148

140149
$isStatic = true;
141-
$classReflection = $scope->getClassReflection();
142150
if (!$classReflection->isFinal()) {
143151
if (!$classReflection->hasConstructor()) {
144152
return [];
@@ -156,33 +164,48 @@ private function checkClassName(string $class, bool $isName, Node $node, Scope&N
156164
}
157165
}
158166
} elseif ($lowercasedClass === 'self') {
159-
if (!$scope->isInClass()) {
167+
if ($bindScopeClassReflection !== null) {
168+
$classReflection = $bindScopeClassReflection;
169+
} elseif ($scope->isInClass()) {
170+
$classReflection = $scope->getClassReflection();
171+
} else {
160172
return [
161173
RuleErrorBuilder::message(sprintf('Using %s outside of class scope.', $class))
162174
->identifier('outOfClass.self')
163175
->build(),
164176
];
165177
}
166-
$classReflection = $scope->getClassReflection();
167178
} elseif ($lowercasedClass === 'parent') {
168-
if (!$scope->isInClass()) {
169-
return [
170-
RuleErrorBuilder::message(sprintf('Using %s outside of class scope.', $class))
171-
->identifier('outOfClass.parent')
172-
->build(),
173-
];
174-
}
175-
if ($scope->getClassReflection()->getParentClass() === null) {
176-
return [
177-
RuleErrorBuilder::message(sprintf(
178-
'%s::%s() calls new parent but %s does not extend any class.',
179-
$scope->getClassReflection()->getDisplayName(),
180-
$scope->getFunctionName(),
181-
$scope->getClassReflection()->getDisplayName(),
182-
))->identifier('class.noParent')->build(),
183-
];
179+
if ($bindScopeClassReflection !== null) {
180+
if ($bindScopeClassReflection->getParentClass() === null) {
181+
return [
182+
RuleErrorBuilder::message(sprintf(
183+
'Using new parent but %s does not extend any class.',
184+
$bindScopeClassReflection->getDisplayName(),
185+
))->identifier('class.noParent')->build(),
186+
];
187+
}
188+
$classReflection = $bindScopeClassReflection->getParentClass();
189+
} else {
190+
if (!$scope->isInClass()) {
191+
return [
192+
RuleErrorBuilder::message(sprintf('Using %s outside of class scope.', $class))
193+
->identifier('outOfClass.parent')
194+
->build(),
195+
];
196+
}
197+
if ($scope->getClassReflection()->getParentClass() === null) {
198+
return [
199+
RuleErrorBuilder::message(sprintf(
200+
'%s::%s() calls new parent but %s does not extend any class.',
201+
$scope->getClassReflection()->getDisplayName(),
202+
$scope->getFunctionName(),
203+
$scope->getClassReflection()->getDisplayName(),
204+
))->identifier('class.noParent')->build(),
205+
];
206+
}
207+
$classReflection = $scope->getClassReflection()->getParentClass();
184208
}
185-
$classReflection = $scope->getClassReflection()->getParentClass();
186209
} else {
187210
if (!$this->reflectionProvider->hasClass($class)) {
188211
if ($scope->isInClassExists($class)) {

0 commit comments

Comments
 (0)