Weave Code
Better Reflection Laravel Package
roave/better-reflection
Enhanced PHP reflection for static analysis: reflect classes without loading them, from PHP code strings or closures, extract AST from functions/methods, and read type declarations and docblocks. Feature-rich but slower than native reflection.
Better Reflection - an improved code reflection API
Frequently asked questions about Better Reflection
- Can I use Roave/BetterReflection for runtime reflection in Laravel (e.g., service container inspection or dynamic method calls)?
- No, this package is **not** designed for runtime reflection. It’s significantly slower than PHP’s native Reflection API and lacks critical methods like `newInstance()` or `invoke()`. Use native reflection for runtime tasks like dependency injection or dynamic method calls in Laravel.
- How does Roave/BetterReflection compare to PHPStan or Psalm for Laravel static analysis?
- BetterReflection provides the underlying reflection capabilities that tools like PHPStan or Psalm rely on. It excels at static analysis tasks like inspecting unloaded classes, parsing closures, or extracting ASTs—making it a powerful foundation for custom Laravel validation or code quality tools.
- Will Roave/BetterReflection work with Laravel’s autoloader (Composer autoloader)?
- Yes, it integrates seamlessly with Laravel’s Composer autoloader out-of-the-box via `ComposerSourceLocator`. For non-standard paths (e.g., cached Blade templates or compiled views), you can use `SingleFileSourceLocator` to manually specify file locations.
- Does Roave/BetterReflection support PHP 8.1+ features like named arguments or attributes in Laravel?
- Yes, it supports modern PHP features, including attributes and named arguments. However, some edge cases (e.g., anonymous classes or traits) may require testing. Always validate results against native reflection for critical paths in Laravel.
- Can I use BetterReflection to analyze Eloquent models or dynamically generated classes in Laravel?
- Absolutely. BetterReflection can inspect Eloquent models, closures in service bindings, or even dynamically generated classes (e.g., API response DTOs). It’s ideal for custom validation logic or pre-processing logic before runtime, like optimizing queries via AST analysis.
- Is there a performance impact if I use BetterReflection in a Laravel IDE plugin or background task?
- Yes, BetterReflection is **slower** than native reflection. Use it only for static analysis tasks (e.g., CLI tools, background jobs, or IDE plugins) where performance isn’t critical. Avoid runtime usage in production or high-traffic Laravel applications.
- How do I extract the AST (Abstract Syntax Tree) of a Laravel route closure or middleware method?
- Use `BetterReflection` to reflect the closure or method, then call `getMethod()` or `getClosure()` followed by `getNode()` to retrieve the AST. This is useful for pre-processing routes or middleware before execution, such as validating logic or optimizing queries.
- Are there alternatives to Roave/BetterReflection for static analysis in Laravel?
- Yes, alternatives include `nikic/php-parser` (for parsing PHP code) or `phpstan/phpstan` (for static analysis rules). However, BetterReflection is more feature-rich for reflection tasks, like inspecting unloaded classes or closures, which are harder to replicate with other tools.
- How do I handle breaking changes if Laravel or PHP updates (e.g., PHP 9+ AST differences)?
- Monitor the [BetterReflection changelog](https://github.com/Roave/BetterReflection/releases) and test edge cases (e.g., anonymous classes, traits) early. For critical paths, implement a fallback to native reflection or use feature flags to isolate BetterReflection usage.
- Can I use BetterReflection to analyze compiled Blade templates or Laravel’s cached views?
- Yes, but you’ll need to use `SingleFileSourceLocator` to manually point to the compiled Blade files (e.g., `storage/framework/views/...`). This is useful for custom validation or debugging templates before they’re rendered in Laravel.
Weaver
How can I help you explore Laravel packages today?