はじめに
Laravel 8で開発中に、モデルで補完機能が使えずタイポを連発し時間を潰した時の、解決策を記事にしています。
もっと早く、この解決策を知りたかった。。。
開発状況（Version）
macOS Big Sur
Virtual Box 6.1.26
Laravel 8.x
PHP 7.x
IDE PhpStorm
方法
結論からいうと、
Laravel IDE Helperをインストールし、補完用のファイル（Helperファイル）を生成する。
それにより、IDEがファサードの補完ができるようになったり、メソッドの定義元に飛ぶことが可能になる。
基本的には、上記パッケージのREADME.mdに記載のある通り進めると、問題ありません。
下記にパッケージを抜粋した内容を記載するので、その通りに進めて、インストールしてください。
インストールコマンド
composer require --dev barryvdh/laravel-ide-helperLaravel 8系であれば、↑で良いが、
Laravel 7系以下のバージョンの場合は、↓のパッケージをインストールすると良いらしい。
composer require --dev barryvdh/laravel-ide-helper:"2.8.2"Helperファイル作成
インストール後、下記コマンド実行
_ide_helper.phpを作成
# PHPDoc generation for Laravel Facades
php artisan ide-helper:generate_ide_helper_models.phpを作成
_ide_helper_models.phpに書き込み
# PHPDocs for models
php artisan ide-helper:models --nowirte
or
php artisan ide-helper:models --Nor
モデルファイルに直接書き込み
# PHPDocs for models
php artisan ide-helper:models --write
or
php artisan ide-helper:models --Wちなみに
モデルに新たに追記した場合は、再度下記を実行しないと、Helperファイルに反映されず、補完機能が使えないので注意が必要です。
私はここに気づくまでに時間を要しました。。。
# PHPDocs for models
php artisan ide-helper:models --W
or
php artisan ide-helper:models --N最後に
たったこれだけで、Laravel IDE Helperを使用することができ、補完機能やタイポが減り、開発のスピードや、タイポ解消に時間を潰されずに済むのでオススメです！！
コメント