Barryvdh Laravel Ide Helper

Laravel IDE Helper addresses the common issue of incomplete IDE autocompletion by generating accurate PHPDocs for facade classes and Eloquent models.

This package makes Laravel development more seamless by bridging gaps in static analysis. Facades in Laravel resolve dependencies at runtime, leading to situations where an IDE might not offer autocompletion or reports undefined methods. Laravel IDE Helper solves this by generating helper files that enable IDEs to recognize and suggest methods from facades and database schema attributes.

Developers can use Artisan commands to produce these helper files. The command `ide-helper:generate` creates a file with PHPDoc annotations for all the facades used in a project. This file ensures that an IDE can parse and provide completions for methods and properties that arise from facades, which are otherwise dynamically resolved at runtime.

Working with models, the `ide-helper:models` command inspects the database schema and generates corresponding PHPDocs for properties and relations directly onto model classes or in a separate file. This process relies on having a working database connection to retrieve accurate information from the schema. Additional options allow developers to customize how and where these PHPDocs are written, including the ability to ignore certain models or directories.

The package also supports generating autocompletion data for Laravel's factory builders and handles PHPStorm metadata, which maps container bindings to specific classes for enhanced IDE integration. Primarily geared towards development, Laravel IDE Helper is beneficial in larger projects where comprehensive IDE support enhances overall productivity.

This overview was generated by AI from the package README and may not reflect the latest release.

Read the full README →