Composer依存マネージャー

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

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

   

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

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

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

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

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

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

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

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

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

   • パッケージ領域で、リストからパッケージを選択し、インストールするバージョンリストから該当するバージョンを選択します。パッケージを検索するには、パッケージをフィルター検索フィールドを使用します。

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

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.json エディターパネル上部のショートカットリンクを使用して、プロジェクトの依存関係を素早くインストールまたは更新し、Composerログを開き、追加のコマンドにアクセスします。

1つのPhpStormプロジェクトに複数の composer.json ファイルを置くことができます。各 composer.jsonについて、アクションは、エディターまたはプロジェクトビューのコンテキストメニュー、またはエディターパネルの上部にあるショートカットリンクを使用して呼び出されます。

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

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

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

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

   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. 設定/環境設定ダイアログ 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 と IDE 設定を同期するチェックボックスが選択されていることを確認して、PHP言語レベルを自動的に検出し、composer.jsonの設定に基づいてプロジェクトのソースとテストのルートを設定します。

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

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

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

特定のパッケージをインストールする

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

   • composer.json コンテキストメニューからComposer | 依存性の管理を選択します。

   • デフォルトのcomposer.jsonからパッケージをインストールするには、メインメニューからツール | Composer | 依存性の管理を選択します。

2. 表示されたComposerの依存関係を管理するダイアログで、使用可能なパッケージリストから必要なパッケージを選択します。パッケージを検索するには、検索フィールドを使用します。リストには利用可能なパッケージがすべて表示されます。すでにインストールされているパッケージにはチェックマークが付いています。

   インストールするバージョンリストから該当するバージョンを選択します。

3. 必要に応じて、パッケージのインストールをカスタマイズします。コマンド・ライン・パラメーターフィールドに、追加のコマンド行パラメーターを入力します。

4. 「 インストール」をクリックしてインストールを開始します。ダイアログを終了するには、閉じるをクリックします。

パッケージがインストールされると、PhpStormは vendor に新しいサブフォルダーを作成し、このサブフォルダーに新しいパッケージを保管します。対応するパッケージレコードは、composer.json ファイルの require または require-dev セクション、およびcomposer.lock(英語)ファイルに追加されます。

一度にすべてのパッケージをインストールする

以下のいずれかを行います。

• composer.json コンテキストメニューからComposer | インストールを選択します。

• エディターで composer.json を開き、エディターパネルの上部にある Install shortcutリンクをクリックします。

• デフォルトのcomposer.jsonにリストされているすべてのパッケージをインストールするには、メインメニューからツール | Composer | インストールを選択します。

PhpStormは、composer.json ファイルの require および require-dev セクションにリストされているすべてのパッケージをインストールします。

特定のパッケージを更新する

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

   • composer.json コンテキストメニューからComposer | 依存性の管理を選択します。

   • デフォルトのcomposer.jsonからパッケージを更新するには、メインメニューから ツール | Composer | 依存性の管理 を選択します。

2. チェックマークが付いたパッケージの中から使用可能なパッケージリストから必要なパッケージを選択し、更新をクリックします。

一度にすべてのパッケージを更新する

以下のいずれかを行います。

• composer.json コンテキストメニューからComposer | 更新を選択します。

• エディターで composer.json を開き、エディターパネル上部の更新ショートカットリンクをクリックします。

• デフォルトのcomposer.jsonにリストされているすべてのパッケージを更新するには、メインメニューからツール | Composer | インストールを選択します。

PhpStormは、composer.json ファイルの require および require-dev セクションにリストされているすべてのパッケージを更新します。

1. 以下のいずれかを行います。

   • composer.json コンテキストメニューからComposer | 依存性の管理を選択します。

   • デフォルトのcomposer.jsonにリストされているパッケージをアンインストールするには、メインメニューからツール | Composer | 依存性の管理を選択します。

2. 使用可能なパッケージリストで、目盛り付きのパッケージからアンインストールするパッケージを選択し、除去をクリックします。

パッケージがアンインストールされると、PhpStormは require または composer.json の require-dev セクションを自動的に更新します。

Composerログを開く

以下のいずれかを行います。

• 最初にComposerコマンドを実行した後、イベント・ログ通知メッセージのログに表示する ショートカットリンクをクリックします。

  

• エディターで composer.json を開き、エディターパネル上部のログの表示ショートカットリンクをクリックします。

折りたたまれたComposerログメッセージを見る

Composerコマンドが正常に実行された場合、Composerログはその実行の詳細をフォールドします。

• ガターの をクリックして、メッセージを展開します。

• 省略記号の上にマウスを置くと、メッセージがツールチップで表示されます。

  

PhpStormは、一連の追加のComposerコマンド用のユーザーインターフェースを提供します。

• composer.json コンテキストメニューからComposer | <コマンド名>を選択します。

• エディターで composer.json を開き、composer.json エディターパネルの上にある をクリックして、リストから目的のコマンドを選択します。

• デフォルトのcomposer.jsonのコマンドを実行するには、メインメニューから ツール | Composer | <コマンド名> を選択します。

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

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

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

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

   

4. OKをクリックすると、ダイアログが開きます。

   composer.pharまたはphpスクリプトまたはcomposer実行可能ファイルのいずれかのオプションを選択して、Composerの起動方法を指定します。選択に応じて、PHPインストールフォルダーと composer.phar、または composer 実行可能ファイルへのパスを指定します。

   PhpStormは、指定された .phar アーカイブまたはComposerコマンドの実行可能ファイルの内容を解析します。ファイル解析が完了すると、PhpStormはコマンドラインツールのサポートページに戻り、指定されたファイルがPhpStormで使用可能なコマンドラインツールのリストに追加されます。

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

Composerコマンドを実行する

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

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

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

  

コマンドを終了する

• 実行ツール・ウィンドウツールバーの をクリックします。