mirror of
https://github.com/barryvdh/laravel-ide-helper.git
synced 2026-08-18 10:07:12 +00:00
38 lines
1.3 KiB
Markdown
38 lines
1.3 KiB
Markdown
## Laravel IDE Helper & Generator
|
|
|
|
### Complete phpDocs, directly from the source
|
|
|
|
Add the _IDE_helper.php to your laravel folder (not in a public folder). The file isn't used by Laravel, but it has to be indexed by your IDE.
|
|
The file has been tested in Netbeans 7.3 and PHPStorm 6.
|
|
|
|
### Automatic phpDoc generation for Laravel Facades
|
|
|
|
Require this package in your composer.json:
|
|
|
|
"barryvdh/laravel-ide-helper": "dev-master"
|
|
|
|
And add the ServiceProvider to the providers array in app/config/app.php
|
|
|
|
'Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider',
|
|
|
|
You can now re-generate the docs yourself (for future updates) in arisan
|
|
|
|
php artisan ide-helper:generate
|
|
|
|
You can also publish the config-file to add extra facades (ie. for bundles).
|
|
|
|
php artisan config:publish barryvdh/laravel-ide-helper
|
|
|
|
You can just add the Facade and the 'real' class, like the rest of the classes.
|
|
|
|
'Basset' => 'Basset\Basset',
|
|
|
|
You can choose to include helper files. This is not enabled by default, but you can override this with the --helpers (-H) or --nohelpers (-N) option.
|
|
The Illuminate/Support/helpers.php and laravel/framework/preload/compiled.php are already set-up, but you can add/remove your own files in the config file.
|
|
Using this option, allows you to have more complete code completion without having to include the vendor dir.
|
|
|
|
|
|
|
|
|
|
|