PhpStorm 2020.1ヘルプ

Laravel

Laravel(英語)は、無料のオープンソースPHP Webアプリケーションフレームワークです。複数のsymfony(英語)コンポーネントの上に構築され、認証、ルーティング、セッション、キャッシングなどの一般的なタスクを実装するのがはるかに簡単になります。

Laravelの使用を開始する前に、Laravel(英語)(無料)またはLaravelのアイデア(英語)(有料)プラグインがインストールされ、有効になっていることを確認してください。どちらのプラグインも、Laravel IDEヘルパー(英語)ツールをインストールする必要があります。

さらに、Composerがマシンにインストールされ、Composer依存関係マネージャーの説明に従って現在のプロジェクトで初期化されていることを確認してください。

Laravel IDEヘルパージェネレーターをインストールする

  1. ComposerとともにLaravel IDEヘルパージェネレータ(英語)をインストールします。これを行うには、barryvdh / laravel-ide-helperパッケージの依存関係を composer.jsonに追加します。詳細については、依存関係のインストールを参照してください。

  2. Laravel IDEヘルパーServiceProvider としてアプリケーションに追加します。 config/app.php ファイルで、providers 要素に Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider::class を追加します。

    return array( // ... 'providers' => array( // ... // Laravel IDE helper 'Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider', ), // ... );

Laravel IDE Helperは、サービス、コントローラー、モデル、およびビューの変更または追加後に実行する必要があります。あるいは、たとえば composer.json が更新されたときに、このファイルを自動的に再生成するようにPhpStormにファイル監視を設定します。

LaravelジェネレータComposerパッケージ(英語)をインストールして、モデル、ビュー、コントローラーなどのさまざまなLaravelジェネレータを追加することもできます。

コーディング支援

Laravelプラグインは、さまざまなLaravelコンポーネント(コントローラー、ルート、ビュー、構成、サービス、翻訳)にコード補完とナビゲーションを提供します。Laravel固有のライブテンプレートを使用して、さまざまなLaravelエンティティを生成することもできます。

コード補完

エディターで、Ctrl+Space を押してコード補完を呼び出し、次のいずれかの操作を行います。

  • Redirect および Route ファサードのさまざまな機能を使用する場合、コントローラーを参照します。

    Laravel controller completion
  • View ファサードを使用する場合は、Bladeテンプレート(またはビュー)を参照してください。

    Laravel view completion
  • Configuration ファサードを使用する場合、アプリケーションの設定で定義されているさまざまなキーを参照します。

    Laravel configuration key completion
  • Lang を使用して Lang::get()を呼び出すときに、さまざまな翻訳キーを完成させます。

    Laravel translation key completion

コードナビゲーション

アイテムの宣言に移動するには、キャレットをその使用方法に合わせて Ctrl+Bを押します。または、Ctrl+Click の使用箇所。

  • コントローラーの宣言に移動します。

    Navigate to Laravel controller declaration
  • Bladeテンプレート(またはビュー)宣言に移動します。

    Navigate to Blade template declaration
  • 構成エントリまたはサービスの宣言に移動します。

    Navigate to configuration entry or service declaration
  • 翻訳キーの宣言に移動します。

    Navigate to translation key declaration

ライブテンプレートでコードを生成する

PhpStormは、多数のコード生成機能を提供します。PhpStorm Laravelライブテンプレート(英語)をダウンロードしてインストールした後、次のようなLaravel固有のライブテンプレートで標準ライブテンプレートセットを拡張できます。

  • Blade ディレクティブ

  • 入力スニペットとリクエストスニペット

  • Cookieスニペット

  • ルートスニペットと生成

  • テンプレートの表示、応答、リダイレクト

  • スキーマの構築 (列タイプを含む)

  • キャッシュ

  • フォームとセッションのスニペット

  • さまざまなヘルパーを呼び出すスニペット

Bladeテンプレートのサポート

開始する前に、Bladeプラグインがインストールされ、有効になっていることを確認してください。プラグインはデフォルトで有効になっています。プラグインが無効になっている場合は、プラグインを管理する説明に従って、プラグインページで有効にします。

PhpStormは、Laravel Bladeテンプレートエンジン(英語)の完全なサポートを提供します。これは、さまざまなBlade構文構造、およびテンプレート内のHTML、JavaScript、CSSコードを強調しています。

構文の強調表示のほかに、PhpStormは他のいくつかのブレード固有の機能を提供します。

波括弧およびディレクティブ用のコード補完

PhpStormのエディターは、言語 & フレームワーク | PHP | Blade設定/環境設定ダイアログ Ctrl+Alt+S で定義できる標準およびカスタムBladeディレクティブの両方にコード補完を提供します。

Laravel Blade directive completion

@for または @foreach ディレクティブを使用すると、コード補完による変数の導入がコンストラクトの本体内で使用可能になります。

Laravel Blade variable introduction completion

セクションのサポート

Bladeテンプレートでの作業中に、@section ディレクティブを使用してセクションを開くことができます。PhpStormは、プロジェクト内のすべての既知のセクションの名前にコード補完 Ctrl+Space を提供します。

Laravel Blade section completion

PhpStormは、@stop ディレクティブを使用して閉じられていないセクションを検出するコードインスペクションを提供します。

Laravel Blade closed section inspection

セクションの宣言に移動するには、キャレットをその使用方法に合わせて Ctrl+Bを押します。または、Ctrl+Click の使用箇所。

Laravelプラグインは、エディターガターにマーカーを追加して、親セクションに移動することもできます。

Navigate to the parent section via the gutter icon

コード補完と拡張とインクルード用のナビゲーション

Bladeテンプレートはしばしば小さな再利用可能なブロックのさまざまなインクルードで構成されていて、それらは順番に他のテンプレートです。また、テンプレートを拡張して追加のセクションにコンテンツを提供することもできます。PhpStormおよびLaravelプラグインは、@extends ディレクティブと @include ディレクティブの両方でテンプレート名の補完を提供します。補完候補には、テンプレートのディレクトリ名と完全なテンプレート名が含まれます。

Laravel Blade @extends directive completion

テンプレートの宣言に移動するには、キャレットをその使用方法に合わせて Ctrl+Bを押します。または、Ctrl+Click の使用箇所。

Bladeテンプレートをデバッグする

通常のPHPファイルと同じ方法でBladeテンプレートをデバッグできます。

Bladeデバッグを有効にする

  1. 設定/環境設定ダイアログ Ctrl+Alt+Sで、言語 & フレームワーク | PHP | デバッグ | テンプレートに移動し、Bladeデバッグ領域を展開します。

  2. キャッシュパスフィールドに、Blade コンパイル済みテンプレートキャッシュ(英語)フォルダーへのパスを指定します。パスを手動で入力するか、the Browse button をクリックして、表示されるダイアログで関連するフォルダーを選択します。

デバッグセッションを開始する

  • Ultimateデバッグガイドの説明に従ってデバッグセッションを開始します。最も簡単で推奨される方法はゼロコンフィギュレーションデバッグを使うことです。

    デバッグエンジンがインストールされていると、ゼロコンフィギュレーションデバッグの方法に従ってアプリケーションのデバッグを開始できます。

    1. お使いのブラウザに適したブラウザ拡張を選択してインストールしてください。

    2. PhpStormツールバーで、the Start Listening for PHP Debug Connections button を切り替えて受信PHPデバッグ接続の待機を開始するか、メインメニューから実行 | PHP デバッグ接続のリッスンを開始を選択します。

    3. コードにブレークポイントを設定してください。

    4. ブラウザの拡張機能を使用して、ブラウザでデバッグセッションを開始します。

    5. デバッグセッション中に、プログラムの状態を確認します。変数値の確認、式の評価、プログラムのステップ実行などを行います。

Bladeテンプレートを構成する

Bladeディレクティブを追加、修正、または削除する

Bladeディレクティブは、Bladeページディレクティブタブで管理されます。このタブには、現在使用可能なすべてのBladeディレクティブが一覧表示されます。パラメーターがあるディレクティブの場合は、プレフィックスとサフィックスも表示されます。起動すると、リストには事前定義されたディレクティブのみが含まれています。これらのディレクティブを編集したり、カスタムディレクティブを作成したりできます。

  1. 設定/環境設定ダイアログ Ctrl+Alt+Sで、言語 & フレームワーク | PHP | Bladeに移動します。

  2. 開いたBladeページで、ディレクティブタブに切り替えます。これには、現在利用可能なすべてのディレクティブのリストが表示されます。

    • 新しいディレクティブを定義するには、the Add button をクリックして名前フィールドにディレクティブの名前を指定します。

      新しいディレクティブにプレフィックスとサフィックスが必要な場合は、パラメーターありチェックボックスをオンにして、使用するプレフィックスとサフィックスをそれぞれ接頭辞フィールドと接尾辞フィールドに入力します。PhpStormは、自動的に括弧の開閉時に接頭辞と接尾辞を囲み、引用符を追加してコロン区切り文字 : を追加するため、パラメータは次のようになります: ("<プレフィックス>:<サフィックス>")

    • 既存のディレクティブを編集するには、リストからそれを選択して、下のフィールドの値を変更します。

      元の定義を復元するには、the Reset to defaults buttonをクリックします。

    • リストからディレクティブを削除するには、それを選択して the Remove buttonをクリックします。

Blade区切り文字を設定する

PhpStormはBladeテンプレートを認識し、指定した区切り文字に基づいてそれらのテンプレートにエラー強調表示とコード補完を提供します。

  1. 設定/環境設定ダイアログ Ctrl+Alt+Sで、言語 & フレームワーク | PHP | Bladeに移動します。

  2. 開いたBladeページで、テキスト・タグに切り替えます。タブのフィールドには、生タグ(英語)コンテンツタグ(英語)エスケープタグの開始(英語)文字と終了文字が表示されます。

  3. フィールドには、Bladeテンプレート5.8(英語)に準拠したデフォルト値が入力されます。以前のバージョンを使用している場合は、関連するカスタム区切り文字を指定することができ、PhpStormは新しい規則に従ってコーディング支援を行います。

PhpStormのartisanコマンドラインツールを使用する

コマンドラインツールとしてartisanを設定する

  1. 設定/環境設定ダイアログ Ctrl+Alt+Sで、ツール | コマンド・ライン・ツールのサポートに移動します。

  2. ツールバーの the Add button をクリックします。

  3. コマンド・ライン・ツールダイアログで、リストからSymfony コンソールに基づくツールを選択し、その可視性レベル(プロジェクトまたはグローバル)を指定します。

    the Command Line Tools dialog
  4. OKをクリックすると、ツール設定ダイアログが開きます。

    ツールエイリアスを指定し、artisan とPHP実行ファイルへのパスを指定します。

    the artisan command-line tool settings
  5. OKをクリックして変更を適用し、コマンド・ライン・ツールのサポートページに戻ります。必要に応じて、the Edit button をクリックしてツールのプロパティを編集するか、または the Edit Source button をクリックしてコマンドセットをカスタマイズします。詳細はツールのカスタマイズを参照してください。

Artisanコマンドを実行する

  • メインメニューからツール | コマンドの実行を選択するか、Ctrl を2回押します。

    開いたなんでも実行ウィンドウで、<a> <command> 形式でコマンドの呼び出しを入力します。

    コマンドの実行結果は実行ツール・ウィンドウに表示されます。

コマンドを終了する

Artisanコマンドのデバッグ

Laravelコマンドは、Commandを拡張するコントローラークラスで定義されます。コマンドをデバッグするには、コマンドが定義されているコントローラークラスファイルではなく、コマンド自体のデバッグセッションを開始することが重要です。それ以外の場合、Laravelブートストラッププロセスがスキップされ、実行が失敗します。

  1. 選択したコマンドに対応するコントローラークラスで、ブレークポイントを設定するコード行でエディターのガターをクリックします。

    Set a breakpoint in a Laravel command
  2. 選択したコマンドで artisan ツールを実行する実行/デバッグ構成を作成します。メインメニューで実行 | 構成の編集を選択し、次に the Add button をクリックして、リストからPHP スクリプトを選択します。

    Run/Debug configuration: PHP script
  3. 実行/デバッグ構成: PHP スクリプトダイアログで、実行/デバッグ構成パラメーターを指定します。

    • ファイルフィールドに、artisan 実行可能ファイルへのパスを指定します。

    • 引数フィールドに、view:cacheなどの実際のコマンドとその引数を入力します。

    Run/Debug Configurations dialog for Laravel CLI command
  4. PhpStormツールバーで、作成された実行/デバッグ構成を選択し、the Debug buttonをクリックします。コマンドの実行は、指定されたブレークポイントで停止します。

最終更新日: 2020年6月3日

関連ページ:

プラグインを管理する

プラグインはPhpStormのコア機能を拡張します。彼ら:バージョン管理システム、アプリケーションサーバー、およびその他のツールとの統合を提供する、さまざまな言語とフレームワークのコーディング支援サポートを追加する、ショートカットヒント、ライブプレビュー、ファイルウォッチャーなどで生産性を向上、コー...

Composer依存関係マネージャー

PhpStormはComposer依存マネージャーと統合されています。これにより、Packagistのパッケージをプロジェクトの依存関係として宣言し、IDEから管理することができます。PhpStormは、composer.jsonを操作するための包括的なコーディング支援と、一般的なComposerコ...

ファイル監視

ファイル監視は組み込みのPhpStormツールで、IDEでファイルを変更または保存するときにコンパイラ、フォーマッタ、linterなどのコマンドラインツールを自動的に実行できます。ファイルウォッチャーには2つの専用コードインスペクションがあります。ファイル監視使用可能インスペクションは、あらかじめ定...

コードの生成

PhpStorm provides multiple ways to generate common code constructs and recurring elements, which helps you increase productivity. These can be eitherp...

ゼロコンフィギュレーションデバッグ

ゼロコンフィギュレーションデバッグの場合、デバッグ構成を作成する必要はありません。代わりに、PHPアプリケーションの開始ページをブラウザで手動で開き、ブラウザからデバッグエンジンをアクティブにし、PhpStormは受信デバッガ接続を待機します。デバッグセッションを開始する:デバッグを開始する前に、デ...

ブラウザーのデバッグ拡張機能

デバッグを開始するには、まずサーバー上でデバッガ・エンジンをアクティブにする必要があります。これを行うには、特別なまたはパラメータを設定する必要があります(詳細については、XdebugおよびZend デバッガーの公式ドキュメントを参照してください)。手動で行うこともできますが、ブラウザの拡張機能を使...