Laravel IDE Helper Generator

https://github.com/barryvdh/laravel-ide-helper
Admin
Laravel IDE Helper Generator is a package that generates PHPDocs and helper files to enable accurate...
Tokens:22,578
Snippets:374
Trust Score:9.8
License:MIT
Update:3 months ago
Show doc for...
Tokens:
Raw
### Migration Execution Example

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/api-reference/listener.md

Example of running migrations and the resulting automatic execution of helper commands.

```bash
php artisan migrate

# The listener automatically runs:
# - php artisan ide-helper:models
# - php artisan ide-helper:generate
```

--------------------------------

### Post-Migration Configuration Example

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/api-reference/service-provider.md

Example configuration snippet for the post_migrate setting to automate model documentation.

```php
'post_migrate' => [
    'ide-helper:models --nowrite',
],
```

--------------------------------

### Full IDE Helper Configuration Example

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/configuration.md

A comprehensive example of the configuration array structure, covering file naming, generation options, model locations, and custom extensions.

```php
return [
    // Output files
    'filename' => '_ide_helper.php',
    'models_filename' => '_ide_helper_models.php',
    'meta_filename' => '.phpstorm.meta.php',

    // Generation options
    'include_fluent' => false,
    'include_helpers' => false,
    'write_eloquent_model_mixins' => false,

    // Model locations
    'model_locations' => ['app/Models'],
    'ignored_models' => [],

    // Model documentation
    'write_model_magic_where' => true,
    'write_model_relation_count_properties' => true,
    'write_model_relation_exists_properties' => false,

    // Type handling
    'model_camel_case_properties' => false,
    'use_generics_annotations' => true,
    'enforce_nullable_relationships' => true,
    'soft_deletes_force_nullable' => true,

    // Custom extensions
    'extra' => [
        'Eloquent' => ['Illuminate\Database\Eloquent\Builder'],
        'Session' => ['Illuminate\Session\Store'],
    ],
    'interfaces' => [],
    'model_hooks' => [],
];
```

--------------------------------

### Macro Configuration

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/api-reference/macro.md

Example configuration for default return types in config/ide-helper.php.

```php
'macro_default_return_types' => [
    Illuminate\Http\Client\Factory::class => Illuminate\Http\Client\PendingRequest::class,
],
```

--------------------------------

### Install and Generate IDE Helper Files

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/index.md

Commands to install the package and generate necessary helper files for IDE autocompletion. The composer configuration automates these tasks after updates.

```bash
# Install
composer require --dev barryvdh/laravel-ide-helper

# Generate main helper file
php artisan ide-helper:generate

# Generate model documentation
php artisan ide-helper:models -W

# Generate PhpStorm metadata
php artisan ide-helper:meta

# All three at once (add to composer.json)
"post-update-cmd": [
    "@php artisan ide-helper:generate",
    "@php artisan ide-helper:models",
    "@php artisan ide-helper:meta"
]
```

--------------------------------

### Integration Example

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/api-reference/service-provider.md

Demonstrates how to trigger the generator command or resolve the command class from the container.

```php
// In a custom command or service
use Barryvdh\LaravelIdeHelper\Console\GeneratorCommand;

// The command is registered and available
artisan('ide-helper:generate');

// Or resolve from container
$generator = app(GeneratorCommand::class);
```

--------------------------------

### Configure Post-Migration Commands

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/api-reference/listener.md

Examples of configuring post-migration commands in the ide-helper configuration file.

```php
'post_migrate' => [
    'ide-helper:models --nowrite',
],
```

```php
'post_migrate' => [
    'ide-helper:models --nowrite',
    'ide-helper:generate',
],
```

```php
// In config/ide-helper.php
'post_migrate' => [
    'ide-helper:models',        // Generate model docs
    'ide-helper:generate',      // Generate facade helpers
],
```

--------------------------------

### Usage Example

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/api-reference/method.md

Demonstrates how to use the Method class to generate output for a specific facade method.

```php
$reflection = new \ReflectionClass('Illuminate\Support\Facades\Auth');
$authMethod = $reflection->getMethod('guard');

$method = new Method($authMethod, $reflection, null, $interfaces);

echo $method->getOutput();
// Outputs:
// /**
//  * @param string|null $name
//  * @return \Illuminate\Contracts\Auth\Guard
//  * @static
//  */
// public static function guard($name = null) { }
```

--------------------------------

### Install Laravel IDE Helper

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/README.md

Use Composer to add the package as a development dependency.

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

--------------------------------

### Macro Usage Example

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/api-reference/macro.md

Demonstrates defining a macro on a Macroable class and generating documentation for it.

```php
// In a Macroable class with macros
use Illuminate\Support\Traits\Macroable;

class MyService {
    use Macroable;
}

// Define macro with type hints
MyService::macro('search', function(string $query): array {
    return [];
});

// Generate documentation
$reflection = new \ReflectionClass('MyService');
$macroMethod = $reflection->getMethod('search');

$macro = new Macro($macroMethod, $reflection, 'search');
echo $macro->getOutput();
// Outputs docblock with inferred parameter and return types
```

--------------------------------

### Alias Usage Example

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/api-reference/alias.md

Demonstrates initializing an Alias and using its methods to process and output information.

```php
$config = app('config');
$alias = new Alias($config, 'Auth', 'Illuminate\Support\Facades\Auth');

if ($alias->isValid()) {
    echo "Processing: " . $alias->getAlias() . "\n";
    echo "Extends: " . $alias->getExtends() . "\n";
    echo "Methods: " . count($alias->getMethods()) . "\n";
    echo $alias->getDocblock();
}
```

--------------------------------

### Model PHPDoc Example

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/README.md

Example of a generated PHPDoc block for a model, including properties, relations, and query builder methods.

```php
/**
 * App\Models\Post
 *
 * @property integer $id
 * @property integer $author_id
 * @property string $title
 * @property string $text
 * @property \Illuminate\Support\Carbon $created_at
 * @property \Illuminate\Support\Carbon $updated_at
 * @property-read \User $author
 * @property-read \Illuminate\Database\Eloquent\Collection|\Comment[] $comments
 * @method static \Illuminate\Database\Eloquent\Builder<static>|\App\Models\Post newModelQuery()
 * @method static \Illuminate\Database\Eloquent\Builder<static>|\App\Models\Post newQuery()
 * @method static \Illuminate\Database\Eloquent\Builder<static>|\App\Models\Post query()
 * @method static \Illuminate\Database\Eloquent\Builder<static>|\App\Models\Post whereTitle($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|\App\Models\Post forAuthors(\User ...$authors)
 * …
 */
```

--------------------------------

### ModelsCommand Usage Examples

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/api-reference/console-commands.md

Common command-line usage patterns for generating, writing, and configuring model documentation.

```bash
# Preview model documentation
php artisan ide-helper:models

# Document specific models
php artisan ide-helper:models App\Models\Post App\Models\User

# Write directly to model files
php artisan ide-helper:models -W

# Reset and overwrite existing docblocks
php artisan ide-helper:models App\Models\Post -RW

# Add @mixin tag only, put documentation in separate file
php artisan ide-helper:models -M

# Generate supporting eloquent helper for @mixin to work
php artisan ide-helper:models -E

# Scan custom model directory
php artisan ide-helper:models --dir="app/src/Models"

# Ignore specific models
php artisan ide-helper:models --ignore="App\Models\Internal,App\Models\Temporary"

# Combine options: write mixin tag, generate helper file
php artisan ide-helper:models -ME
```

--------------------------------

### Example Usage in a Console Command

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/api-reference/eloquent.md

Demonstrates how to invoke the Eloquent helper within a custom Laravel console command.

```php
use Barryvdh\LaravelIdeHelper\Eloquent;
use Illuminate\Console\Command;
use Illuminate\Filesystem\Filesystem;

class MyCommand extends Command {
    public function handle(Filesystem $files) {
        Eloquent::writeEloquentModelHelper($this, $files);
    }
}
```

--------------------------------

### Usage Examples for PhpStorm Meta File

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/README.md

Demonstrates how PhpStorm's meta file allows IDEs to correctly infer types for container-resolved instances, enabling method auto-completion. Ensure the `.phpstorm.meta.php` file is indexed by PhpStorm.

```php
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);
```

--------------------------------

### Model PHPDoc Mixin Example

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/README.md

Example of a model PHPDoc block using the `--write-mixin` option, which adds a `@mixin` tag to the model file.

```php
/**
 * …
 * @mixin IdeHelperPost
 */
```

--------------------------------

### GeneratorCommand Usage Examples

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/api-reference/console-commands.md

Various ways to invoke the ide-helper:generate command to create helper files with different configurations.

```bash
# Generate standard helper file
php artisan ide-helper:generate

# Generate with custom filename
php artisan ide-helper:generate my_helper.php

# Include helper function documentation
php artisan ide-helper:generate -H

# Use in-memory SQLite (avoids DB connection errors)
php artisan ide-helper:generate -M

# Generate Eloquent-only minimal file
php artisan ide-helper:generate _ide_helper_eloquent.php -E

# Generate and add mixin to Model class
php artisan ide-helper:generate -W
```

--------------------------------

### Implement a Custom Model Hook

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/api-reference/model-hooks.md

Example class structure for creating a custom hook implementation.

```php
<?php

namespace App\Support\IdeHelper;

use Barryvdh\LaravelIdeHelper\Contracts\ModelHookInterface;
use Barryvdh\LaravelIdeHelper\Console\ModelsCommand;
use Illuminate\Database\Eloquent\Model;

class MyModelHook implements ModelHookInterface
{
    public function run(ModelsCommand $command, Model $model): void
    {
        // Customize documentation for this model
    }
}
```

--------------------------------

### Generated model hook output

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/README.md

Example of the resulting DocBlock after a model hook has been applied.

```php
/**
 * MyModel
 *
 * @property integer $id
 * @property-read string $custom
```

--------------------------------

### Get Method Output

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/api-reference/method.md

Retrieves the complete formatted method declaration including the docblock.

```php
public function getOutput(): string
```

--------------------------------

### Get Method Parameters

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/api-reference/method.md

Retrieves the method parameters as a comma-separated string.

```php
public function getParams(): string
```

--------------------------------

### Get Alias Namespace

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/api-reference/alias.md

Retrieves the namespace for the alias in the generated helper file.

```php
public function getNamespace(): string
```

--------------------------------

### Implement a model hook

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/README.md

Example implementation of a model hook that modifies properties and methods during generation.

```php
class MyCustomHook implements ModelHookInterface
{
    public function run(ModelsCommand $command, Model $model): void
    {
        if (! $model instanceof MyModel) {
            return;
        }

        $command->setProperty('custom', 'string', true, false, 'My custom property');
        $command->unsetMethod('method');
        $command->setMethod('method', $command->getMethodType($model, '\Some\Class'), ['$param']);
    }
}
```

--------------------------------

### Get PHPDoc Block

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/api-reference/method.md

Generates the complete PHPDoc block for the method, optionally with a prefix for indentation.

```php
public function getDocblock(string $prefix = ''): string
```

--------------------------------

### Get Real Method Name

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/api-reference/method.md

Retrieves the actual name of the method as defined in the source code.

```php
public function getRealName(): string
```

--------------------------------

### Get Root Method Call

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/api-reference/method.md

Generates a string representation of the method call, such as an instance call or static call.

```php
public function getRootMethodCall(): string
```

```php
echo $method->getRootMethodCall();
// Output: $instance->search(...)
// Output: \Auth::guard(...)
```

--------------------------------

### Get Alias Name

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/api-reference/alias.md

Returns the name of the alias.

```php
public function getAlias(): string
```

--------------------------------

### Initialize PHPDoc

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/api-reference/method.md

Parses existing documentation and class context to initialize the DocBlock.

```php
protected function initPhpDoc(\ReflectionMethod $method): void
```

--------------------------------

### Get Extended Class Namespace

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/api-reference/alias.md

Retrieves the namespace of the extended class.

```php
public function getExtendsNamespace(): ?string
```

--------------------------------

### Get DocBlock Object

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/api-reference/method.md

Retrieves the underlying DocBlock instance for the method.

```php
public function getPhpDoc(): \Barryvdh\Reflection\DocBlock
```

--------------------------------

### Visualize Package Architecture

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/README.md

A structural representation of the console entry points and the service provider lifecycle.

```text
Console Entry Points
  ├─ GeneratorCommand → Generator → Alias → Method
  ├─ ModelsCommand → Model introspection → Hooks
  ├─ MetaCommand → Container discovery
  └─ EloquentCommand → Eloquent::writeEloquentModelHelper()

Service Provider
  └─ IdeHelperServiceProvider
      ├─ Registers commands
      ├─ Merges config
      ├─ Registers event listeners
      └─ Publishes assets
```

--------------------------------

### Get Extended Class

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/api-reference/alias.md

Retrieves the fully-qualified class name that the alias extends.

```php
public function getExtends(): ?string
```

```php
if ($alias->getExtends() === '\Illuminate\Support\Facades\Facade') {
    // This is a facade
}
```

--------------------------------

### Get Root Class

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/api-reference/method.md

Retrieves the class name from which the method is intended to be called.

```php
public function getRoot(): string
```

--------------------------------

### Publish IDE Helper Configuration

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/README.md

Publish the configuration file to customize implementations or set default options for helper generation.

```bash
php artisan vendor:publish --provider="Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider" --tag=config
```

--------------------------------

### Configure IDE Helper settings

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/quick-reference.md

Define output filenames, generation options, and model locations in the configuration file.

```php
// Output files
'filename' => '_ide_helper.php',
'models_filename' => '_ide_helper_models.php',
'meta_filename' => '.phpstorm.meta.php',

// Generation
'include_fluent' => false,
'include_helpers' => false,
'write_model_magic_where' => true,

// Locations
'model_locations' => ['app'],
'ignored_models' => [],

// Types
'use_generics_annotations' => true,
'model_camel_case_properties' => false,
```

--------------------------------

### Get Declaring Class

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/api-reference/method.md

Retrieves the fully-qualified class name where the method is declared.

```php
public function getDeclaringClass(): string
```

--------------------------------

### Common IDE Helper Workflow

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/api-reference/console-commands.md

Standard sequence of commands to generate facade helpers, model documentation, and meta files.

```bash
# 1. Generate facade helpers
php artisan ide-helper:generate

# 2. Generate model documentation
php artisan ide-helper:models -R

# 3. Generate PhpStorm meta
php artisan ide-helper:meta

# 4. (Optional) Add mixin to base Model
php artisan ide-helper:eloquent
```

--------------------------------

### Generate IDE Helper File

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/README.md

Run this command to generate the `_ide_helper.php` file for IDE autocompletion. The filename can be configured.

```bash
php artisan ide-helper:generate
```

--------------------------------

### Work with Method class

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/quick-reference.md

Generate full docblock output for a specific reflection method.

```php
use Barryvdh\LaravelIdeHelper\Method;

$method = new Method($reflection, $class);
echo $method->getOutput();  // Full docblock
```

--------------------------------

### Get Alias Methods

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/api-reference/alias.md

Extracts all methods from the target class or classes associated with the alias.

```php
public function getMethods(): array
```

--------------------------------

### Real-time Facade Detection Workflow

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/workflows.md

Visual representation of the discovery process for real-time facades stored in the framework cache.

```text
Real-time facades workflow:
  ├─ Scan: storage/framework/cache/facade-*.php
  ├─ For each facade cache file:
  │   ├─ Parse namespace
  │   ├─ Parse class name
  │   └─ Add to facades map
  └─ During generation:
      └─ Include real-time facades in output
```

--------------------------------

### Get Parent Class

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/api-reference/alias.md

Retrieves the fully-qualified parent class name of the extended class.

```php
public function getParentClass(): ?string
```

--------------------------------

### Configure Helper Files

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/configuration.md

Defines the paths to helper files to include when generating documentation.

```php
'helper_files' => [
    base_path() . '/vendor/laravel/framework/src/Illuminate/Support/helpers.php',
    base_path() . '/vendor/laravel/framework/src/Illuminate/Foundation/helpers.php',
],
```

```php
'helper_files' => [
    // ... defaults ...
    app_path() . '/Support/custom_helpers.php',
],
```

--------------------------------

### Debugging Configuration

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/api-reference/listener.md

Commands to verify configuration and manually trigger post-migration tasks.

```bash
php artisan config:get ide-helper.post_migrate
```

```bash
php artisan migrate
php artisan ide-helper:models
```

--------------------------------

### Generate IDE Helper Files

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/README.md

Commands to generate autocompletion files for Laravel components.

```bash
php artisan ide-helper:generate
```

```bash
php artisan ide-helper:models -RW
```

```bash
php artisan ide-helper:generate
```

```bash
php artisan ide-helper:models
```

```bash
php artisan ide-helper:meta
```

--------------------------------

### Troubleshoot file write failures

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/errors.md

Verify file system permissions and directory writability when the helper file cannot be created.

```bash
# Check file permissions
ls -la _ide_helper.php

# Check directory writable
touch test.txt  # in same directory
rm test.txt
```

--------------------------------

### Inspect Generated Files

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/errors.md

Use cat to verify the content of generated helper files.

```bash
# View generated content
cat _ide_helper.php
cat _ide_helper_models.php
cat .phpstorm.meta.php
```

--------------------------------

### Execute Laravel IDE Helper Commands

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/quick-reference.md

Run these commands in your terminal to generate helper files and model documentation. Use specific flags to customize output, such as writing to files or targeting specific directories.

```bash
# Generate main helper file
php artisan ide-helper:generate

# Generate model documentation
php artisan ide-helper:models -W

# Generate PhpStorm meta file
php artisan ide-helper:meta

# Add mixin to base Model class
php artisan ide-helper:eloquent

# Preview model changes without writing
php artisan ide-helper:models

# Generate with options
php artisan ide-helper:generate -HM                    # With helpers, memory DB
php artisan ide-helper:models -RW --dir="app/Models"  # Reset, write, custom dir
```

--------------------------------

### Generate model documentation

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/index.md

Generates property and method documentation for Eloquent models.

```bash
php artisan ide-helper:models [models...] [options]

Options:
  -W, --write             Write directly to model files
  -R, --reset             Reset existing docblocks
  -M, --write-mixin       Write @mixin tag only
  -E, --write-eloquent-helper  Generate eloquent helper
  -I, --ignore            Ignore models (comma-separated)
  --dir                   Custom model directory (multiple)
```

--------------------------------

### Configure Interface Mappings

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/configuration.md

Maps interfaces to concrete implementations for docblock generation.

```php
'interfaces' => [
    // 'App\MyInterface' => 'App\MyImplementation',
],
```

```php
'interfaces' => [
    'App\Contracts\ServiceInterface' => 'App\Services\ServiceImplementation',
],
```

--------------------------------

### Get Extended Class Name

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/api-reference/alias.md

Retrieves the short class name of the extended class without the namespace.

```php
public function getExtendsClass(): ?string
```

--------------------------------

### Get Alias Class Type

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/api-reference/alias.md

Retrieves the type of the class being aliased, returning either 'class' or 'interface'.

```php
public function getClasstype(): string
```

--------------------------------

### Generate IDE helper file

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/index.md

Generates the _ide_helper.php file containing facade methods and optional helper functions.

```bash
php artisan ide-helper:generate [filename] [options]

Options:
  -H, --helpers           Include helper functions
  -M, --memory            Use SQLite in-memory database
  -E, --eloquent          Eloquent methods only
  -W, --write_mixins      Add @mixin to Model class
```

--------------------------------

### Document models

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/README.md

Runs the model documentation command with the -W flag to write changes to model files.

```bash
php artisan ide-helper:models -W
```

--------------------------------

### Configure Filename

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/configuration.md

Sets the main output filename for generated facade and helper documentation.

```php
'filename' => '_ide_helper.php',
```

```php
php artisan ide-helper:generate my_custom_helper.php
```

--------------------------------

### Optimize IDE Helper Performance

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/index.md

Configuration settings to reduce processing time by disabling unused features, limiting scan paths, and ignoring specific models.

```php
'write_model_magic_where' => false,  // Skip where* methods
'write_model_relation_count_properties' => false,
```

```php
'model_locations' => ['app/Models'],  // Not ['app']
```

```php
'ignored_models' => ['App\Models\Temp'],
```

--------------------------------

### IDE Helper Configuration Keys

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/workflows.md

List of configuration keys used by the generator to customize facade and helper file output.

```php
'filename'
'include_fluent'
'include_helpers'
'helper_files'
'extra'           // Additional facade implementations
'magic'           // Magic method definitions
'interfaces'      // Interface mappings
'macro_default_return_types'
```

--------------------------------

### Performance Optimization

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/api-reference/listener.md

Configuration snippets for disabling or optimizing post-migration commands in production environments.

```php
'post_migrate' => [
    // Set to empty array
],
```

```php
'post_migrate' => [
    'ide-helper:models --nowrite',  // Faster, preview mode
],
```

```bash
# Run manually instead of after every migration
php artisan migrate
php artisan ide-helper:models  # Run separately
```

--------------------------------

### Publishing Configuration via Artisan

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/api-reference/service-provider.md

Command to publish the package configuration file to the application's config directory.

```bash
php artisan vendor:publish --provider="Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider" --tag=config
```

--------------------------------

### Generate facade helpers

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/README.md

Executes the generator command to create helper files for Laravel facades.

```bash
php artisan ide-helper:generate
```

--------------------------------

### Generate IDE helper files

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/quick-reference.md

Instantiate the Generator class to produce helper content for the project or Eloquent models.

```php
use Barryvdh\
```

```php
LaravelIdeHelper\Generator;

$generator = new Generator($config, $view);
$content = $generator->generate();      // Main helper
$eloquent = $generator->generateEloquent();  // Eloquent only
```

--------------------------------

### Enable PHPDocs for Fluent Migration Methods

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/README.md

Set `include_fluent` to `true` in `config/ide-helper.php` to enable PHPDocs for fluent methods in migrations. After changing the config, run `php artisan ide-helper:generate`.

```php
$table->string("somestring")->nullable()->index();
```

```php
'include_fluent' => true,
```

--------------------------------

### Method Constructor

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/api-reference/method.md

Initializes a new Method instance using reflection objects and optional configuration for aliases and normalizers.

```php
public function __construct(
    \ReflectionMethod|\ReflectionFunctionAbstract $method,
    \ReflectionClass $class,
    ?string $methodName = null,
    array $interfaces = [],
    array $classAliases = [],
    array $returnTypeNormalizers = [],
    array $templateNames = []
): void
```

--------------------------------

### Generate Helper Files Programmatically

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/index.md

Use the Generator class to create full helper files or Eloquent-specific documentation.

```php
use Barryvdh\LaravelIdeHelper\Generator;

$generator = new Generator($config, $view, $output, $helpers);
$content = $generator->generate();  // Full helper file
$eloquent = $generator->generateEloquent();  // Eloquent only
```

--------------------------------

### Enable Auto-completion for Factory Builders

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/README.md

Set `include_factory_builders` to `true` in `config/ide-helper.php` to enable auto-completion for `factory()->create()` and `factory()->make()` methods. This requires the PhpStorm Meta file to be published.

```php
'include_factory_builders' => true,
```

--------------------------------

### Configure Extra Classes

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/configuration.md

Maps aliases or facades to a list of implementation classes for method inclusion.

```php
'extra' => [
    'Eloquent' => ['Illuminate\Database\Eloquent\Builder', 'Illuminate\Database\Query\Builder'],
    'Session' => ['Illuminate\Session\Store'],
],
```

```php
'extra' => [
    'MyService' => ['App\Services\MyServiceImpl'],
],
```

--------------------------------

### Work with Alias class

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/quick-reference.md

Validate and retrieve docblocks for specific facade aliases.

```php
use Barryvdh\LaravelIdeHelper\Alias;

$alias = new Alias($config, 'Auth', 'Illuminate\Support\Facades\Auth');
if ($alias->isValid()) {
    echo $alias->getDocblock();
}
```

--------------------------------

### Real-Time Facade Missing Resolution

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/workflows.md

Steps to ensure a missing real-time facade is included in the generated helper file.

```bash
php artisan tinker
php artisan ide-helper:generate
```

--------------------------------

### Composer Integration

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/api-reference/console-commands.md

Configure composer.json to automatically run helper commands after updates.

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

--------------------------------

### Refreshing Autoloader

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/errors.md

Run this command to resolve reflection errors caused by invalid syntax or missing dependencies.

```bash
composer dumpautoload
```

--------------------------------

### Constructor Definition

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/api-reference/generator.md

Initializes the generator with required Laravel configuration, view factory, and optional console output.

```php
public function __construct(
    \Illuminate\Config\Repository $config,
    \Illuminate\View\Factory $view,
    ?\Symfony\Component\Console\Output\OutputInterface $output = null,
    string $helpers = ''
): void
```

--------------------------------

### Configure Composer Post-Update Scripts

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/README.md

Add these scripts to your `composer.json` to automatically generate helper files after updating dependencies.

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

--------------------------------

### Generate IDE Helper File

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/api-reference/generator.md

Generates and saves the complete IDE helper file content.

```php
public function generate(): string
```

```php
$generator = new Generator($config, $view);
$content = $generator->generate();
file_put_contents('_ide_helper.php', $content);
```

--------------------------------

### Verifying Database Connection

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/errors.md

Commands to check database status or generate model documentation without requiring a live connection.

```bash
# Check database configuration
php artisan migrate:status

# Or use deferred generation
php artisan ide-helper:models --nowrite  # Preview without database
```

--------------------------------

### Troubleshooting Commands

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/quick-reference.md

Common CLI commands for resolving specific errors.

```bash
php artisan clear-compiled
```

--------------------------------

### Handle Method

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/api-reference/listener.md

The handle method processes the CommandFinished event to execute configured post-migration commands.

```php
public function handle(\Illuminate\Console\Events\CommandFinished $event): void
```

--------------------------------

### Registering the Service Provider in composer.json

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/api-reference/service-provider.md

Add this configuration to your project's composer.json file to enable auto-discovery of the service provider.

```json
{
  "extra": {
    "laravel": {
      "providers": [
        "Barryvdh\\LaravelIdeHelper\\IdeHelperServiceProvider"
      ]
    }
  }
}
```

--------------------------------

### Project Documentation Directory Structure

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/MANIFEST.md

Visual representation of the documentation file hierarchy within the output directory.

```text
/output
├── README.md                          [Documentation overview and guide]
├── MANIFEST.md                        [This file - file listing and info]
│
├── index.md                           [Complete index - start here]
├── quick-reference.md                 [Common tasks, options, troubleshooting]
├── configuration.md                   [All config keys with examples]
├── types.md                           [Type definitions and interfaces]
├── errors.md                          [Error conditions and recovery]
├── workflows.md                       [Step-by-step operation flows]
│
└── api-reference/                     [Individual class documentation]
    ├── generator.md                   [Generator class - main orchestrator]
    ├── alias.md                       [Alias class - facade representation]
    ├── method.md                      [Method class - method analysis]
    ├── macro.md                       [Macro class - macro extraction]
    ├── console-commands.md            [All four artisan commands]
    ├── service-provider.md            [Service provider bootstrap]
    ├── eloquent.md                    [Eloquent helper utility]
    ├── model-hooks.md                 [Extension system for model docs]
    ├── listener.md                    [Post-migration event listener]
    └── parsers.md                     [Type parsing utilities]
```

--------------------------------

### MetaCommand Constructor

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/api-reference/console-commands.md

The constructor for the MetaCommand class, requiring filesystem, view factory, and configuration repository dependencies.

```php
public function __construct(
    \Illuminate\Filesystem\Filesystem $files,
    \Illuminate\Contracts\View\Factory $view,
    \Illuminate\Contracts\Config\Repository $config
): void
```

--------------------------------

### Configure Models Filename

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/configuration.md

Sets the output filename for model documentation when using separate file mode.

```php
'models_filename' => '_ide_helper_models.php',
```

--------------------------------

### Provides Method Return Value

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/api-reference/service-provider.md

The array of services provided by the IdeHelperServiceProvider for deferred loading optimization.

```php
[
    'Barryvdh\LaravelIdeHelper\Console\GeneratorCommand',
    'Barryvdh\LaravelIdeHelper\Console\ModelsCommand',
    'Barryvdh\LaravelIdeHelper\Console\MetaCommand',
    'Barryvdh\LaravelIdeHelper\Console\EloquentCommand',
]
```

--------------------------------

### Configure force_fqn

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/configuration.md

Forces the use of fully-qualified class names in generated docblocks.

```php
'force_fqn' => false,
```

--------------------------------

### Facade Helper Generation Flow

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/workflows.md

Visual representation of the internal execution steps performed by the GeneratorCommand during facade generation.

```text
GeneratorCommand::handle()
  ├─ Check for compiled files (exit if found)
  ├─ Load helper files (if -H flag)
  ├─ Create Generator instance
  │   ├─ Load config (ide-helper.*)
  │   ├─ Detect drivers (Auth, DB, Cache, Queue, Storage)
  │   ├─ Merge extra/magic/interfaces from config
  │   └─ Set macro default return types
  ├─ Call Generator::generate()
  │   ├─ Get valid aliases (filters, validates)
  │   │   └─ For each alias: Create Alias instance
  │   │       ├─ Reflect facade class
  │   │       ├─ Extract methods via reflection
  │   │       ├─ Parse docblocks
  │   │       └─ Detect parent classes
  │   ├─ Group by extends namespace
  │   ├─ Group by alias namespace
  │   ├─ Find real-time facades (from storage/framework/cache/)
  │   └─ Render template with collected data
  ├─ Write file
  └─ Report success/failure
```

--------------------------------

### Configure Meta Filename

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/configuration.md

Sets the output location for the PhpStorm metadata file.

```php
'meta_filename' => '.phpstorm.meta.php',
```

--------------------------------

### Configure write_query_methods

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/configuration.md

Toggles the generation of docblocks for standard query methods like query(), newQuery(), and newModelQuery().

```php
'write_query_methods' => true,
```

--------------------------------

### Scan specific models

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/README.md

Use the ide-helper:models command to specify which models to scan for IDE helper generation.

```bash
php artisan ide-helper:models "App\Models\Post" "App\Models\User"
```

--------------------------------

### Generate Eloquent Helper File

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/api-reference/generator.md

Generates a minimal helper file containing only Eloquent class methods and builder mixins.

```php
public function generateEloquent(): string
```

```php
$generator = new Generator($config, $view);
$eloquentContent = $generator->generateEloquent();
file_put_contents('_ide_helper_eloquent.php', $eloquentContent);
```

--------------------------------

### Debug PhpStorm Meta Generation

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/errors.md

Use verbose output or check configuration to diagnose service instantiation failures.

```bash
# Run with verbose to see which service is failing
php artisan ide-helper:meta -v

# Check service provider configuration
php artisan config:show
```

--------------------------------

### Generate PhpStorm Meta File for Container Instances

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/README.md

Run `php artisan ide-helper:meta` to generate a PhpStorm meta file. This enables PhpStorm to understand the types of objects resolved from the IoC Container, providing auto-completion for methods.

```bash
php artisan ide-helper:meta
```

--------------------------------

### Macro Constructor

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/api-reference/macro.md

Initializes a new Macro instance with reflection data for the macroable class and method.

```php
public function __construct(
    \ReflectionFunctionAbstract $method,
    \ReflectionClass $class,
    ?string $methodName = null,
    array $interfaces = [],
    array $classAliases = [],
    array $returnTypeNormalizers = []
): void
```

--------------------------------

### Configure Magic Methods

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/configuration.md

Defines magic method definitions for specific facades.

```php
'magic' => [],
```

--------------------------------

### PhpStorm Meta Generation Flow

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/workflows.md

Visual representation of the steps taken by the MetaCommand to discover container bindings and generate metadata.

```text
MetaCommand::handle()
  ├─ Suppress fatal autoload errors
  ├─ Discover container bindings
  │   ├─ Get all abstract keys from container
  │   └─ For each abstract:
  │       ├─ Try to make instance
  │       ├─ Get concrete class
  │       └─ Add to bindings map
  ├─ Load config values
  │   └─ Traverse all config values
  ├─ Load environment variables (from .env)
  ├─ Get auth user model (from config)
  ├─ Generate expected argument sets
  │   └─ Container binding maps
  ├─ Render template with all data
  ├─ Write to meta_filename
  └─ Report completion
```

--------------------------------

### Automate Helper Generation After Migrations

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/index.md

Configure the post_migrate setting in the ide-helper config file to trigger model updates automatically.

```php
// config/ide-helper.php
'post_migrate' => [
    'ide-helper:models --nowrite',
],
```

--------------------------------

### Scan custom directories

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/README.md

Use the --dir option to scan directories other than the default app/models path.

```bash
php artisan ide-helper:models --dir="path/to/models" --dir="app/src/Model"
```

--------------------------------

### Defining Custom Query Scopes

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/api-reference/model-hooks.md

Use setMethod to document custom query scopes for IDE autocompletion.

```php
class QueryScopesHook implements ModelHookInterface
{
    public function run(ModelsCommand $command, Model $model): void
    {
        if ($model instanceof Post) {
            $command->setMethod('scopePublished', 'Builder|static', 
                [''], 'Only published posts');
            $command->setMethod('scopeRecent', 'Builder|static',
                [''], 'Ordered by latest first');
        }
    }
}
```

--------------------------------

### Generator::generate

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/api-reference/generator.md

Generates the complete IDE helper file content.

```APIDOC
## generate()

### Description
Generates complete IDE helper file content with all configured facades, real-time facades, and optional helpers.

### Returns
- **string** - Rendered PHP helper file content

### Example
```php
$generator = new Generator($config, $view);
$content = $generator->generate();
file_put_contents('_ide_helper.php', $content);
```
```

--------------------------------

### Enable Verbose Output

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/errors.md

Run commands with the -vvv flag to display detailed debug information.

```bash
php artisan ide-helper:generate -vvv
php artisan ide-helper:models -vvv
php artisan ide-helper:meta -vvv
```

--------------------------------

### Regenerate Real-Time Facade Cache

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/errors.md

Trigger facade caching by invoking the service, then run the generator command.

```bash
# Use a real-time facade in your code
use App\\\Services\\\MyService;
app(MyService::class)->method();

# Then regenerate
php artisan ide-helper:generate
```

--------------------------------

### GenerateModelHelper Constructor

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/api-reference/listener.md

Constructor for the GenerateModelHelper class, requiring the Artisan kernel and configuration repository.

```php
public function __construct(
    \Illuminate\Contracts\Console\Kernel $artisan,
    \Illuminate\Contracts\Config\Repository $config
): void
```

--------------------------------

### Implementing Custom Calculated Properties

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/api-reference/model-hooks.md

Use setProperty to define virtual properties that do not exist as database columns.

```php
class CalculatedPropertiesHook implements ModelHookInterface
{
    public function run(ModelsCommand $command, Model $model): void
    {
        if ($model instanceof User) {
            $command->setProperty('full_name', 'string', true, false, 
                'Concatenation of first_name and last_name');
            $command->setProperty('initials', 'string', true, false,
                'User initials');
        }
    }
}
```

--------------------------------

### Execute Models Command Programmatically

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/index.md

Trigger the model documentation command via the Laravel service container.

```php
use Barryvdh\LaravelIdeHelper\Console\ModelsCommand;

// Run via artisan or resolve from container
app(ModelsCommand::class)->handle();
```

--------------------------------

### Generate PHPDocs for Models

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/README.md

Use this command to generate PHPDocs for models based on table columns, relations, and getters/setters. Requires a database connection.

```bash
php artisan ide-helper:models "App\Models\Post"
```

--------------------------------

### Generate PhpStorm Metadata

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/api-reference/console-commands.md

Commands to generate the default metadata file or specify a custom output path.

```bash
# Generate default PhpStorm meta file
php artisan ide-helper:meta

# Generate to custom location
php artisan ide-helper:meta --output=.phpstorm.meta.php/laravel.php
```

--------------------------------

### Model Configuration Keys

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/workflows.md

List of configuration keys used to control the behavior of the model documentation generator.

```php
'models_filename'
'model_locations'
'ignored_models'
'model_hooks'
'write_query_methods'
'write_model_magic_where'
'write_model_external_builder_methods'
'write_model_relation_count_properties'
'write_model_relation_exists_properties'
'model_camel_case_properties'
'type_overrides'
'use_generics_annotations'
'force_fqn'
'include_class_docblocks'
'enforce_nullable_relationships'
'soft_deletes_force_nullable'
'additional_relation_types'
'additional_relation_return_types'
```

--------------------------------

### Verify Vendor File Readability

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/errors.md

Check if a specific vendor file is readable to troubleshoot file access errors.

```bash
# Check file is readable
cat vendor/laravel/framework/src/Illuminate/Database/Eloquent/Model.php
```

--------------------------------

### Configure use_generics_annotations

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/configuration.md

Enables generic syntax in docblocks. Requires PhpStorm 2022.3 or higher.

```php
'use_generics_annotations' => true,
```

--------------------------------

### Implement Custom Model Hook

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/index.md

Create a class implementing ModelHookInterface to manually define properties for specific models in the generated IDE helper files.

```php
namespace App\Support\IdeHelper;

use Barryvdh\LaravelIdeHelper\Contracts\ModelHookInterface;
use Barryvdh\LaravelIdeHelper\Console\ModelsCommand;
use Illuminate\Database\Eloquent\Model;

class CustomPropertiesHook implements ModelHookInterface
{
    public function run(ModelsCommand $command, Model $model): void
    {
        if ($model instanceof User) {
            $command->setProperty('full_name', 'string', true, false, 'First + Last name');
        }
    }
}
```

--------------------------------

### Forcing Configuration File Overwrite

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/errors.md

Use this command to restore or update the configuration file if keys are missing or invalid.

```bash
php artisan vendor:publish --provider="Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider" --tag=config --force
```

--------------------------------

### ModelsCommand Constructor

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/api-reference/console-commands.md

The constructor for the ModelsCommand class, requiring filesystem, configuration, and view factory dependencies.

```php
public function __construct(
    \Illuminate\Filesystem\Filesystem $files,
    \Illuminate\Contracts\Config\Repository $config,
    \Illuminate\View\Factory $view
): void
```

--------------------------------

### Define Model Locations

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/types.md

Glob patterns for directories to scan for Eloquent models.

```php
string[]
// Example:
[
    'app',
    'app/Models',
    'app/Services/*/Models',
]
```

--------------------------------

### Configure include_class_docblocks

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/configuration.md

Determines whether to include class-level docblocks in the generated model documentation.

```php
'include_class_docblocks' => false,
```

--------------------------------

### Generate PhpStorm metadata

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/README.md

Creates the .phpstorm.meta.php file to improve IDE autocompletion for Laravel services.

```bash
php artisan ide-helper:meta
```

--------------------------------

### Meta Configuration Key

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/workflows.md

The configuration key used to define the output filename for the generated meta file.

```php
'meta_filename'
```

--------------------------------

### Configure Post-Migration Artisan Commands

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/configuration.md

Define Artisan commands to execute automatically following migration completion. This setting is automatically disabled during unit tests.

```php
'post_migrate' => [
    // 'ide-helper:models --nowrite',
],
```

```php
'post_migrate' => [
    'ide-helper:models',
    'ide-helper:generate',
],
```

--------------------------------

### Configure Fluent Query Builder Inclusion

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/configuration.md

Toggles documentation for Laravel Fluent query builder methods.

```php
'include_fluent' => false,
```

--------------------------------

### Declare Macro with Type Hinting

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/README.md

Define a macro with type hinting to enable PHPDoc generation for it. This ensures the macro is correctly documented in the helper file.

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

--------------------------------

### Service Provider Method Signatures

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/api-reference/service-provider.md

Standard methods implemented by the IdeHelperServiceProvider for lifecycle management and service provision.

```php
public function register(): void
```

```php
public function boot(): void
```

```php
public function provides(): array
```

--------------------------------

### Implement custom Model Hook

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/quick-reference.md

Create a class implementing ModelHookInterface to dynamically add or remove properties and methods during model generation.

```php
use Barryvdh\LaravelIdeHelper\Contracts\ModelHookInterface;
use Barryvdh\LaravelIdeHelper\Console\ModelsCommand;
use Illuminate\Database\Eloquent\Model;

class MyHook implements ModelHookInterface
{
    public function run(ModelsCommand $command, Model $model): void
    {
        $command->setProperty('custom', 'string', true, false, 'Description');
        $command->setMethod('scopeActive', 'Builder|static', ['string $status']);
        $command->unsetMethod('internalMethod');
    }
}
```

--------------------------------

### Define Hook Classes

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/types.md

Fully-qualified class names implementing ModelHookInterface.

```php
string[]
// Example:
[
    'App\Support\IdeHelper\MyModelHook',
]
```

--------------------------------

### Model Documentation Generation Flow

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/workflows.md

Visual representation of the internal steps taken by the ModelsCommand during model documentation generation.

```text
ModelsCommand::handle()
  ├─ Parse arguments (specific models or auto-discover)
  ├─ Load date class from config
  ├─ Discover models
  │   ├─ Scan model_locations directories
  │   ├─ Filter by ignored_models
  │   └─ Build list of Model classes
  ├─ For each model: processModel()
  │   ├─ Get table from model
  │   ├─ Introspect database columns
  │   │   └─ Get types, nullability, foreign keys
  │   ├─ Analyze relationships
  │   │   ├─ Find all relation methods
  │   │   ├─ Determine return types
  │   │   └─ Handle soft deletes
  │   ├─ Parse accessors/mutators
  │   ├─ Process attribute casts
  │   ├─ Generate withCount/withExists properties
  │   ├─ Generate magic where* methods (if enabled)
  │   ├─ Generate query builder methods
  │   ├─ Run model hooks
  │   │   └─ For each hook: hook->run($command, $model)
  │   │       └─ Hook can call setProperty/setMethod/unsetProperty/unsetMethod
  │   └─ Build docblock
  ├─ Handle output mode
  │   ├─ --write: Write directly to model files
  │   ├─ --write-mixin: Add @mixin tag, write to separate file
  │   ├─ --nowrite: Preview only
  │   └─ Default: Ask user for each model
  └─ Report results
```

--------------------------------

### Define Interfaces Map

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/types.md

Maps interface fully-qualified names to their implementation classes for substitution in docblocks.

```php
array<string, string>
// Example:
[
    'Illuminate\Contracts\Auth\Authenticatable' => 'App\Models\User',
    'Illuminate\Contracts\Cache\Store' => 'Illuminate\Cache\FileStore',
]
```

--------------------------------

### Generator::__construct

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/api-reference/generator.md

Initializes a new instance of the Generator class with required Laravel dependencies.

```APIDOC
## Constructor

### Description
Initializes the Generator with the necessary Laravel configuration and view factory to process helper generation.

### Signature
`public function __construct(\Illuminate\Config\Repository $config, \Illuminate\View\Factory $view, ?\Symfony\Component\Console\Output\OutputInterface $output = null, string $helpers = '')`

### Parameters
- **config** (\Illuminate\Config\Repository) - Required - Laravel config repository for IDE helper settings
- **view** (\Illuminate\View\Factory) - Required - Laravel view factory for rendering templates
- **output** (?\Symfony\Component\Console\Output\OutputInterface) - Optional - Console output interface for feedback messages
- **helpers** (string) - Optional - Pre-loaded helper file content to include in output
```

--------------------------------

### Configure Macro return types

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/quick-reference.md

Set default return types for macros before processing reflection.

```php
use Barryvdh\LaravelIdeHelper\Macro;

Macro::setDefaultReturnTypes([
    MyClass::class => 'string',
]);

$macro = new Macro($reflection, $class);
```

--------------------------------

### Alias Constructor Definition

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/api-reference/alias.md

Defines the constructor for initializing an Alias instance with configuration and target class details.

```php
public function __construct(
    \Illuminate\Config\Repository $config,
    string $alias,
    string $facade,
    array $magicMethods = [],
    array $interfaces = []
): void
```

--------------------------------

### Ignore models via command

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/README.md

Exclude specific models from the generation process using the --ignore option.

```bash
php artisan ide-helper:models --ignore="App\Models\Post,App\Models\User"
```

--------------------------------

### Extract Parameters

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/api-reference/method.md

Extracts parameter information from reflection, including types and default values.

```php
protected function getParameters(\ReflectionMethod $method): void
```

--------------------------------

### PhpDocReturnTypeParser Constructor

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/api-reference/parsers.md

Initializes the parser with a type alias and a mapping of namespace aliases for resolution.

```php
public function __construct(
    string $typeAlias,
    array $namespaceAliases
): void
```

--------------------------------

### GeneratorCommand Constructor

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/api-reference/console-commands.md

The constructor for the GeneratorCommand class, requiring configuration, filesystem, and view factory dependencies.

```php
public function __construct(
    \Illuminate\Contracts\Config\Repository $config,
    \Illuminate\Filesystem\Filesystem $files,
    \Illuminate\View\Factory $view
): void
```

--------------------------------

### Generator::generateEloquent

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/api-reference/generator.md

Generates a minimal Eloquent-only helper file.

```APIDOC
## generateEloquent()

### Description
Generates minimal Eloquent-only helper file containing only Eloquent class methods and builder mixins. Used for reduced file size when full facade documentation is not needed.

### Returns
- **string** - Rendered PHP helper file with Eloquent methods only

### Throws
- **\RuntimeException** - If Eloquent helper cannot be generated

### Example
```php
$generator = new Generator($config, $view);
$eloquentContent = $generator->generateEloquent();
file_put_contents('_ide_helper_eloquent.php', $eloquentContent);
```
```

--------------------------------

### Implement ModelHookInterface

Source: https://github.com/barryvdh/laravel-ide-helper/blob/master/_autodocs/errors.md

Ensure custom hooks implement the required interface to be recognized by the generator.

```php
class MyHook implements \\Barryvdh\\LaravelIdeHelper\\Contracts\\ModelHookInterface
{
    public function run(ModelsCommand $command, Model $model): void
    {
        // Implementation
    }
}
```
Tokens:
Raw