Weave Code
Shim Laravel Package
phpdocumentor/shim
Composer shim to install phpDocumentor as a PHAR. Downloads the official release PHAR from the main phpDocumentor repo and places it in vendor/bin for easy use in your project. Use main repo for bleeding-edge versions and issue tracking.
phpDocumentor phar as composer package
Frequently asked questions about Shim
- Can I use phpdocumentor/shim in Laravel without upgrading PHP?
- No, this package requires PHP 8.1+ due to phpDocumentor v3.10.0 dropping support for older versions. If your Laravel project uses PHP 8.0 or below, pin to `phpdocumentor/shim@^3.9` instead.
- How do I install phpdocumentor/shim for Laravel documentation?
- Run `composer require --dev phpdocumentor/shim:^3` in your Laravel project. The PHAR will auto-install to `vendor/bin`, and you can use phpDocumentor via CLI commands like `vendor/bin/phpdoc`.
- Will this break my existing Laravel Artisan commands using phpDocumentor?
- Yes, if your custom commands rely on deprecated phpDocumentor APIs (e.g., `Transformer` or event listeners), they’ll fail. Audit your code for removed classes and update to the new v3.10.0 syntax.
- Does phpdocumentor/shim support Laravel’s dev environment natively?
- Yes, it integrates seamlessly with Laravel’s Composer workflow. The PHAR is placed in `vendor/bin`, so it’s available globally in your project’s dev dependencies.
- How do I customize templates in phpDocumentor v3.10.0 for Laravel?
- Update your `phpdocumentor.dist.php` to use PSR-12 paths (e.g., `vendor/phpdocumentor/templates-twbsbootstrap`). The new release drops legacy paths like `templates/twbsbootstrap`.
- Can I use phpdocumentor/shim in CI/CD pipelines for faster doc generation?
- Yes, phpDocumentor v3.10.0 introduces parallel processing. Use the `--processes=4` flag in your CI script to reduce build times by up to 70%. Test with `vendor/bin/phpdoc --processes=4`.
- What’s the difference between phpdocumentor/shim and phpdocumentor/phpdocumentor?
- This package (`phpdocumentor/shim`) is a Composer-friendly wrapper for the official phpDocumentor PHAR, while `phpdocumentor/phpdocumentor` is the standalone library. Installing both may cause conflicts due to stricter versioning in v3.10.0.
- Are there Laravel-specific alternatives to phpdocumentor/shim?
- For Laravel, consider `ruudk/laravel-docgen` (simpler, Laravel-optimized) or `darkonline/l5-swagger` (API-focused). However, `phpdocumentor/shim` offers broader documentation flexibility if you need advanced features.
- How do I handle deprecated annotations (e.g., @deprecated) in phpDocumentor v3.10.0?
- Check the [phpDocumentor v3.10.0 release notes](https://github.com/phpDocumentor/phpDocumentor/releases) for annotation syntax changes. The new version improves handling but may require updates to your docblocks.
- Will this package work with Laravel Forge or Envoyer for production deployments?
- Yes, since it’s a Composer dependency, it’ll deploy via Forge/Envoyer like any other dev tool. Ensure your server meets PHP 8.1+ requirements and that `vendor/bin` is in your `$PATH` for CLI access.
Weaver
How can I help you explore Laravel packages today?