はじめに
こちらの記事を見ていただいている皆様、PHPフレームワークのLaravel開発、どのようなIDEを利用されておりますでしょうか？
私はVSCodeにIntelephenseを最低限入れて、コーディングを行ってます。
このLaravelには
- ログを記録するためのLog Facades
- DB接続のためのDB Facades
など、クラスインスタンス生成不要で、静的メソッドのように呼び出しが可能なFacades機能があります。
この Facadesは、useを利用せずに呼び出すことが可能な機能となります。
ただ、Intelephense Ver.1.3以上の場合、 Facadesを検知しきれないためか図のように赤線を引かれてしまいます。これでは、記法エラーなのかIntelephenseの警告なのかわからなくなってしまいます。
今回はこの赤線をIntelephenseに引かせないためのパッケージ紹介となります。
この記事の目的
- IntelephenseがFacadesを検知できないなどで出す警告を抑止すること
対象環境
- VSCode
- Intelephense(Ver 1.3以降)
- Laravel(筆者の動作確認環境は8以上)
結論
laravel-ide-helperを導入する
laravel-ide-helperとは
公式サイトも参考にまとめると、「Intelephenseが正確なオートコンプリートを提供できるように補助するヘルパーファイルを作成するライブラリ」です。
先ほどの警告が出た図であればこのライブラリ導入とヘルパーファイルの作成すると図のようにワーニングが消えました。
さらに、カーソルを合わせると、クラス参照のダイアログも出ました。
導入手順及び利用方法
以下、公式サイトより、ざっくりと導入手順とhelperファイルの作成手順を記載します。(前提は、「すでにLaravelプロジェクトが存在する」となります。未作成の場合はLaravel公式のインストールガイドより作成してください。)
(1) 下記コマンドでパッケージを導入する(開発用であるため「--dev」でインストールします)
composer require --dev barryvdh/laravel-ide-helper
(2) 以下のコマンドでhelperファイルを作成
php artisan ide-helper:generate
以上のコマンドでFacadesのオートコンプリートが利用できるようになったはずです。
終わりに
このパッケージ導入で煩わしいFacadesの警告が消えるようになったかと思います。
この記事ではVSCodeで開発する人の助けとなれば幸いです。
余談
PHPStormを利用すると、最初から反応するという話を聞きました。 そうであればとても強力なツールだなと思います。
参考・参照
- VSCode：https://azure.microsoft.com/ja-jp/products/visual-studio-code
- Intelephense：https://intelephense.com/
- laravel-ide-helper：https://github.com/barryvdh/laravel-ide-helper
- PHPStorm：https://www.jetbrains.com/ja-jp/phpstorm/