PHPackages laravel2580/idehelpers - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Utility & Helpers](/categories/utility) 4. / 5. laravel2580/idehelpers ActiveLibrary[Utility & Helpers](/categories/utility) laravel2580/idehelpers ====================== Laravel IDE Helper, generates correct PHPDocs for all Facade classes, to improve auto-completion. v2.2.1(9y ago)031MITPHPPHP >=5.4.0 Since May 23Pushed 9y agoCompare [ Source](https://github.com/laravel2580/idehelpers)[ Packagist](https://packagist.org/packages/laravel2580/idehelpers)[ RSS](/packages/laravel2580-idehelpers/feed)WikiDiscussions master Synced 4w ago READMEChangelogDependencies (9)Versions (56)Used By (0) Laravel 5 IDE Helper Generator ------------------------------ [](#laravel-5-ide-helper-generator) [![Latest Version on Packagist](https://camo.githubusercontent.com/a801c9fdf0a71f0fc95b2b7d38298264f6b8f51fe1b99526b8778c9a8f5dbfb0/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f62617272797664682f6c61726176656c2d6964652d68656c7065722e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/barryvdh/laravel-ide-helper)[![Software License](https://camo.githubusercontent.com/55c0218c8f8009f06ad4ddae837ddd05301481fcf0dff8e0ed9dadda8780713e/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d627269676874677265656e2e7376673f7374796c653d666c61742d737175617265)](LICENSE.md)[![Build Status](https://camo.githubusercontent.com/bf89cc6705a844f061964c9e10f6ee9b30bf39432dd797764a4f9219ffc734b2/68747470733a2f2f696d672e736869656c64732e696f2f7472617669732f62617272797664682f6c61726176656c2d6964652d68656c7065722f6d61737465722e7376673f7374796c653d666c61742d737175617265)](https://travis-ci.org/barryvdh/laravel-ide-helper)[![Total Downloads](https://camo.githubusercontent.com/805ee28f68c4d58860775098a16ccea9c7a41887d2565b986573092c81219cb6/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f62617272797664682f6c61726176656c2d6964652d68656c7065722e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/barryvdh/laravel-ide-helper) **For Laravel 4.x, check [version 1.11](https://github.com/barryvdh/laravel-ide-helper/tree/1.11)** ### Complete phpDocs, directly from the source [](#complete-phpdocs-directly-from-the-source) *Checkout [this Laracasts video](https://laracasts.com/series/how-to-be-awesome-in-phpstorm/episodes/15) for a quick introduction/explanation!* - [`php artisan ide-helper:generate` - phpDoc generation for Laravel Facades ](#automatic-phpdoc-generation-for-laravel-facades) - [`php artisan ide-helper:models` - phpDocs for models](#automatic-phpdocs-for-models) - [`php artisan ide-helper:meta` - PhpStorm Meta file](#phpstorm-meta-for-container-instances) This package generates a file that your IDE understands, so it can provide accurate autocompletion. Generation is done based on the files in your project, so they are always up-to-date. If you don't want to generate it, you can add a pre-generated file to the root folder of your Laravel project (but this isn't as up-to-date as self generated files). - Generated version for L5: - Generated version for Lumen: - Generated Phpstorm Meta file: Note: You do need CodeIntel for Sublime Text: ### Install [](#install) Require this package with composer using the following command: ``` composer require barryvdh/laravel-ide-helper ``` After updating composer, add the service provider to the `providers` array in `config/app.php` ``` Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider::class, ``` ### Automatic phpDoc generation for Laravel Facades [](#automatic-phpdoc-generation-for-laravel-facades) You can now re-generate the docs yourself (for future updates) ``` php artisan ide-helper:generate ``` Note: `bootstrap/compiled.php` has to be cleared first, so run `php artisan clear-compiled` before generating (and `php artisan optimize` after). You can configure your composer.json to do this after each commit: ``` "scripts":{ "post-update-cmd": [ "Illuminate\\Foundation\\ComposerScripts::postUpdate", "php artisan ide-helper:generate", "php artisan ide-helper:meta", "php artisan optimize" ] }, ``` You can also publish the config file to change implementations (ie. interface to specific class) or set defaults for `--helpers` or `--sublime`. ``` php artisan vendor:publish --provider="Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider" --tag=config ``` The generator tries to identify the real class, but if it cannot be found, you can define it in the config file. Some classes need a working database connection. If you do not have a default working connection, some facades will not be included. You can use an in-memory SQLite driver, using the -M option. You can choose to include helper files. This is not enabled by default, but you can override it with the `--helpers (-H)` option. The `Illuminate/Support/helpers.php` is already set-up, but you can add/remove your own files in the config file. ### Automatic phpDocs for models [](#automatic-phpdocs-for-models) > You need to require `doctrine/dbal: ~2.3` in your own composer.json to get database columns. ``` composer require doctrine/dbal ``` If you don't want to write your properties yourself, you can use the command `php artisan ide-helper:models` to generate phpDocs, based on table columns, relations and getters/setters. You can write the comments directly to your Model file, using the `--write (-W)` option. By default, you are asked to overwrite or write to a separate file (`_ide_helper_models.php`). You can force No with `--nowrite (-N)`. Please make sure to backup your models, before writing the info. It should keep the existing comments and only append new properties/methods. The existing phpdoc is replaced, or added if not found. With the `--reset (-R)` option, the existing phpdocs are ignored, and only the newly found columns/relations are saved as phpdocs. ``` php artisan ide-helper:models Post ``` ``` /** * An Eloquent Model: 'Post' * * @property integer $id * @property integer $author_id * @property string $title * @property string $text * @property \Carbon\Carbon $created_at * @property \Carbon\Carbon $updated_at * @property-read \User $author * @property-read \Illuminate\Database\Eloquent\Collection|\Comment[] $comments */ ``` By default, models in `app/models` are scanned. The optional argument tells what models to use (also outside app/models). ``` php artisan ide-helper:models Post User ``` You can also scan a different directory, using the `--dir` option (relative from the base path): ``` php artisan ide-helper:models --dir="path/to/models" --dir="app/src/Model" ``` You can publish the config file (`php artisan vendor:publish`) and set the default directories. Models can be ignored using the `--ignore (-I)` option ``` php artisan ide-helper:models --ignore="Post,User" ``` Note: With namespaces, wrap your model name in " signs: `php artisan ide-helper:models "API\User"`, or escape the slashes (`Api\\User`) PhpStorm Meta for Container instances ------------------------------------- [](#phpstorm-meta-for-container-instances) It's possible to generate a PhpStorm meta file, to [add support for factory design pattern](https://confluence.jetbrains.com/display/PhpStorm/PhpStorm+Advanced+Metadata). For Laravel, this means we can make PhpStorm understand what kind of object we are resolving from the IoC Container. For example, `events` will return an `Illuminate\Events\Dispatcher` object, so with the meta file you can call `app('events')` and it will autocomplete the Dispatcher methods. ``` php artisan ide-helper:meta ``` ``` app('events')->fire(); \App::make('events')->fire(); /** @var \Illuminate\Foundation\Application $app */ $app->make('events')->fire(); // When the key is not found, it uses the argument as class name app('App\SomeClass'); ``` Pre-generated example: > Note: You might need to restart PhpStorm and make sure `.phpstorm.meta.php` is indexed. Note: When you receive a FatalException about a class that is not found, check your config (for example, remove S3 as cloud driver when you don't have S3 configured. Remove Redis ServiceProvider when you don't use it). ### License [](#license) The Laravel IDE Helper Generator is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT) ### Health Score 32 — LowBetter than 69% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity7 Limited adoption so far Community19 Small or concentrated contributor base Maturity72 Established project with proven stability Bus Factor1 Top contributor holds 90% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~21 days Recently: every ~48 days Total 54 Last Release 3647d ago Major Versions v1.11.3 → v2.0.02015-02-04 v1.11.4 → v2.0.12015-02-23 v1.11.6 → v2.0.32015-03-17 1.11.x-dev → v2.0.42015-06-08 PHP version history (2 changes)v1.0.0-beta1PHP >=5.3.0 v2.0.0PHP >=5.4.0 ### Community Maintainers ![](https://www.gravatar.com/avatar/c2f8824805ec65681aeeb22380d22392d978e0dc2c38cf42ff32c0091a49a987?d=identicon)[laravel2580](/maintainers/laravel2580) --- Top Contributors [![barryvdh](https://avatars.githubusercontent.com/u/973269?v=4)](https://github.com/barryvdh "barryvdh (324 commits)")[![claar](https://avatars.githubusercontent.com/u/402855?v=4)](https://github.com/claar "claar (3 commits)")[![danielboendergaard](https://avatars.githubusercontent.com/u/314877?v=4)](https://github.com/danielboendergaard "danielboendergaard (2 commits)")[![cnanney](https://avatars.githubusercontent.com/u/195134?v=4)](https://github.com/cnanney "cnanney (2 commits)")[![SebSept](https://avatars.githubusercontent.com/u/2592502?v=4)](https://github.com/SebSept "SebSept (2 commits)")[![bebnev](https://avatars.githubusercontent.com/u/8371521?v=4)](https://github.com/bebnev "bebnev (2 commits)")[![Flynsarmy](https://avatars.githubusercontent.com/u/334808?v=4)](https://github.com/Flynsarmy "Flynsarmy (2 commits)")[![GrahamCampbell](https://avatars.githubusercontent.com/u/2829600?v=4)](https://github.com/GrahamCampbell "GrahamCampbell (1 commits)")[![grrnikos](https://avatars.githubusercontent.com/u/3323561?v=4)](https://github.com/grrnikos "grrnikos (1 commits)")[![JonTheNiceGuy](https://avatars.githubusercontent.com/u/228671?v=4)](https://github.com/JonTheNiceGuy "JonTheNiceGuy (1 commits)")[![klaude](https://avatars.githubusercontent.com/u/45157?v=4)](https://github.com/klaude "klaude (1 commits)")[![koenhendriks](https://avatars.githubusercontent.com/u/4124579?v=4)](https://github.com/koenhendriks "koenhendriks (1 commits)")[![kravchenko-a](https://avatars.githubusercontent.com/u/7896122?v=4)](https://github.com/kravchenko-a "kravchenko-a (1 commits)")[![MalikinSergey](https://avatars.githubusercontent.com/u/8463996?v=4)](https://github.com/MalikinSergey "MalikinSergey (1 commits)")[![mattwells](https://avatars.githubusercontent.com/u/507858?v=4)](https://github.com/mattwells "mattwells (1 commits)")[![mdnsk](https://avatars.githubusercontent.com/u/4230254?v=4)](https://github.com/mdnsk "mdnsk (1 commits)")[![MrCue](https://avatars.githubusercontent.com/u/1507789?v=4)](https://github.com/MrCue "MrCue (1 commits)")[![nikolay-zakharov](https://avatars.githubusercontent.com/u/1189334?v=4)](https://github.com/nikolay-zakharov "nikolay-zakharov (1 commits)")[![Propaganistas](https://avatars.githubusercontent.com/u/6680176?v=4)](https://github.com/Propaganistas "Propaganistas (1 commits)")[![rdpascua](https://avatars.githubusercontent.com/u/2498246?v=4)](https://github.com/rdpascua "rdpascua (1 commits)") --- Tags phpdoclaravelautocompletehelperidephpstormnetbeanssublimecodeintel ### Code Quality TestsPHPUnit Code StylePHP\_CodeSniffer ### Embed Badge ![Health badge](/badges/laravel2580-idehelpers/health.svg) ``` [![Health](https://phpackages.com/badges/laravel2580-idehelpers/health.svg)](https://phpackages.com/packages/laravel2580-idehelpers) ``` ### Alternatives [barryvdh/laravel-ide-helper Laravel IDE Helper, generates correct PHPDocs for all Facade classes, to improve auto-completion. 14.9k129.4M833](/packages/barryvdh-laravel-ide-helper)[laravel/ai The official AI SDK for Laravel. 1.0k2.1M163](/packages/laravel-ai)[mis/yii2-ide-helper Yii2 IDE Helper, generates correct PHPDocs for all components, to improve auto-completion. 1465.9k3](/packages/mis-yii2-ide-helper)[soyhuce/next-ide-helper Laravel ide helper rebuilt under steroids 4860.1k3](/packages/soyhuce-next-ide-helper)[erag/laravel-lang-sync-inertia A powerful Laravel package for syncing and managing language translations across backend and Inertia.js (Vue/React) frontends, offering effortless localization, auto-sync features, and smooth multi-language support for modern Laravel applications. 4821.5k](/packages/erag-laravel-lang-sync-inertia) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)