barryvdh/laravel-ide-helper

これは何？

主な機能

• 01`ide-helper:generate`でFacadeの自動補完用ファイルを生成します。
• 02カラム、リレーション、アクセサーに関するモデルのPHPDocを書き出します。
• 03コンテナによる解決を補助するPhpStormのメタファイルを作成します。
• 04mixinを使ってモデルのドキュメントを別ファイルに出力できます。
• 05マクロ、Fluentのマイグレーションメソッド、ファクトリービルダーに対応しています。

ユースケース

• PhpStormでEloquentモデルの属性やリレーションを正確に自動補完する。
• ジェネレーターを再実行して、スキーマや依存関係の変更に合わせてIDEのヒントを更新する。
• LaravelプロジェクトのFacadeやコンテナバインディングをIDEに認識させる。

クイックスタート

1. 1

   Composerでパッケージを開発依存関係としてインストールする

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

   Facadeの自動補完ファイルを生成する

   php artisan ide-helper:generate
3. 3

   モデル用のPHPDocを生成し、モデルファイルに書き込む

   php artisan ide-helper:models -RW

使う前に知っておきたいこと

• !モデルのPHPDocを生成するには、データベースへの接続が正常に機能している必要があります。
• !3.xブランチはLaravel 10以降に対応しています。それより古いLaravelバージョンでは2.xリリースが必要です。

トピック

よくある質問

laravel-ide-helper とは？

LaravelのFacadeとEloquentモデルのPHPDocファイルを生成し、PhpStormなどのIDEで正確な自動補完を利用できます。 IDE Helper for LaravelはComposerの開発用依存パッケージで、プロジェクト内のコードをもとにヘルパーファイルを生成し、エディターで正確な自動補完を利用できるようにします。`php artisan ide-helper:generate`を実行するとLaravelのFacadeを記述したファイルが生成され、`ide-helper:models`を実行すると、テーブルのカラム、リレーション、getter/setterに基づくEloquentモデルのPHPDocが書き出されます。

laravel-ide-helper は無料で使えますか？ライセンスは？

laravel-ide-helper は MIT ライセンスのオープンソースです。商用製品で使う前にライセンス条件を確認してください。

laravel-ide-helper は今もメンテナンスされていますか？

活発にメンテナンス中。laravel-ide-helper の最終コミットは 2026年11月3日 です。

laravel-ide-helper は何に使えますか？

PhpStormでEloquentモデルの属性やリレーションを正確に自動補完する。 ジェネレーターを再実行して、スキーマや依存関係の変更に合わせてIDEのヒントを更新する。 LaravelプロジェクトのFacadeやコンテナバインディングをIDEに認識させる。

laravel-ide-helper のインストール方法は？

Composerでパッケージを開発依存関係としてインストールする: composer require --dev barryvdh/laravel-ide-helper Facadeの自動補完ファイルを生成する: php artisan ide-helper:generate モデル用のPHPDocを生成し、モデルファイルに書き込む: php artisan ide-helper:models -RW

laravel-ide-helper はどこで入手できますか？

ソースコードとインストール手順は GitHub にあります：https://github.com/barryvdh/laravel-ide-helper