If you like, you could set hints such as annotations to your model. they're dynamic accessors and won't be immediately recognized by PhpStorm (you'll see "Field accessed by magic method" in the tooltip). I haven't tried it, so I don't know how extensive it is.Īs far as model properties are concerned, you're right. This package can generate PHPDocs for macros and mixins which will be added to the _ide_helper.php file.īut this only works if you use type hinting when declaring a macro.Allegedly, the 8.0 version of PhpStorm (which is in Beta) will include Blade syntax. Automatic PHPDoc generation for macros and mixins The Illuminate/Support/helpers.php is already set up, but you can add/remove your own files in the config file. This is not enabled by default, but you can override it with the -helpers (-H) option. You can use an in-memory SQLite driver by adding the -M option. If you do not have a default working connection, some facades will not be included. Some classes need a working database connection. The generator tries to identify the real class, but if it cannot be found, you can define it in the config file. php artisan vendor:publish -provider= "Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider " -tag=config interface to specific class) or set defaults for -helpers. You can also publish the config file to change implementations (ie. You can configure your composer.json to do this each time you update your dependencies: "scripts": , You can use the config filename to change its name. This will generate the file _ide_helper.php which is expected to be additionally parsed by your IDE for autocomplete. Note: bootstrap/compiled.php has to be cleared first, so run php artisan clear-compiled before generating. You can now re-generate the docs yourself (for future updates) php artisan ide-helper:generate Note: You do need CodeComplice for Sublime Text: Automatic PHPDoc generation for Laravel Facades php artisan ide-helper:meta - PhpStorm Meta file.php artisan ide-helper:models - PHPDocs for models.php artisan ide-helper:generate - PHPDoc generation for Laravel Facades.Note: Avoid caching the configuration in your development environment, it may cause issues after installing this package respectively clear the cache beforehand via php artisan cache:clear if you encounter problems when running the commands UsageĬheck out this Laracasts video for a quick introduction/explanation! $ this-> app-> register(\ Barryvdh\ LaravelIdeHelper\ IdeHelperServiceProvider::class) If you want to manually load it only in non-production environments, instead you can add this to your AppServiceProvider with the register() method: Add the following class to the providers array in config/app.php:īarryvdh\ LaravelIdeHelper\ IdeHelperServiceProvider::class,.add the package to the -discover key in composer.json, e.g.If for some reason you want manually control this: This package makes use of Laravels package auto-discovery mechanism, which means if you don't install dev dependencies in production, it also won't be loaded. Require this package with composer using the following command: composer require -dev barryvdh/laravel-ide-helper Automatic PHPDocs generation for Laravel Fluent methods.Automatic PHPDoc generation for Laravel Facades.Generation is done based on the files in your project, so they are always up-to-date. This package generates helper files that enable your IDE to provide accurate autocompletion. Complete PHPDocs, directly from the source
0 Comments
Leave a Reply. |
Details
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |