Download the PHP package lara-igniter/laraigniter-ide-helper without Composer
On this page you can find all versions of the php package lara-igniter/laraigniter-ide-helper. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download lara-igniter/laraigniter-ide-helper
More information about lara-igniter/laraigniter-ide-helper
Files in lara-igniter/laraigniter-ide-helper
Package laraigniter-ide-helper
Short Description IDE Helper for Laraigniter — generates PHPDoc and PhpStorm meta files for better autocomplete.
License MIT
Homepage https://github.com/lara-igniter/laraigniter-ide-helper
Informations about the package laraigniter-ide-helper
lara-igniter/laraigniter-ide-helper
Generates IDE helper files for Laraigniter applications — PHPDoc for facades and models, plus PhpStorm .phpstorm.meta.php metadata for autocomplete on view(), route(), config(), and env().
Requires lara-igniter/framework ^1.51.
Installation
Register the provider in config/hooks.php when package discovery is disabled:
Publish config (optional):
Local checkout (path repository)
Usage
Automatic PHPDoc generation for Laraigniter Facades
You can re-generate facade docs yourself whenever facades or their underlying services change:
This writes _ide_helper.php in your project root. Your IDE parses that file for autocomplete — it is not loaded by the application. Change the output name via the filename key in config/ide-helper.php, or pass --filename=custom.php on the command line.
Include framework helper functions in the output (optional):
Or set include_helpers to true in the config (equivalent to always passing --helpers).
Run generation automatically after every composer update by adding scripts to your app's composer.json:
Publish the config file to customize facade aliases, output paths, or helper defaults:
This copies config/ide-helper.php into your application. Edit the published file — your values override the package defaults.
Commands
| Command | Output | Description |
|---|---|---|
php artisan ide-helper:generate |
_ide_helper.php |
Facade PHPDoc stubs |
php artisan ide-helper:models |
_ide_helper_models.php |
Model @property / @property-read docs |
php artisan ide-helper:meta |
.phpstorm.meta.php |
PhpStorm meta for helpers and facades |
Options
generate
models
Builds annotations from $fillable, $casts, and $hasOne / $hasMany / $hasManyPivot on Elegant\Database\Model\Model subclasses.
meta
Generated files
These files are for the IDE only — do not include them in runtime code.
| File | Purpose |
|---|---|
_ide_helper.php |
Facade method stubs |
_ide_helper_models.php |
Model property and relation hints |
.phpstorm.meta.php |
View, route, config, and env autocomplete |
Regenerate after changing models, routes, views, or facades.
Configuration
Defaults: config/ide-helper.php in this package. Override by publishing to your app's config/ide-helper.php.
| Key | Default | Description |
|---|---|---|
filename |
_ide_helper.php |
Facade helper path |
models_filename |
_ide_helper_models.php |
Model helper path |
meta_filename |
.phpstorm.meta.php |
Meta file path |
model_locations |
[app/Models] |
Model scan directories (set at boot) |
ignored_models |
base Model class |
Excluded models |
model_namespace |
App\Models\ |
Namespace for short relation names |
facades |
Blade, Gate, Route, View, … | Facade map for generate |
read_facades_from_hooks |
true |
Merge aliases from config/hooks.php |
include_helpers |
false |
Embed helper files in output |
type_overrides |
integer → int, etc. |
Cast to PHPDoc type map |
user_model |
App\Models\User |
User model class |
Requirements
- PHP ^7.4
lara-igniter/framework^1.51- Laraigniter CLI (
php artisan)
License
MIT — see LICENSE.md.
All versions of laraigniter-ide-helper with dependencies
ext-json Version *
lara-igniter/framework Version ^1.51
symfony/finder Version ^5.1