Weave Code
Reflection Laravel Package
phpdocumentor/reflection
Static PHP code reflection library that parses files without executing them. Builds an object graph of your project’s structure, including DocBlocks. Can analyze code from PHP 5.2 up to your installed version; suitable for reflecting whole files or projects.
Reflection library to do Static Analysis for PHP Projects
Frequently asked questions about Reflection
- Can I use phpdocumentor/reflection to analyze Laravel’s Eloquent models and service providers without executing them?
- Yes, this package performs static reflection, so it inspects Eloquent models and service providers without executing any procedural code. It builds an object graph of classes, properties, and methods, including DocBlock annotations, making it ideal for Laravel’s static analysis needs like dependency mapping or dead-code detection.
- How do I install phpdocumentor/reflection in a Laravel project?
- Run `composer require phpdocumentor/reflection` in your Laravel project’s root directory. No additional configuration is needed for basic usage, as it works with Laravel’s default PSR-4 autoloader. For advanced use cases, you may need to manually include Blade-compiled files or preprocess templates.
- Does phpdocumentor/reflection support Laravel’s Blade templates or dynamic facades?
- No, this package does not natively parse Blade syntax or runtime-generated code like dynamic facades. For Blade templates, preprocess them into PHP using `laravel-blade-compiler` or manually include compiled files. Dynamic features (e.g., late-static binding) require custom reducers or post-processing.
- What Laravel versions and PHP versions does phpdocumentor/reflection support?
- The package supports PHP 5.2 through your installed PHP version (e.g., 8.4+). For Laravel, it works with any version since it’s framework-agnostic, but ensure compatibility with your PHP version (e.g., PHP 8.5+ requires v6.4.2+). Laravel’s PHP version constraints apply—check your `composer.json` for alignment.
- How can I integrate this into Laravel’s Artisan commands for CI/CD checks?
- Wrap the library in a custom Artisan command (e.g., `php artisan reflect:analyze`). Use it to validate coding standards, type safety, or generate IDE metadata. For CI/CD, run the command in GitHub Actions or GitLab CI as a pre-commit or post-merge check. Cache results in a database if analyzing large codebases repeatedly.
- Will this package slow down my Laravel application in production?
- No, static reflection runs during development or build-time, not in production. It avoids runtime overhead entirely. For large projects, process files incrementally or cache results to minimize memory usage. Use it for tooling (e.g., IDE helpers) or pre-runtime validation, not runtime logic.
- Can I use phpdocumentor/reflection to generate PHPStorm metadata files dynamically?
- Yes, the package’s object graph includes class/method details and DocBlocks, which you can serialize into `.phpstorm.meta.php` files. Integrate it with Laravel’s IDE Helper (e.g., `barryvdh/laravel-ide-helper`) or build a custom Artisan command to auto-generate metadata on demand.
- How does this compare to PHP’s built-in Reflection API for Laravel?
- Unlike PHP’s dynamic Reflection, this library performs static analysis—no code execution, lower memory usage, and safer for unknown codebases. It also parses DocBlock contents fully, not just their presence. Use dynamic Reflection for runtime introspection (e.g., service containers) and static Reflection for tooling or validation.
- Are there alternatives for Laravel-specific static analysis?
- For Laravel, consider `phpstan/extension-installer` (for PHPStan) or `vimeo/psalm` (for Psalm), which offer Laravel-specific rules. However, `phpdocumentor/reflection` is more lightweight and framework-agnostic. Use it for custom analysis (e.g., dependency mapping) or pair it with existing tools for broader coverage.
- How do I handle custom attributes (e.g., Laravel’s #[Route]) with this package?
- The package supports basic attribute reflection, but Laravel-specific attributes (e.g., `#[Route]`) may require custom reducers or post-processing. Parse the attribute’s DocBlock or use a reducer to extract custom metadata. For advanced use cases, combine it with Laravel’s runtime reflection or a preprocessor.
Weaver
How can I help you explore Laravel packages today?