feat: add parameter closure this extension #4273
Merged
+399
−5
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hello!
Summary
This PR introduces extension interfaces that allow PHPStan extensions to dynamically specify the
$this
context for closure parameters.Problem
Currently, PHPStan only supports static
@param-closure-this
PHPDoc annotations, which cannot handle dynamic scenarios where the closure's$this
type depends on runtime context. This particularly affects frameworks like PestPHP, which heavily rely on closures with dynamic$this
bindings, and cannot properly communicate type information to PHPStan.Real-world Example (PestPHP)
Solution
This PR adds three new extension interfaces that mirror the existing parameter type extensions:
FunctionParameterClosureThisExtension
- For function callsMethodParameterClosureThisExtension
- For method callsStaticMethodParameterClosureThisExtension
- For static method callsThese extensions can inspect the call context (AST nodes, scope, arguments) and return the appropriate
$this
type for the closure.Implementation Details
Architecture
The implementation follows PHPStan's established patterns with minimal invasiveness:
$this
typesphpstan.functionParameterClosureThisExtension
, etc.Usage Example
Here's a psuedo-code example of how PestPHP could use this feature:
Register in
phpstan.neon
:Thanks!