Skip to content

Introduce ClosureType::isStaticClosure() #5699

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
phpstan-bot wants to merge 13 commits into
base: 2.2.x
Choose a base branch
from
Open

Introduce ClosureType::isStaticClosure() #5699

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
0e1ed57
Introduce `ClosureType::isStaticClosure()` and narrow `Closure::bindT…
VincentLanglet May 18, 2026
fd3320f
Revert `Closure::bindTo()`/`Closure::bind()` return type narrowing fo…
phpstan-bot May 19, 2026
d5cc5af
Use hyphen in static closure prefix and extract `describeWithPrefix()…
phpstan-bot May 19, 2026
d46fa4b
Replace `describeWithPrefix()` string param with `showPure`/`showStat…
phpstan-bot May 19, 2026
2f91130
Remove named parameters from describeBody() calls
phpstan-bot May 19, 2026
9cafe35
Update AttributeReflectionTest expectations for static closures in at…
phpstan-bot May 19, 2026
0b8f923
Add test cases for static-pure-Closure describe output
phpstan-bot May 25, 2026
067c15c
Only show static- prefix for common callable closures in describe()
phpstan-bot May 25, 2026
d257b4a
Revert describeBody() extraction, inline static- prefix in isCommonCa…
phpstan-bot May 25, 2026
67616bd
simplify
staabm May 25, 2026
f108a0f
Show static- prefix in describe() at precise/cache levels, propagate …
phpstan-bot May 27, 2026
b086121
Add accepts/TypeCombinator/toPhpDocNode tests, update expectations fo…
phpstan-bot May 27, 2026
50a1b44
Remove isStatic from ClosureTypeFactory runtime reflection path
phpstan-bot May 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions src/Analyser/ExprHandler/Helper/ClosureTypeResolver.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -227,13 +227,15 @@ static function (Node $node, Scope $scope) use ($arrowScope, &$arrowFunctionImpu
usedVariables: $cachedClosureData['usedVariables'],
acceptsNamedArguments: TrinaryLogic::createYes(),
mustUseReturnValue: $mustUseReturnValue,
isStatic: TrinaryLogic::createFromBoolean($expr->static),
);
}
if (self::$resolveClosureTypeDepth >= 2) {
return new ClosureType(
$parameters,
$scope->getFunctionType($expr->returnType, false, false),
$isVariadic,
isStatic: TrinaryLogic::createFromBoolean($expr->static),
);
}

Expand Down Expand Up @@ -453,6 +455,7 @@ static function (Node $node, Scope $scope) use ($arrowScope, &$arrowFunctionImpu
usedVariables: $usedVariables,
acceptsNamedArguments: TrinaryLogic::createYes(),
mustUseReturnValue: $mustUseReturnValue,
isStatic: TrinaryLogic::createFromBoolean($expr->static),
);
}

Expand Down
8 changes: 7 additions & 1 deletion src/PhpDoc/TypeNodeResolver.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -421,6 +421,12 @@ private function resolveIdentifierTypeNode(IdentifierTypeNode $typeNode, NameSco
case 'pure-closure':
return ClosureType::createPure();

case 'static-closure':
return new ClosureType(isStatic: TrinaryLogic::createYes());

case 'static-pure-closure':
return new ClosureType(impurePoints: [], isStatic: TrinaryLogic::createYes());

case 'resource':
$type = $this->tryResolvePseudoTypeClassType($typeNode, $nameScope);

Expand Down Expand Up @@ -1083,7 +1089,7 @@ function (CallableTypeParameterNode $parameterNode) use ($nameScope, &$isVariadi
),
]);
} elseif ($mainType instanceof ClosureType) {
$closure = new ClosureType($parameters, $returnType, $isVariadic, $templateTypeMap, templateTags: $templateTags, impurePoints: $mainType->getImpurePoints(), invalidateExpressions: $mainType->getInvalidateExpressions(), usedVariables: $mainType->getUsedVariables(), acceptsNamedArguments: $mainType->acceptsNamedArguments(), mustUseReturnValue: $mainType->mustUseReturnValue());
$closure = new ClosureType($parameters, $returnType, $isVariadic, $templateTypeMap, templateTags: $templateTags, impurePoints: $mainType->getImpurePoints(), invalidateExpressions: $mainType->getInvalidateExpressions(), usedVariables: $mainType->getUsedVariables(), acceptsNamedArguments: $mainType->acceptsNamedArguments(), mustUseReturnValue: $mainType->mustUseReturnValue(), isStatic: $mainType->isStaticClosure());
if ($closure->isPure()->yes() && $returnType->isVoid()->yes()) {
return new ErrorType();
}
Expand Down
2 changes: 2 additions & 0 deletions src/Reflection/Callables/CallableParametersAcceptor.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,4 +60,6 @@ public function mustUseReturnValue(): TrinaryLogic;

public function getAsserts(): Assertions;

public function isStaticClosure(): TrinaryLogic;

}
5 changes: 5 additions & 0 deletions src/Reflection/Callables/FunctionCallableVariant.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,4 +179,9 @@ public function getAsserts(): Assertions
return $this->function->getAsserts();
}

public function isStaticClosure(): TrinaryLogic
{
return TrinaryLogic::createNo();
}

}
6 changes: 6 additions & 0 deletions src/Reflection/ExtendedCallableFunctionVariant.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ public function __construct(
private TrinaryLogic $acceptsNamedArguments,
private TrinaryLogic $mustUseReturnValue,
private ?Assertions $assertions = null,
private ?TrinaryLogic $isStatic = null,
)
{
parent::__construct(
Expand Down Expand Up @@ -92,4 +93,9 @@ public function getAsserts(): Assertions
return $this->assertions ?? Assertions::createEmpty();
}

public function isStaticClosure(): TrinaryLogic
{
return $this->isStatic ?? TrinaryLogic::createMaybe();
}

}
1 change: 1 addition & 0 deletions src/Reflection/GenericParametersAcceptorResolver.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,7 @@ public static function resolve(array $argTypes, ParametersAcceptor $parametersAc
$originalParametersAcceptor->acceptsNamedArguments(),
$originalParametersAcceptor->mustUseReturnValue(),
$originalParametersAcceptor->getAsserts(),
$originalParametersAcceptor->isStaticClosure(),
);
}

Expand Down
5 changes: 5 additions & 0 deletions src/Reflection/InaccessibleMethod.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,4 +98,9 @@ public function getAsserts(): Assertions
return Assertions::createEmpty();
}

public function isStaticClosure(): TrinaryLogic
{
return TrinaryLogic::createNo();
}

}
4 changes: 4 additions & 0 deletions src/Reflection/InitializerExprTypeResolver.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -263,6 +263,7 @@ public function getType(Expr $expr, InitializerExprContext $context): Type
TemplateTypeMap::createEmpty(),
TemplateTypeVarianceMap::createEmpty(),
acceptsNamedArguments: TrinaryLogic::createYes(),
isStatic: TrinaryLogic::createYes(),
);
}
if ($expr instanceof Expr\ArrayDimFetch && $expr->dim !== null) {
Expand Down Expand Up @@ -928,11 +929,13 @@ public function createFirstClassCallable(
$impurePoints = [];
$acceptsNamedArguments = TrinaryLogic::createYes();
$mustUseReturnValue = TrinaryLogic::createMaybe();
$isStaticClosure = TrinaryLogic::createMaybe();
if ($variant instanceof CallableParametersAcceptor) {
$throwPoints = $variant->getThrowPoints();
$impurePoints = $variant->getImpurePoints();
$acceptsNamedArguments = $variant->acceptsNamedArguments();
$mustUseReturnValue = $variant->mustUseReturnValue();
$isStaticClosure = $variant->isStaticClosure();
} elseif ($function !== null) {
$returnTypeForThrow = $variant->getReturnType();
$throwType = $function->getThrowType();
Expand Down Expand Up @@ -976,6 +979,7 @@ public function createFirstClassCallable(
acceptsNamedArguments: $acceptsNamedArguments,
mustUseReturnValue: $mustUseReturnValue,
assertions: $assertions,
isStatic: $isStaticClosure,
);
}

Expand Down
4 changes: 4 additions & 0 deletions src/Reflection/ParametersAcceptorSelector.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -730,6 +730,7 @@ public static function combineAcceptors(array $acceptors): ExtendedParametersAcc
$usedVariables = [];
$acceptsNamedArguments = TrinaryLogic::createNo();
$mustUseReturnValue = TrinaryLogic::createMaybe();
$isStaticClosure = TrinaryLogic::createMaybe();

foreach ($acceptors as $acceptor) {
$returnTypes[] = $acceptor->getReturnType();
Expand All @@ -747,6 +748,7 @@ public static function combineAcceptors(array $acceptors): ExtendedParametersAcc
$usedVariables = array_merge($usedVariables, $acceptor->getUsedVariables());
$acceptsNamedArguments = $acceptsNamedArguments->or($acceptor->acceptsNamedArguments());
$mustUseReturnValue = $mustUseReturnValue->or($acceptor->mustUseReturnValue());
$isStaticClosure = $isStaticClosure->or($acceptor->isStaticClosure());
}
$isVariadic = $isVariadic || $acceptor->isVariadic();

Expand Down Expand Up @@ -864,6 +866,7 @@ public static function combineAcceptors(array $acceptors): ExtendedParametersAcc
$usedVariables,
$acceptsNamedArguments,
$mustUseReturnValue,
isStatic: $isStaticClosure,
);
}

Expand Down Expand Up @@ -902,6 +905,7 @@ private static function wrapAcceptor(ParametersAcceptor $acceptor): ExtendedPara
$acceptor->acceptsNamedArguments(),
$acceptor->mustUseReturnValue(),
$acceptor->getAsserts(),
$acceptor->isStaticClosure(),
);
}

Expand Down
6 changes: 6 additions & 0 deletions src/Reflection/ResolvedFunctionVariantWithCallable.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ public function __construct(
private TrinaryLogic $acceptsNamedArguments,
private TrinaryLogic $mustUseReturnValue,
private ?Assertions $assertions = null,
private ?TrinaryLogic $isStatic = null,
)
{
}
Expand Down Expand Up @@ -124,4 +125,9 @@ public function getAsserts(): Assertions
return $this->assertions ?? Assertions::createEmpty();
}

public function isStaticClosure(): TrinaryLogic
{
return $this->isStatic ?? TrinaryLogic::createMaybe();
}

}
5 changes: 5 additions & 0 deletions src/Reflection/TrivialParametersAcceptor.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,4 +108,9 @@ public function getAsserts(): Assertions
return Assertions::createEmpty();
}

public function isStaticClosure(): TrinaryLogic
{
return TrinaryLogic::createMaybe();
}

}
1 change: 1 addition & 0 deletions src/Rules/RuleLevelHelper.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,7 @@ private function transformAcceptedType(Type $acceptingType, Type $acceptedType):
$acceptedType->getUsedVariables(),
$acceptedType->acceptsNamedArguments(),
$acceptedType->mustUseReturnValue(),
isStatic: $acceptedType->isStaticClosure(),
);
}

Expand Down
5 changes: 5 additions & 0 deletions src/Type/CallableType.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -404,6 +404,11 @@ public function getAsserts(): Assertions
return Assertions::createEmpty();
}

public function isStaticClosure(): TrinaryLogic
{
return TrinaryLogic::createMaybe();
}

public function toNumber(): Type
{
return new ErrorType();
Expand Down
7 changes: 7 additions & 0 deletions src/Type/CallableTypeHelper.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,13 @@ public static function isParametersAcceptorSuperTypeOf(
$result = $result->and(new IsSuperTypeOfResult($theirs->isPure()->negate(), []));
}

$ourStatic = $ours->isStaticClosure();
if ($ourStatic->yes()) {
$result = $result->and(new IsSuperTypeOfResult($theirs->isStaticClosure(), []));
} elseif ($ourStatic->no()) {
$result = $result->and(new IsSuperTypeOfResult($theirs->isStaticClosure()->negate(), []));
}

return $result->and($isReturnTypeSuperType);
}

Expand Down
87 changes: 60 additions & 27 deletions src/Type/ClosureType.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,8 @@ class ClosureType implements TypeWithClassName, CallableParametersAcceptor

private Assertions $assertions;

private TrinaryLogic $isStatic;

/**
* @api
* @param list<ParameterReflection>|null $parameters
Expand All @@ -112,6 +114,7 @@ public function __construct(
?TrinaryLogic $acceptsNamedArguments = null,
?TrinaryLogic $mustUseReturnValue = null,
?Assertions $assertions = null,
?TrinaryLogic $isStatic = null,
)
{
if ($acceptsNamedArguments === null) {
Expand All @@ -132,6 +135,7 @@ public function __construct(
$this->callSiteVarianceMap = $callSiteVarianceMap ?? TemplateTypeVarianceMap::createEmpty();
$this->impurePoints = $impurePoints ?? [new SimpleImpurePoint('functionCall', 'call to an unknown Closure', false)];
$this->assertions = $assertions ?? Assertions::createEmpty();
$this->isStatic = $isStatic ?? TrinaryLogic::createMaybe();
}

public function getAsserts(): Assertions
Expand Down Expand Up @@ -268,7 +272,8 @@ public function equals(Type $type): bool
}

return $this->describe(VerbosityLevel::precise()) === $type->describe(VerbosityLevel::precise())
&& $this->isPure()->equals($type->isPure());
&& $this->isPure()->equals($type->isPure())
&& $this->isStatic->equals($type->isStatic);
Copy link
Copy Markdown
Contributor

@staabm staabm May 25, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not sure about this addition.

I think its common to pass a static closure into a function expecting a non-static one.

Copy link
Copy Markdown
Collaborator Author

@phpstan-bot phpstan-bot May 25, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The branch is clean and up to date. No code changes are needed for this review comment. Here's the analysis:

The isStatic check in equals() is correct and consistent with the existing pattern. The equals() method checks type identity (are these the exact same type?), not assignability (can one be used where the other is expected?). The isPure() check — already present before this PR — follows the exact same pattern: two closures with different purity are not equal types, even though a pure closure can be passed where an impure one is expected.

The reviewer's concern about assignability is already handled by isSuperTypeOf(). The CallableTypeHelper::isParametersAcceptorSuperTypeOf() logic and the isSuperTypeOf tests show:

  • maybe-static closure (the default for PHPDoc Closure types) accepts both static and non-static closures
  • Only explicitly non-static closure types reject static closures, which is correct: a function that explicitly requires a non-static closure may intend to bindTo() it, and bindTo() returns null for static closures

In practice, function parameters typed via PHPDoc as Closure(): void are always maybe-static, so passing a static closure is accepted. The strict isSuperTypeOf() check only triggers between two code-inferred closures with known static-ness.

}

public function describe(VerbosityLevel $level): string
Expand All @@ -277,38 +282,57 @@ public function describe(VerbosityLevel $level): string
static fn (): string => 'Closure',
function (): string {
if ($this->isCommonCallable) {
return $this->isPure()->yes() ? 'pure-Closure' : 'Closure';
$prefix = $this->isStatic->yes() ? 'static-' : '';
$name = $this->isPure()->yes() ? 'pure-Closure' : 'Closure';
return $prefix . $name;
Copy link
Copy Markdown
Member

@ondrejmirtes ondrejmirtes May 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also needs to be in toPhpDocNode which needs a test in TypeToPhpDocNodeTest.

Also the $this->isStatic needs to be passed to all new self in this class.

Also all new ClosureType need to be reviewed and decided whether we can pass a meaningful value to the new constructor parameter.

Copy link
Copy Markdown
Collaborator Author

@phpstan-bot phpstan-bot May 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All tasks complete. Here's a summary of what was done to address the review:

Changes made (2 commits pushed):

Commit 1: Core code changes

  • ClosureType::describe(): Added precise/cache callback that shows static- prefix for ALL closures (not just common callable) when isStatic->yes(). Extracted describeCallable() private method to avoid duplication.
  • ClosureType::toPhpDocNode(): Added static- prefix for common callable closures (e.g., static-Closure, static-pure-Closure).
  • ClosureType::describe() new self(): Now passes $this->assertions and $this->isStatic to the inner copy.
  • InitializerExprTypeResolver: Passes isStatic from $variant->isStaticClosure() when constructing ClosureTypes from function variants.
  • ClosureTypeFactory: Passes isStatic from $closureReflectionFunction->isStatic() when constructing ClosureTypes from runtime reflection.
  • TypeNodeResolver: Added parsing support for static-closure and static-pure-closure identifiers.
  • VerbosityLevel::getRecommendedLevelByType(): Bumps to precise level when a ClosureType has definite isStatic (yes or no), so error messages can distinguish static from non-static closures.

Commit 2: Tests

  • ClosureTypeTest: Added dataAccepts/testAccepts with 8 test cases covering all static/non-static/maybe-static combinations.
  • TypeCombinatorTest: Added union tests (4 cases) and intersect tests (4 cases) for static closure combinations.
  • TypeToPhpDocNodeTest: Added round-trip tests for static-Closure, static-pure-Closure, pure-Closure, and Closure.
  • Updated test expectations: closure-static-type.php, bug-7031.php, bug-9764.php, degrade-closures.php, bug-14324.php now expect static- prefix on static closures at precise verbosity level.

All 12222 tests pass and make phpstan reports 0 errors.

}

$printer = new Printer();
$selfWithoutParameterNames = new self(
array_map(static fn (ParameterReflection $p): ParameterReflection => new DummyParameter(
'',
$p->getType(),
optional: $p->isOptional() && !$p->isVariadic(),
passedByReference: PassedByReference::createNo(),
variadic: $p->isVariadic(),
defaultValue: $p->getDefaultValue(),
), $this->parameters),
$this->returnType,
$this->variadic,
$this->templateTypeMap,
$this->resolvedTemplateTypeMap,
$this->callSiteVarianceMap,
$this->templateTags,
$this->throwPoints,
$this->impurePoints,
$this->invalidateExpressions,
$this->usedVariables,
$this->acceptsNamedArguments,
$this->mustUseReturnValue,
);
return $this->describeCallable();
},
function (): string {
$prefix = $this->isStatic->yes() ? 'static-' : '';

if ($this->isCommonCallable) {
$name = $this->isPure()->yes() ? 'pure-Closure' : 'Closure';
return $prefix . $name;
}

return $printer->print($selfWithoutParameterNames->toPhpDocNode());
return $prefix . $this->describeCallable();
},
);
}

private function describeCallable(): string
{
$printer = new Printer();
$selfWithoutParameterNames = new self(
array_map(static fn (ParameterReflection $p): ParameterReflection => new DummyParameter(
'',
$p->getType(),
optional: $p->isOptional() && !$p->isVariadic(),
passedByReference: PassedByReference::createNo(),
variadic: $p->isVariadic(),
defaultValue: $p->getDefaultValue(),
), $this->parameters),
$this->returnType,
$this->variadic,
$this->templateTypeMap,
$this->resolvedTemplateTypeMap,
$this->callSiteVarianceMap,
$this->templateTags,
$this->throwPoints,
$this->impurePoints,
$this->invalidateExpressions,
$this->usedVariables,
$this->acceptsNamedArguments,
$this->mustUseReturnValue,
$this->assertions,
$this->isStatic,
);

return $printer->print($selfWithoutParameterNames->toPhpDocNode());
}

public function isOffsetAccessLegal(): TrinaryLogic
{
return TrinaryLogic::createNo();
Expand Down Expand Up @@ -496,6 +520,11 @@ public function mustUseReturnValue(): TrinaryLogic
return $this->mustUseReturnValue;
}

public function isStaticClosure(): TrinaryLogic
{
return $this->isStatic;
}

public function isCloneable(): TrinaryLogic
{
return TrinaryLogic::createYes();
Expand Down Expand Up @@ -709,6 +738,7 @@ public function traverse(callable $cb): Type
$this->acceptsNamedArguments,
$this->mustUseReturnValue,
$this->assertions,
$this->isStatic,
);
}

Expand Down Expand Up @@ -761,6 +791,7 @@ public function traverseSimultaneously(Type $right, callable $cb): Type
$this->acceptsNamedArguments,
$this->mustUseReturnValue,
$this->assertions,
$this->isStatic,
);
}

Expand Down Expand Up @@ -897,7 +928,9 @@ public function getFiniteTypes(): array
public function toPhpDocNode(): TypeNode
{
if ($this->isCommonCallable) {
return new IdentifierTypeNode($this->isPure()->yes() ? 'pure-Closure' : 'Closure');
$prefix = $this->isStatic->yes() ? 'static-' : '';
$name = $this->isPure()->yes() ? 'pure-Closure' : 'Closure';
return new IdentifierTypeNode($prefix . $name);
}

$parameters = [];
Expand Down
1 change: 1 addition & 0 deletions src/Type/Php/ClosureFromCallableDynamicReturnTypeExtension.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ public function getTypeFromStaticMethodCall(MethodReflection $methodReflection,
usedVariables: $variant->getUsedVariables(),
acceptsNamedArguments: $variant->acceptsNamedArguments(),
mustUseReturnValue: $variant->mustUseReturnValue(),
isStatic: $variant->isStaticClosure(),
);
}

Expand Down
5 changes: 5 additions & 0 deletions src/Type/VerbosityLevel.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,11 @@ public static function getRecommendedLevelByType(Type $acceptingType, ?Type $acc
if ($type->isCallable()->yes()) {
$moreVerbose = true;

if ($type instanceof ClosureType && !$type->isStaticClosure()->maybe()) {
$veryVerbose = true;
return $type;
}

// Keep checking if we need to be very verbose.
return $traverse($type);
}
Expand Down
Loading
Loading