Drupal
PhpStorm は、Drupal モジュール、テーマ、コアの開発を含む Drupal(英語) 開発用の IDE として使用できます。サポートされているバージョンは 6、7、8、9 です。
PhpStorm で Drupal サポートを有効にする
オプション 1: PhpStorm 設定で Drupal サポートを有効にする
(Ctrl+Alt+S) を開きます。
ノードを拡張し、Drupal 統合を使用可能にするチェックボックスを選択し、次のようにパラメーターを指定します。
Drupal インストールパス
インストールされた Drupal コアが含まれるルートディレクトリへのパスを指定します。
PHP を設定する | パスを含める
チェックボックスを選択すると、PhpStorm によって Drupal コアディレクトリがプロジェクトのインクルードパスに自動的に追加されます。
パスを手動で構成するには、 (Ctrl+Alt+S) を開き、インクルードパスタブでディレクトリのリストを編集します。
バージョン
使用する Drupal のバージョンを選択します。サポートされているバージョンは 6、7、8、9 です。
変更を保存するには、適用をクリックします。
オプション 2: Drupal テンプレートから新しい PhpStorm プロジェクトを作成する
Drupal モジュールテンプレートから PhpStorm に新しい Drupal プロジェクトを作成できます。
PhpStorm は、選択した Drupal バージョンに応じてプロジェクトスタブを生成し、構成します。Drupal 8 の場合、module_name.info.yml ファイルが生成されます。
メインメニューでを選択するか、PhpStorm のウェルカム画面で新規プロジェクトの作成をクリックして、新規プロジェクトダイアログを開きます。
左側のペインで、Drupal モジュールを選択します。
右側のペインで、Drupal サポートパラメーターを指定します。
オプション 3: 既存の Drupal モジュールプロジェクトをインポートする
PhpStorm で既存の Drupal モジュールプロジェクトを開くと (メインメニューの)、IDE は Drupal 固有のプロジェクト構造を認識し、Drupal サポートを有効にすることを提案します。
Drupal サポートを有効にするをクリックしてモーダルダイアログを開き、パラメーターを指定します。
Drupal ファイルを PHP タイプに関連付ける
適切なコードハイライトを提供するには、PhpStorm は Drupal ファイル形式を PHP ファイルタイプに関連付ける必要があります。
PhpStorm で Drupal プロジェクトを開くと、IDE はプロジェクトタイプを自動的に検出し、Drupal ファイルタイプを PHP タイプに関連付けることを提案します。
ファイルタイプを手動で関連付ける
設定ダイアログ (Ctrl+Alt+S) で、に移動します。
開いたファイルタイプページで、認識されたファイルタイプリストから PHP を選択します。
右側のファイル名のパターン領域で (
) をクリックし、*.test、*.install、*.engine、*.profile、*.themeファイル名パターンを 1 つずつ追加します。
詳細は、ファイルタイプの関連付けを参照してください。
PhpStorm で Drupal フックを使用する
PhpStorm は、.module ファイル内の Drupal フック(英語)を完全にネイティブにサポートします。
フック宣言にはコード補完を使用します。
PhpStorm は任意のフック呼び出しを索引付けし、フック実装を作成するためにフック名がコード補完で使用可能になります。宣言を補完するには、フック名の入力を開始し、Ctrl+Space を押します。
フック呼び出しに移動します。
エディターからフックの呼び出しに移動するには、ガターの
アイコンをクリックします。複数の呼び出しの場合、PhpStorm は使用可能なフック呼び出しのリストを表示し、移動する呼び出しを選択できます。
関連するフックが
module_invoke_all()、module_invoke()、drupal_alter()で呼び出される行に移動します。
フックのドキュメントを表示します。
フックの名前にキャレットを置き、を選択するか、Ctrl+Q を押します。
PhpStorm プロジェクトで Drupal コードスタイルを設定する
PhpStorm がプロジェクトを Drupal モジュールとして認識した場合、または既存のプロジェクトで Drupal 統合が有効になっている場合、または Drupal モジュールテンプレートから新しいプロジェクトを作成すると、PhpStorm は事前設定された Drupal コーディング標準 (コードスタイル) を適用することを自動的に提案します。
コードスタイル設定を手動で変更する
コードスタイル: PHP ページで定義済みのコードスタイルを手動で設定することもできます。
設定ダイアログ (Ctrl+Alt+S) で、 に移動します。
選択して設定をクリックし、表示されるドロップダウンリストから Drupal を選択します。
該当する場合は、ページ上のコントロールを使用してコードスタイルをカスタマイズします。
Drupal コーディング標準に照らしてコードをチェックする
PhpStorm では、PHP_CodeSniffer ツールを使用して、PHP_CodeSniffer に Drupal 固有の標準セットを提供する Coder(英語) と組み合わせて、コーディング標準の問題を検出できます。これにより、コードがクリーンで一貫性があり、一般的なエラーがなくなります。
始めるには、PHP_CodeSniffer をインストールして構成するで説明されている手法を使用して PHP_CodeSniffer をインストールします。おそらく最も簡単な方法は、Composer でインストールすることです。
PHP_CodeSniffer をインストールする
composer.json 内で、
squizlabs/php_codesniffer依存関係レコードをrequireキーまたはrequire-devキーに追加します。パッケージ名とバージョンのコード補完を取得するには、Ctrl+Space を押します。以下のいずれか 1 つを実行します:
エディターパネルの上部にあるインストールショートカットリンクをクリックします。
インストールされていない Composer パッケージインスペクションが有効になっている場合、PhpStorm は、現在インストールされていない宣言済みの依存関係をハイライトします。Alt+Enter を押して、特定の依存関係をインストールするか、すべての依存関係を一度にインストールするかを選択します。
次に、Drupal 固有の標準を PHP_CodeSniffer に提供する Coder をインストールします。
Coder をインストールする
composer.json 内で、
drupal/coder依存関係レコードをrequireキーまたはrequire-devキーに追加します。パッケージ名とバージョンのコード補完を取得するには、Ctrl+Space を押します。以下のいずれか 1 つを実行します:
エディターパネルの上部にあるインストールショートカットリンクをクリックします。
インストールされていない Composer パッケージインスペクションが有効になっている場合、PhpStorm は、現在インストールされていない宣言済みの依存関係をハイライトします。Alt+Enter を押して、特定の依存関係をインストールするか、すべての依存関係を一度にインストールするかを選択します。
Coder パッケージがインストールされ、対応する Drupal 標準が PHP_CodeSniffer 検証インスペクション用に自動的に選択されます。必要に応じて、設定ダイアログ (Ctrl+Alt+S) のページでインスペクションをさらにカスタマイズできます。詳細については、PHP_CodeSniffer を PhpStorm インスペクションとして有効にするを参照してください。
PhpStorm の Drupal API ドキュメントを見る
PhpStorm エディターで、目的のシンボルを選択してコンテキストメニューから Drupal API の検索を選択します。Drupal API ドキュメント(英語)が開きます。
PhpStorm の Drush コマンドラインツールを使用する
PhpStorm は、Drush コマンドラインシェルおよびスクリプトインターフェースバージョン 5.8 以降と統合されます。開始する前に、公式の Drush ドキュメント(英語)の説明に従って、Drush をダウンロードしてインストールしてください。
Drush を自動的に設定する
Drupal プロジェクトに Composer 依存関係をインストールすると、PhpStorm は Drush を自動的に検出して構成し、Composer ログに該当する通知を表示します。
ツールをカスタマイズする場合は、ガターの
をクリックして、PHP コマンドラインツールのサポート設定ページにすぐに移動します。
Drush を手動で設定する
設定ダイアログ（Ctrl+Alt+S）で、に移動します。
ツールバーの
をクリックします。コマンドラインツールダイアログで、リストから Drush を選択し、その可視性レベル（プロジェクトまたはグローバル）を指定します。
OK をクリックすると、Drush ダイアログが開きます。
Drush 実行可能ファイルへのパスを指定してください。デフォルトの場所は通常、Windows では C:/ProgramData/Drush/drush.bat、macOS または Linux では /usr/bin/drush です。標準のインストール手順に従った場合は、OK をクリックして事前定義パスを受け入れます。
カスタムインストールの場合は、Drush 実行ファイルへのパスを入力し、OK をクリックします。
「OK」をクリックして変更を適用し、「PHP コマンドラインツールのサポート」ページに戻ります。必要に応じて、
をクリックしてツールのプロパティを編集するか、
をクリックしてコマンドセットをカスタマイズします。詳細については、ツールをカスタマイズするを参照してください。
Drush コマンドを実行する
に移動するか、Ctrl を 2 回押します。
開いたなんでも実行ウィンドウで、
<drush> <command>形式でコマンドの呼び出しを入力します。コマンドの実行結果は実行ツールウィンドウに表示されます。
コマンドを終了する
実行ツールウィンドウツールバーの
をクリックします。
Drush コマンドのデバッグ
Drupal コマンドは、DrushCommands を拡張するコントローラークラスで定義されます。コマンドをデバッグするには、コマンドが定義されているコントローラークラスファイルではなく、コマンド自体のデバッグセッションを開始することが重要です。そうしないと、Drupal ブートストラッププロセスがスキップされ、実行が失敗します。
選択したコマンドに対応するコントローラークラスで、ブレークポイントを設定するコード行でエディターのガターをクリックします。
選択したコマンドで drush ツールを実行する実行 / デバッグ構成を作成します。メインメニューで、に移動し、
をクリックして、リストから PHP スクリプトを選択します。
PHP スクリプトダイアログで、実行 / デバッグ構成パラメーターを指定します。
ファイルフィールドに、drush 実行可能ファイルへのパスを指定します。
引数フィールドに、
statusなどの実際のコマンドとその引数を入力します。
PhpStorm ツールバーで、作成された実行 / デバッグ構成を選択し、
をクリックします。コマンドの実行は、指定されたブレークポイントで停止します。
Drupal 8 を Symfony で使用する
PhpStorm は、Drupal バージョン 8 と Symfony の間の密接な統合を提供します。この統合により、Symfony コンポーネントは Drupal インフラストラクチャに接続されます。この統合を利用するには:
Drupal Symfony Bridge プラグインをインストールする
設定ダイアログ (Ctrl+Alt+S) で、プラグインのページに移動します。リポジトリの参照をクリックし、プラグインを選択して、インストールをクリックします。詳細については、プラグインのインストールを参照してください。
アノテーションを有効にする
高度なアノテーションをサポートするには、プラグインのインストールの説明に従って PHP アノテーションプラグイン(英語)をインストールします。
Drupal 8 のコーディング支援 - symfony 統合は利用可能ですか ?
Drupal 固有の t() 関数(英語)内での使用に適した文字列は、プロジェクト全体に索引付けされ、完了のために提供されます。
url()(英語) およびその他の Drupal API 関数の関連する yml キー値の補完。正しい値の検索が容易になります。
Ctrl+B を押すか移動 | 宣言に移動を選択して、yml ファイルに移動します。
Ctrl+B での補完とナビゲーションを含む、yml ファイルで記述されたサービスコンテナー(英語)の完全なサポート。
Drupal 機能の補完、ナビゲーション、認識など、Drupal 8 のデフォルトテンプレートエンジンである Twig テンプレートエンジン(英語)のサポート。Drupal 8 の Twig(英語) も参照してください。
関連ページ：
インクルードパスの構成
インクルードパスは、ライブラリを保持するために使用されます。つまり、ファイルパスを引数として使用する一部の関数 / メソッド (例: または) で補完および参照解決に使用されるサードパーティコードです。インクルードパスを介して追加されたファイルは、プロジェクトのスコープ内で編集するためのものではないことに注意してください。複数のプロジェクト内からアクセスおよび変更する必要がある既存のコードがある場合は、追加のコンテンツルートを介して追加することを検討してください。インクルードパスの構成設定ダイアロ...
新規プロジェクトを作成する
新規プロジェクトダイアログから (メインメニューの、または PhpStorm へようこそ) ダイアログ | 新規プロジェクト)、次のものを作成できます。PHP 空プロジェクト。オンボーディングのヒントが含まれた PhpStorm ワークショッププロジェクト。フレームワークベースのプロジェクト。PhpStorm はアプリケーション scaffold を生成し、それぞれの PHP または Web フレームワークに必要なパッケージをインストールします。新しい PHP の空のプロジェクト：ファイル | 新規...
ファイルタイプの関連付け
PhpStorm は、さまざまな言語やテクノロジを表すファイルの言語固有の機能（構文のハイライトやコード分析など）について、ファイルタイプのリストを保持します。各ファイルタイプは、言語サービスを 1 つ以上のファイル名パターンにリンクします。ファイルタイプのデフォルトリストには、関連するすべてのファイル名パターンが含まれていますが、カスタム言語ファイルに新しいファイルタイプを追加したり、既存のファイルタイプに関連付けられたファイル名パターンを変更したりできます。エディターでファイルを開くと、Ph...
コードスタイル: PHP
このページを使用して、PHP ファイルのフォーマットオプションを設定します。これらの設定を変更すると、プレビューペインに、コードへの影響が表示されます。選択して設定 ...：このリンクをクリックして、現在の言語コードスタイルのベースとして使用する言語を選択します。リストには 2 つのオプションが含まれています。言語: 他の言語からコーディングスタイル設定を継承するには、このオプションを選択します。表示されたリストから原言語を選択します。現在の言語に適用可能な設定のみが採用されます。他のすべての設...
PHP_CodeSniffer
PhpStorm は、PHP_CodeSniffer ツールとの統合を通じてコードスタイルチェックを提供します。ツールは選択したコーディング標準との整合性についてコードを検証します。事前定義されたコーディング標準の 1 つを指定するか、デフォルトの PHP_CodeSniffer の Standards ディレクトリの外側にあるルートディレクトリで、以前に定義した独自のコーディング標準を使用できます。さらに、カスタムコーディングスタイルをチームと共有できます。コマンドラインの代わりに PhpStorm...
Composer 依存関係マネージャー
PhpStorm は Composer 依存関係マネージャーと統合されています。これにより、Packagist またはカスタムリポジトリからのパッケージをプロジェクトの依存関係として宣言し、IDE から管理できます。PhpStorm は以下を提供します。一般的な Composer コマンド (init、install、update) と、その他の Composer コマンドを実行するための専用ユーザーインターフェース。コマンド出力は Composer ログコンソールに表示されます。PhpStorm プロ...