Composer 依存関係マネージャー

PhpStorm で Composer が管理するプロジェクトを開く

既存の Composer 管理プロジェクトを開くと、PhpStorm は composer.json ファイルに含まれる情報を使用して、プロジェクトのコンテンツルートおよび PHP 言語レベルを自動的に適用します。

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

   PhpStorm がプロジェクトを開き、通知を表示します。

   

2. Composer の設定を開くをクリックして Composer ダイアログを開き、必要に応じてプロジェクト設定を構成します。

   

   • composer.json のパス : PhpStorm は、プロジェクトルートにある composer.json ファイルを自動的に検出します。 をクリックして、プロジェクト内の別の composer.json ファイルへのパスを指定します。

   • パッケージをライブラリとして追加する : チェックボックスをオフにして、書き込み保護されたサードパーティのライブラリおよび PHP インクルードパスとして vendor/*/* ディレクトリにパッケージを追加することを無効にします。

   • composer.json と IDE 設定を同期する : チェックボックスをオフにして、プロジェクトの PHP 言語レベルとソースおよびテストルートと composer.json の設定との自動同期をオフにします。

   • 利用可能なパッケージの更新を確認する : update --dry-run command の実行を無効にするには、チェックボックスをオフにします。

     利用可能なパッケージの更新を取得し、より優れた composer.json でのコーディング支援を提供するために、プロジェクトを開くか composer.json を変更するたびに、PhpStorm はバックグラウンドで --dry-run を更新(英語)コマンドを実行します。

   • クイックアクションで composer.json トップパネルを表示する : チェックボックスをオフにすると、エディターで composer.json ファイルの上部にあるクイックアクションパネルが非表示になります。

   • 'ベンダー' ディレクトリがないことを通知する : プロジェクトに vendor ディレクトリがないことに関する通知をオフにするには、チェックボックスをオフにします。

   • --ignore-platform-reqs でインストール / 更新を実行する : PhpStorm プロジェクトに無効な PHP インタープリターバージョンがあるか、PHP 拡張機能またはライブラリが欠落している場合でも、チェックボックスを選択して、composer.json で指定された依存関係をインストールまたは更新します。

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

3. 次のいずれかの方法で、composer.json からプロジェクトの依存関係をインストールします。

   • PhpStorm がプロジェクトを開き、そこに vendor ディレクトリがないことを検出したときにポップアップするバルーン通知で実行 'composer install' をクリックします。

     

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

     

   • メインメニューからツール | Composer | インストールを選択するか、プロジェクトツールウィンドウの composer.json ファイルのコンテキストメニューから Composer | インストールを選択します。

   composer.json で依存関係として宣言されたサードパーティライブラリは、プロジェクト内の vendor ディレクトリにインストールされます。

プロジェクトで composer.json ファイルを管理するには:

• 設定ダイアログ (Ctrl+Alt+S) で、PHP に移動し、Composer ファイルタブを選択します。

  IDE によって検出された composer.json ファイルのリストが開きます。PhpStorm は、プロジェクトのルートディレクトリの composer.json ファイルを、デフォルトでプロジェクトのメインとしてマークします。

  

  タブのツールバー ( 、、) のアイコンを使用して、次の操作を行います。

  • プロジェクトルートにあるもの以外のプロジェクトのメイン composer.json ファイルを指定します。

    メイン項目を選択し、 をクリックして、開いたファインダーで必要な composer.json ファイルへのパスを指定します。

  • プロジェクトごとに複数の composer.json ファイルを構成します。

    および アイコンを使用して、サブディレクトリごとに Composer 構成ファイルを追加または削除します。

composer.json ファイルを作成する

composer.json ファイルは手動で作成できます。プロジェクト内で Composer がまだ初期化されていない場合、新しく作成された composer.json がプロジェクトのメイン Composer ファイルとして自動的に設定されます。

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

   • プロジェクトツールウィンドウ (Alt+1) で、新しいファイルを作成するディレクトリを選択し、メインメニューからファイル | 新規を選択します。

   • ディレクトリを右クリックし、コンテキストメニューから新規を選択します。

   • ディレクトリを選択し、Alt+Insert を押します。

2. ポップアップメニューで、composer.json ファイルを選択します。PhpStorm は composer.json ファイルのスタブを作成し、それをエディターで開きます。

composer.json でコード補完を使用する

• composer.json 内で、セクションの名前とコンテンツの両方を提供するときに Ctrl+Space を押してコード補完を使用します。例:

  • ライセンスの種類と最低安定バージョン

  • autoload および autoload-dev セクションの名前空間とパス

  • require および require-dev セクションの必須の PHP バージョンと拡張機能、およびパッケージの名前とバージョン。

  

composer.json のクイックドキュメントを使用する

• composer.json 内で Ctrl+Q を押すと、キャレットにある要素のクイックドキュメントが表示されます。

  

composer.json レコードからプロジェクトエンティティまたは設定に移動する

• composer.json 内で、インストールされたパッケージ、スクリプト内のクラスまたはメソッド、ファイルパス、URL などのエンティティにキャレットを置きます。次に下記のいずれかを実行します。

  • メインメニューから移動 | 宣言または使用箇所を選択します

  • ボタン Ctrl+B

  または、Ctrl+Click レコード。

  

• テストフレームワークまたはコード品質ツールがプロジェクトの依存関係としてインストールされている場合、PhpStorm は対応する依存関係レコードの横に を表示します。クリックすると、対応する設定ページに直接移動します。

  

  テストフレームワークとコード品質ツールの使用の詳細については、テストおよび PHP コード品質ツールを参照してください。

Composer ログを開く

• Composer コマンドを初めて実行した後、通知ツールウィンドウの通知メッセージでログに表示するショートカットリンクをクリックします。

  

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

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

Composer コマンドが正常に実行された場合、Composer ログはその実行の詳細を折りたたみます。

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

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

  

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

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

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

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

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

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

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

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

   

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

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

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

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

Composer コマンドを実行する

• ツール | コマンドの実行に移動するか、Ctrl を 2 回押します。

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

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

  

コマンドを終了する

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