Once the meta file is generated, PhpStorm can map container keys to specific class types. This works for both string keys and class name arguments.

Examples of supported patterns:

• Resolving by key: app('events') or \App::make('events').
• Resolving by class name: app('App\SomeClass') or app(App\SomeClass::class).
• Working with type-hinted variables: /** @var \Illuminate\Foundation\Application $app */ $app->make('events')->fire();

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');
// Also works with
app(App\SomeClass::class);

The PHP templates provided in this repository are derived from the official Laravel VS Code extension. They have been modified to behave differently for integration purposes:

1. They use return instead of echo to output content.
2. They do not serialize output to JSON.

The package can add PHPDocs for macros and mixins to the _ide_helper.php file. For this to work, you must use type hinting when declaring the macro.

Str::macro('concat', function(string $str1, string $str2) : string {
    return $str1 . $str2;
});

Run the ide-helper:generate command to create an _ide_helper.php file. This file contains PHPDoc annotations for Laravel Facades, allowing your IDE to provide autocomplete for them.

Key details:

• The output filename can be customized in the filename config key.
• If you use real-time facades, ensure you have actually triggered them in your application (e.g., by running a route) so the framework generates the necessary cache files before running this command.
• If you lack a default database connection, use the -M option to use an in-memory SQLite driver.
• You can include helper files (like Illuminate/Support/helpers.php) by using the --helpers (-H) option, though this is disabled by default.

php artisan ide-helper:generate

To get IDE autocompletion for Fluent methods used in migrations (e.g., $table->string(...)->nullable()), enable the include_fluent option in config/ide-helper.php and then run the facade generator.

```php
'include_fluent' => true,

Then run:

php artisan ide-helper:generate

To ensure your IDE helper files stay up to date when dependencies change, add the generation commands to your composer.json scripts under post-update-cmd.

"scripts": {
    "post-update-cmd": [
        "Illuminate\\Foundation\\ComposerScripts::postUpdate",
        "@php artisan ide-helper:generate",
        "@php artisan ide-helper:meta"
    ]
},

You can control which models are processed by the ide-helper:models command:

• Specific Models: Pass model class names as arguments: php artisan ide-helper:models "App\Models\Post".
• Custom Directory: Use the --dir option to scan a specific directory: php artisan ide-helper:models --dir="app/src/Model".
• Ignore Models: Use the --ignore (-I) flag with a comma-separated list: php artisan ide-helper:models --ignore="App\Models\Post,App\Models\User". Alternatively, define them in the ignored_models array in your config file.

php artisan ide-helper:models --dir="path/to/models"
php artisan ide-helper:models --ignore="App\Models\Post,App\Models\User"

The ide-helper:models command generates PHPDoc annotations for your models based on database columns, relationships, and getters/setters. This requires a working database connection.

Writing strategies:

• Write to models directly: Use --write (-W) to append properties/methods to your model files. Use --reset (-R) to replace existing PHPDocs entirely.
• Separate file: By default, it creates _ide_helper_models.php.
• Mixin approach: Use --write-mixin (-M) to add a @mixin tag to your model file while keeping the actual property definitions in a separate file. This prevents IDE duplicate warnings.
• Minimal helper: Use --write-eloquent-helper (-E) to generate a small version of the helper required for QueryBuilder methods if you don't want the full _ide_helper.php.

php artisan ide-helper:models -RW

To use the IDE Helper in your Laravel project, install it as a development dependency using Composer.

Note: The 3.x branch supports Laravel 10 and later. For older Laravel versions, use the 2.x releases.

composer require --dev barryvdh/laravel-ide-helper