Composer 依存関係マネージャー

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

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

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

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

   

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

   

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

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

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

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

     利用可能なパッケージ更新を取得し、より良い composer.json でのコーディング支援を提供するために、プロジェクトを開くまたは composer.json を変更するたびに、PhpStorm はバックグラウンドで update --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. 次のいずれかを実行します：

   • プロジェクト ツールウィンドウ（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. コマンドラインツール ダイアログで、リストから コンポーザー を選択し、その可視性レベル（プロジェクト または グローバル ）を指定します。

   

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> 形式でコマンドの呼び出しを入力します。

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

  

コマンドを終了する

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