Composer 依存関係マネージャー

新しい Composer プロジェクトを作成すると、PhpStorm は選択した Composer パッケージに基づいてプロジェクトを作成し、依存関係を解決してプロジェクトの vendor ディレクトリにインストールします。

1. PhpStorm のウェルカム画面でファイル | 新規プロジェクトを選択するか、新規プロジェクトの作成をクリックします。

   新規プロジェクトダイアログが開きます。

   

2. ダイアログで、プロジェクトのパラメーターを指定します。

   • プロジェクトの型と場所を選択してください:

     • 左側のペインで、Composer プロジェクトを選択します。

     • 右側のペインの場所フィールドに、プロジェクトを作成するフォルダーを指定します。

   • Composer コマンドの実行方法を選択します。

     • グローバルにインストールされた composer 実行可能ファイルを介してコマンドを実行するには、'composer' 実行可能ファイルを選択し、フィールドにその場所を指定します。

     • ローカルの composer.phar アーカイブを介してコマンドを実行するには、composer.phar を選択します。次に、フィールドに既存の composer.phar ファイルの場所を指定するか、getcomposer.org から composer.phar をダウンロードするチェックボックスを選択してファイルの新しいインスタンスをダウンロードします。ダウンロードした composer.phar ファイルはプロジェクトのルートフォルダーに保存されます。

       次に、PHP インタープリターリストから設定されたローカル PHP インタープリターの 1 つを選択します。詳細は、ローカル PHP インタープリターを構成するを参照してください。

     必要に応じて、コマンドラインパラメーターフィールドに追加のコマンドラインパラメーターを入力します。

   • パッケージ領域で、パッケージフィールドに目的のパッケージの名前を入力します。コード補完を使用するには、Ctrl+Space を押します。次に、インストールするバージョンリストから関連するバージョンを選択します。

3. 作成をクリックします。選択したパッケージとともに create-project(英語) Composer コマンドが呼び出されます。結果として、Composer プロジェクトが作成され、その構成と構造は選択したパッケージに依存します。その後、作成された PhpStorm プロジェクトが開きます。

プロジェクトで Composer を初期化すると、composer.json が作成されます。このファイルには、プロジェクトの依存関係とその他のメタデータが一覧表示され、プロジェクトのデフォルトとして自動的に設定されます。

1. メインメニューからツール | Composer | Composer 初期化を選択します。

   Composer 設定ダイアログが開きます。

   

2. Composer コマンドの実行方法を選択します。

   • グローバルにインストールされた composer 実行可能ファイルを介してコマンドを実行するには、'composer' 実行可能ファイルを選択し、フィールドにその場所を指定します。

   • ローカルの composer.phar アーカイブを介してコマンドを実行するには、composer.phar を選択します。次に、フィールドに既存の composer.phar ファイルの場所を指定するか、getcomposer.org から composer.phar をダウンロードするチェックボックスを選択してファイルの新しいインスタンスをダウンロードします。ダウンロードした composer.phar ファイルはプロジェクトのルートフォルダーに保存されます。

     次に、PHP インタープリターリストから設定されたローカル PHP インタープリターの 1 つを選択します。詳細は、ローカル PHP インタープリターを構成するを参照してください。

   • リモートインタープリターを介してコマンドを実行するには、リモートインタープリターを選択してください。

     • CLI インタープリターリストから、使用するリモートインタープリターを選択するか、または をクリックしてリモート PHP インタープリターの構成の説明に従って新しいものを設定します。

       ほとんどの場合、PhpStorm はパスマッピングを自動的に検出します。必要に応じて、パスマッピングフィールドの をクリックして、開いたプロジェクトパスマッピングの編集で手動で指定できます。

     • 実行可能な Composer フィールドに、Composer 実行可能ファイルの名前を入力します。 をクリックして、表示されるサーバー上のパスを選択ダイアログで実行可能ファイルを見つけることができます。

3. OK をクリックして、Composer 設定ダイアログを閉じます。PhpStorm は composer.json スタブファイルを作成し、エディターで開きます。

   

   コードを完成するか、生成された値を受け入れます。 composer.json ファイルの操作の詳細については、Composer.json: プロジェクトセットアップ(英語)を参照してください。

既存の Composer プロジェクトを開くと、PhpStorm は composer.json ファイルに含まれている情報を使用して、プロジェクトのコンテンツルートや PHP 言語レベルなどの特定の設定オプションを自動的に適用します。

1. ウェルカム画面で開くをクリックするか、メインメニューからファイル | 開くを選択してから、Composer プロジェクトが保存されているフォルダーを選択します。

   PhpStorm は通知を表示します:

   

2. Composer の設定を初期化するをクリックします。開いている Composer ダイアログで、composer.json ファイルの場所を指定します。PhpStorm が既存のファイルを検出すると、composer.json のパスフィールドは自動的に入力されます。

   

3. プロジェクト設定を構成します。

   • デフォルトでは、vendor/*/* ディレクトリ下のすべてのパッケージはプロジェクトから除外され、write-protected ライブラリとして追加されます。編集から保護するには、パッケージをライブラリとして追加するチェックボックスを選択したままにします。それ以外の場合は、vendor/*/* で Composer パッケージを編集する場合は、パッケージをライブラリとして追加するチェックボックスをオフにします。

   • composer.json と IDE 設定を同期するチェックボックスが選択されていることを確認して、PHP 言語レベルを自動的に検出し、composer.json の設定に基づいてプロジェクトのソースとテストのルートを設定します。

     PhpStorm は PSR-0 / PSR-4 ソースルートとそれらの名前空間プレフィックスを認識しています。 autoload セクションに基づいてソースルート を設定し、autoload-dev セクションに基づいてテストルート を設定します。PhpStorm は require セクションの php 設定に基づいて PHP 言語レベルも検出します。

     composer.json にはプロジェクト構成に関する最新の情報が含まれているため、この自動同期によって Source フォルダーと Test フォルダーがプロジェクト構造と完全に一致し、正しい PHP 言語レベルが自動的に設定されます。

     PSR とオートロードの詳細については、Composer オフィシャル Web サイト(英語)を参照してください。同期設定の例と詳細については、PhpStorm ブログ投稿(英語)を参照してください。コンテンツルートの設定の詳細については、コンテンツルートを参照してください。

   • 利用可能なパッケージアップデートを取得し、より優れた composer.json でのコーディング支援を提供するために、PhpStorm は、プロジェクトを開くか composer.json を変更するたびに、バックグラウンドで --dry-run を更新(英語)コマンドを実行します。必要に応じて、利用可能なパッケージの更新を確認するチェックボックスをオフにすることでコマンドの実行を無効にできます。

   OK をクリックして、指定したプロジェクト設定を適用し、ダイアログを閉じます。

4. Composer コマンドの実行を設定する:

   • 以下のいずれか 1 つを実行します:

     • 設定 / 環境設定ダイアログ Ctrl+Alt+S で、言語およびフレームワーク | PHP | Composer に移動します。

     • プロジェクトに単一の composer.json ファイルがある場合は、メインメニューからツール | Composer | インストールを選択して Composer 設定ダイアログを開きます。

   • Composer コマンドの実行方法を選択します。

     • グローバルにインストールされた composer 実行可能ファイルを介してコマンドを実行するには、'composer' 実行可能ファイルを選択し、フィールドにその場所を指定します。

     • ローカルの composer.phar アーカイブを介してコマンドを実行するには、composer.phar を選択します。次に、フィールドに既存の composer.phar ファイルの場所を指定するか、getcomposer.org から composer.phar をダウンロードするチェックボックスを選択してファイルの新しいインスタンスをダウンロードします。ダウンロードした composer.phar ファイルはプロジェクトのルートフォルダーに保存されます。

       次に、PHP インタープリターリストから設定されたローカル PHP インタープリターの 1 つを選択します。詳細は、ローカル PHP インタープリターを構成するを参照してください。

     • リモートインタープリターを介してコマンドを実行するには、リモートインタープリターを選択してください。

       • CLI インタープリターリストから、使用するリモートインタープリターを選択するか、または をクリックしてリモート PHP インタープリターの構成の説明に従って新しいものを設定します。

         ほとんどの場合、PhpStorm はパスマッピングを自動的に検出します。必要に応じて、パスマッピングフィールドの をクリックして、開いたプロジェクトパスマッピングの編集で手動で指定できます。

       • 実行可能な Composer フィールドに、Composer 実行可能ファイルの名前を入力します。 をクリックして、表示されるサーバー上のパスを選択ダイアログで実行可能ファイルを見つけることができます。

5. プロジェクトの依存関係をインストールします。

   • プロジェクトに単一の composer.json ファイルがある場合は、メインメニューからツール | Composer | インストールを選択します。

   • それ以外の場合、複数の composer.json ファイルがある場合は、関連するファイルのコンテキストメニューから Composer | インストールを選択します。PhpStorm プロジェクトでデフォルトの composer.json を指定するも参照してください。

   エディターで composer.json ファイルを開き、エディターパネルの上部にあるインストールショートカットリンクをクリックすることもできます。

1 つの PhpStorm プロジェクトに複数の composer.json ファイルを含めることができます。 composer.json ごとに、エディターまたはプロジェクトビューのコンテキストメニューから、またはエディターパネル上部のショートカットリンクを使用してアクションが呼び出されます。PhpStorm プロジェクトにデフォルトの composer.json を指定することもできます。そのための Composer アクションは、ツール | Composer メインメニュー項目から呼び出されます。

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

2. デフォルトの composer.json の場所を指定します。PhpStorm プロジェクトに 1 つの Composer 設定ファイルがある場合、composer.json のパスフィールドは自動的に入力されます。

3. デフォルトでは、vendor/*/* ディレクトリ下のすべてのパッケージはプロジェクトから除外され、write-protected ライブラリとして追加されます。編集から保護するには、パッケージをライブラリとして追加するチェックボックスを選択したままにします。

   それ以外の場合は、vendor/*/* で Composer パッケージを編集する場合は、パッケージをライブラリとして追加するチェックボックスをオフにします。

4. composer.json と IDE 設定を同期するチェックボックスが選択されていることを確認して、PHP 言語レベルを自動的に検出し、composer.json の設定に基づいてプロジェクトのソースとテストのルートを設定します。

   PhpStorm は PSR-0 / PSR-4 ソースルートとそれらの名前空間プレフィックスを認識しています。 autoload セクションに基づいてソースルート を設定し、autoload-dev セクションに基づいてテストルート を設定します。PhpStorm は require セクションの php 設定に基づいて PHP 言語レベルも検出します。

   composer.json にはプロジェクト構成に関する最新の情報が含まれているため、この自動同期によって Source フォルダーと Test フォルダーがプロジェクト構造と完全に一致し、正しい PHP 言語レベルが自動的に設定されます。

   PSR とオートロードの詳細については、Composer オフィシャル Web サイト(英語)を参照してください。同期設定の例と詳細については、PhpStorm ブログ投稿(英語)を参照してください。コンテンツルートの設定の詳細については、コンテンツルートを参照してください。