barryvdh/laravel-ide-helper 's direct dependencies. Data on all dependencies, including transitive ones, is available via CSV download.| Name | Version | Size | License | Type | Vulnerabilities |
|---|---|---|---|---|---|
| barryvdh/reflection-docblock | v2.1.1 | 36.79 kB | MIT | prod | |
| composer/composer | 2.7.6 | - | MIT | prod dev | |
| doctrine/dbal | 3.8.4 | - | MIT | prod dev | |
| illuminate/console | v8.83.27 | - | MIT | prod | |
| illuminate/filesystem | v8.83.27 | - | MIT | prod | |
| illuminate/support | v8.83.27 | 83.71 kB | MIT | prod | |
| nikic/php-parser | v4.19.1 | - | BSD-3-Clause | prod dev | |
| phpdocumentor/type-resolver | 1.8.2 | - | MIT | prod |
The barryvdh/laravel-ide-helper is an incredibly useful tool that assists Laravel developers by automatically generating helper files that enable your IDE (Integrated Development Environment) to provide accurate auto-completion. It is a way to create a more efficient and effective coding environment by providing complete PHPDocs, directly sourced from your Laravel project files. This ensures they always stay up-to-date. The package supports Laravel 8+ and PHP 7.3+, making it a versatile tool for most Laravel developers.
Using the Laravel IDE Helper is straightforward and can be summed up in a few steps. In your Laravel project, the package can be installed via composer using the command composer require --dev barryvdh/laravel-ide-helper. After the installation, you have access to several Artisan commands that aid in generating PHPDocs for various aspects of Laravel. Here are few examples:
php artisan ide-helper:generate
php artisan ide-helper:models
php artisan ide-helper:meta
The ide-helper:generate command helps in generating PHPDocs for Laravel Facades, while ide-helper:models helps in generating PHPDocs for models. In turn, the ide-helper:meta command generates PhpStorm Meta file.
The documentation for the Laravel IDE Helper package can be found on its GitHub page - https://github.com/barryvdh/laravel-ide-helper.git. The README file in the root directory contains all the necessary details regarding installation, usage, and even advanced features like PHPDoc generation for Laravel Fluent methods, Auto-completion for factory builders, and PhpStorm Meta for Container instances. For more project-specific settings, you can consider publishing the config file via php artisan vendor:publish --provider="Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider" --tag=config.
