PhpStorm 2024.1 ヘルプ

Composer 依存関係マネージャー

PhpStorm は Composer(英語) 依存関係マネージャーと統合されています。これにより、Packagist(英語) またはカスタムリポジトリからのパッケージをプロジェクトの依存関係として宣言し、IDE から管理できます。PhpStorm は以下を提供します。

Composer をダウンロードしてインストールする

Composer のインストールの詳細については、Composer 公式ドキュメント(英語)を参照してください。

ローカル環境で作業する場合、PhpStorm の Composer コマンドは、構成されたローカル PHP インタープリターを介して実行されます。Composer は、システム全体のスタンドアロンツールとして手動でダウンロードしてインストールできます。または、新しい Composer プロジェクトを作成したり、Composer を初期化したり、既存のプロジェクトで他の Composer コマンドを呼び出したりすると、PhpStorm によって自動的にダウンロードされます。

さらに、PhpStorm を使用すると、構成済みのリモート PHP インタープリターを介して Composer コマンドを実行できます。

Composer コマンドの実行をセットアップする

  1. 次のいずれかの方法で Composer ダイアログを開きます。

    • 設定ダイアログ(Ctrl+Alt+S)で、PHP | Composer に移動します。

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

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

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

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

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

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

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

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

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

Composer でプロジェクトをセットアップする

PhpStorm では、既存の Composer プロジェクトで作業したり、選択した Composer パッケージに基づいて新しいプロジェクトを作成したり既存のプロジェクトで Composer を初期化したりできます。PhpStorm は依存関係を解決し、composer.json からの情報を使用して特定の構成オプションを自動的に適用します。

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

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

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

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

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

    ps_composer_path_detected.png
    • 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' をクリックします。

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

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

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

Composer パッケージからプロジェクトを作成する

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

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

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

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

    1. プロジェクトの種類と場所を選択します。

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

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

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

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

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

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

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

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

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

既存のプロジェクトで Composer を初期化する

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

  1. ツール | Composer | Composer 初期化に移動します。

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

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

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

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

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

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

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

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

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

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

    the composer.json file stub

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

複数の composer.json ファイルを管理する

1 つの PhpStorm プロジェクトに複数の composer.json ファイルを含めることができ、それぞれに対して Composer アクションとコマンドを呼び出すことができます。

プロジェクトに専用の composer.json ファイルを含むサブディレクトリが含まれている場合、PhpStorm は、Composer が管理する依存関係とそのような各モジュールの設定を個別に処理します。composer.json がインストールされているすべてのサブディレクトリには、独自の PSR-0/PSR-4 ルート設定、テストフレームワークの構成、および外部ライブラリを含む vendor ディレクトリがあります。

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

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

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

    Composer Files tab

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

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

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

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

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

composer.json を操作する

composer.json ファイルには、プロジェクトの依存関係が記述されており、他のメタデータも含まれている場合があります。PhpStorm は、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 バージョンと拡張機能、およびパッケージの名前とバージョン。

    Code completion in composer.json

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

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

    Viewing quick documentation for a Composer package

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

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

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

    • ボタン Ctrl+B

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

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

    the Open Settings button in the gutter of composer.json

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

依存性の管理

プロジェクトの依存関係をインストール、更新、アンインストールするには、composer.jsonrequire または require-dev セクションのレコードを更新してから、対応する Composer コマンドを実行する必要があります。

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

プロジェクトを開くか、composer.json を変更すると、PhpStorm は vendor ディレクトリが存在するかどうかを確認します。欠落している場合、PhpStorm は通知メッセージを表示します。

Missing 'vendor' folder notification

通知メッセージ内の実行 'composer install' ショートカットリンクをクリックすると、プロジェクトの依存関係がすぐにインストールされます。必要に応じて、設定ダイアログ (Ctrl+Alt+S) の PHP | Composer ページにある 'ベンダー' ディレクトリがないことを通知するチェックボックスをオフにすることで、この通知を無効にすることができます。

依存関係のインストール

  1. composer.json 内で、目的の依存関係レコードを require または require-dev セクションに追加します。Ctrl+Space を押して、パッケージ名とバージョンの両方のコード補完を取得します。

    Adding a dependency in composer.json
  2. 以下のいずれか 1 つを実行します:

    • エディターパネルの上部にあるインストールショートカットリンクをクリックします。

    • インストールされていない Composer パッケージインスペクションが有効になっている場合、PhpStorm は、現在インストールされていない宣言済みの依存関係をハイライトします。Alt+Enter を押して、特定の依存関係をインストールするか、すべての依存関係を一度にインストールするかを選択します。

      Install a package via the quick-fix

新しいパッケージがインストールされると、PhpStorm は vendor に新しいサブフォルダーを作成し、その中にパッケージを格納します。composer.lock(英語) ファイルが現在のディレクトリに存在する場合、そこにリストされている正確なパッケージバージョンがインストールされます。それ以外の場合、composer.lock ファイルが見つからない場合、Composer はパッケージのインストール後にそれを作成し、プロジェクトを特定のバージョンにロックします。

依存関係の更新

パッケージを個別に最新バージョンに更新するか、composer.jsonrequire および require-dev セクションにリストされているすべてのパッケージを一度に更新できます。

  • 新しいパッケージバージョンが利用可能になった場合、またはパッケージバージョンの要件が変更された場合、PhpStorm はエディターのガターの the Update Package button アイコンを介してこれを示します。また、現在インストールされているバージョンとパッケージを更新できるバージョンに関するヒントも提供します。

    the Update Package button をクリックしてパッケージを更新します。

    Package update is available
  • すべてのパッケージを更新するには、composer.json エディターパネルの上部にある更新ショートカットリンクをクリックします。

オプションを使用して依存関係をインストール / 更新する

依存関係をインストールまたは更新する場合、PhpStorm はそれぞれの Composer コマンドを --ignore-platform-reqs オプションで実行できます。

--ignore-platform-reqs オプションを使用すると、PhpStorm プロジェクトの PHP インタープリターのバージョンが無効であるか、PHP 拡張機能またはライブラリが欠落している場合でも、依存関係のインストールまたは更新が可能になります。

オプションを指定してインストール / 更新コマンドを実行するには、PhpStorm 設定で Composer を構成します。

  • 設定ダイアログ (Ctrl+Alt+S) で、PHP | Composer に移動し、--ignore-platform-reqs でインストール / 更新を実行するチェックボックスを選択します。

    Enable Composer option in settings

依存関係をアンインストールする

  1. composer.jsonrequire または require-dev セクションからパッケージレコードを削除します。

  2. composer.json エディターパネルの上部にある更新ショートカットリンクをクリックします。

カスタムパッケージリポジトリを使用する

Packagist(英語) のほかに、カスタムパッケージリポジトリを使用できます。

Composer スクリプトを作成して実行する

Composer を使用すると、Composer 実行プロセス中にいくつかのカスタムコードまたはパッケージ固有のコマンドを実行するために使用されるスクリプト(英語)を作成して実行できます。

Composer スクリプトを定義する

  • composer.jsonscripts セクション内で、イベント(英語)プロパティを作成し、その中に必要なスクリプトを一覧表示します。各スクリプトは、静的メソッド、コマンドライン実行可能コマンド、既存のスクリプトへの参照(英語)として定義された PHP コールバックにすることができます。

    コード補完 Ctrl+Space を使用して、イベント名(英語)、クラスおよび静的メソッドの名前、vendor/bin にインストールされているバイナリの提案を取得します。既存のスクリプトへの参照を追加するには、そのスクリプトの前に @ 記号を付けます。

    Create a Composer script

Composer スクリプトの名前を変更する

  1. スクリプトの定義または使用箇所にキャレットを置きます。

  2. メインメニューまたはコンテキストメニューからリファクタリング | 名前の変更を選択して名前変更リファクタリングを呼び出すか、Shift+F6 を押します。

  3. 開いた名前変更ダイアログで、スクリプトに希望する名前を入力します。

    Rename a Composer script
  4. 検索ツールウィンドウで可能な変更を確認するには、プレビューをクリックします。リファクタリングをクリックして続行します。

composer スクリプトを実行する

  • 実行するスクリプトの横のガターで The Run button をクリックします。リストから実行 <script name> を選択します。

  • 実行するスクリプト内を右クリックし、コンテキストメニューから実行 <script name> を選択します。

  • 実行したいスクリプトにキャレットを置き、Alt+Enter を押して、実行 <script name> インテンションアクションを選択します。

    the Run Composer Script intention action

スクリプトが実行されると、PhpStorm は自動的に専用の一時 Composer スクリプトの実行 / デバッグ構成を作成します。必要に応じて永続的な実行 / デバッグ構成として保存してくださいを使用できます。

Composer スクリプトの実行 / デバッグ構成を作成する

Composer スクリプト型の実行構成を使用して、Composer スクリプトを実行できます。実行構成を使用すると、いつでもスクリプトを実行したり、サービスツールウィンドウや複合構成に追加したりできます。実行 / デバッグ構成の操作の詳細については、を参照してください。

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

    • エディターで、目的のスクリプトレコード内を右クリックし、コンテキストメニューからさらに実行 / デバッグ | 実行構成の変更を選択します。

      Create a run configuration from the editor
    • または、メインメニューから実行 | 実行構成の編集を選択してから Add icon をクリックし、リストから Composer スクリプトを選択します。

      Add new Composer Script run configuration
  2. 実行 / デバッグ構成パラメーターを指定します。

    • composer.json のパス : このフィールドに、目的のスクリプトの定義を含む composer.json へのパスを入力します。

    • スクリプト : このリストから、実行する定義済みの Composer スクリプトの 1 つを選択します。

    • コマンドラインパラメーター : このフィールドに、追加のコマンドラインパラメーターを入力します。これらのパラメーターは、CLI 引数として CLI ハンドラーに渡されます。PHP ハンドラー内では、$event->getArguments() 呼び出しを介して配列として取得できます。

一時的な Composer スクリプトの実行 / デバッグ構成を保存する

エディターから Composer スクリプトを実行すると、PhpStorm はスクリプトパラメーターを使用して一時的な実行 / デバッグ構成を自動的に作成します。一時的な実行 / デバッグ構成は、永続的な実行 / デバッグ構成と同じように機能します。実行 / デバッグ構成ダイアログを使用して設定を変更し、オプションで永続的に保存できます。

  • 実行 / デバッグ構成セレクターで、「<構成名> を保存」を選択します。

    Save a temporary run configuration
  • 実行 / デバッグ構成ダイアログで、構成を選択し、the Save button をクリックします。

実行 / デバッグ構成を使用して Composer スクリプトを実行する

  • 実行 / デバッグ構成セレクターで、目的の実行構成を選択します。次に、メインツールバーの Run button をクリックするか、Shift+F10 を押します。

  • Alt+Shift+F10 を押し、リストから希望の実行構成を選択して、Enter を押します。

    Run configuration popup

Composer ログを表示する

the Composer Log console

Composer ログを開く

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

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

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

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

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

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

    the folded Composer Log message

プロジェクト内でメインcomposer.json ファイルを指定すると、PhpStorm の設定とそのファイルの同期を有効にすることができます。Composer ログは、設定の変更が発生すると、その変更をハイライトします。ガターの the Settings button をクリックすると、対応するディレクトリPHPテストフレームワーク、または PHP コマンドラインツール設定ページにすばやく移動できます。

追加の Composer コマンドを実行する

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

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

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

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

Composer の実行が設定されていない場合は、Composer 設定ダイアログが開き、Composer コマンドの実行方法を選択するように促されます。

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

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

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

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

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

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

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

検証

このコマンドを実行すると、composer.json ファイルに対していくつかの妥当性チェックが実行されます。これは、composer.json を VCS にコミットする前に推奨されます。検証結果は Composer ログコンソールに表示されます。

同等の Composer CLI コマンドは validate(英語) です。

コマンドを実行する前に、検証設定ダイアログで必要なオプションを選択します。

  • アンバウンドバージョンの制約を許可する : 選択した場合、上限のないバージョン制約(*>3.1 など)が許可されます。これにより、依存関係の将来のバージョンを更新できるようになり、依存関係が予期せず変更された場合に下位互換性の問題が発生する可能性があることに注意してください。

    Composer CLI コマンドの同等のオプションは --no-check-all です。

  • composer.lock が最新であるかどうかを確認する : 選択すると、composer.lock にリストされているバージョン制約が、composer.json にリストされているバージョン制約と照合されます。バージョンの制約が一致しない場合は、パッケージを更新してこれを修正することをお勧めします。パッケージが必要なバージョンに更新された後、composer.lock ファイルと composer.json ファイルが同期されます。

    Composer CLI コマンドの同等のオプションは --no-check-lock です。

  • パッケージが Packagist 対応であるかどうかを確認する : 選択すると、パッケージの composer.jsonPackagist(英語) 発行要件に照らしてチェックされます。一般に、パッケージを Packagist 対応にするためには、composer.json ファイル内の namedescriptionrequire セクションを指定する必要があります。パッケージの公開の詳細については、「Packagist のドキュメント(英語)」を参照してください。

    Composer CLI コマンドの同等のオプションは --no-check-publish です。

  • パッケージの依存関係を検証する : これを選択すると、現在のパッケージのすべてのインストール済み依存ファイルの composer.json ファイルも検証されます。

    Composer CLI コマンドの同等のオプションは --with-dependencies です。

オートローダーのダンプ

このコマンドを実行して、自動ロードされたクラスのリストを生成します。リストがすでに存在する場合は、新しく生成されます。これは、プロジェクトに新しいクラスを導入し、それを自動ロードされるクラスのリストに含める必要がある場合に役立ちます。Composer を使用したクラスの自動ロードの詳細については、「Composer のドキュメント(英語)」を参照してください。

同等の Composer CLI コマンドは dump-autoload(英語) です。

コマンドを実行する前に、オートローダー生成設定ダイアログで必要なオプションを選択します。

  • スクリプトの実行をスキップする : 選択した場合、composer.json ファイルの scripts セクションに定義されているスクリプトは実行されません。

    Composer CLI コマンドの同等のオプションは --no-scripts です。

  • オートローダーの最適化 (PSR-0/4 ルールをクラスマップに変換する) : 選択すると、Composer は指定された PSR-0 / 4 自動ロードディレクトリ / ファイルをスキャンして php および inc ファイルを探し、単一の autoload_classmap キー値配列を生成して自動ロードを高速化します。クラスの数が多い場合、このコマンドの実行には時間がかかる可能性があることに注意してください。

    Composer CLI コマンドの同等のオプションは --optimize です。

  • クラスマップからクラスをオートロード : 選択すると、クラスマップにリストされているクラスだけが自動ロードされます。Composer はクラスマップにリストされていないクラスのフォールバック PSR-4 ディレクトリを検索しません。これには必然的に既存のクラスマップが必要になるため、Composer はオートローダーの最適化 (PSR-0/4 ルールをクラスマップに変換する) コマンドも実行してそれを生成しますが、これは時間のかかるプロセスです。

    Composer CLI コマンドの同等のオプションは --classmap-authoritative です。

  • 見つかった / 見つからないクラスのキャッシングに APCu を使用する : 選択すると、APCu(英語) によるキャッシュが有効になります。クラスマップ内にクラスが見つかった(または見つからない)場合、対応するレコードは APCu にキャッシュされ、次の要求ですぐに取り出すことができます。

    Composer CLI コマンドの同等のオプションは --apcu です。

  • autoload-dev 依存関係を使用不可にする : 選択すると、autoload-dev セクションにリストされている自動ロードされた名前空間とファイルは、自動ロードされたクラスのリストに含まれません。

    Composer CLI コマンドの同等のオプションは --no-dev です。

依存関係の変更を確認する

このコマンドを実行して、パッケージの依存関係のコードにローカル変更があるかどうかを確認します。

同等の Composer CLI コマンドは status(英語) です。

キャッシュのクリア

このコマンドを実行して、ダウンロードしたパッケージが含まれている Composer のキャッシュディレクトリを削除します。デフォルトでは、キャッシュディレクトリは Windows では C:\Users\<user>\AppData\Local\Composer に設定され、Linux および macOS では ~/.composer/cache に設定されます。詳細については、Composer のドキュメント(英語)を参照してください。

同等の Composer CLI コマンドは clear-cache(英語) です。

ライセンスの一覧表示

このコマンドを実行すると、インストールされているすべてのパッケージの名前、バージョン、ライセンス型が表示されます。

同等の Composer CLI コマンドは licenses(英語) です。

診断

このコマンドを実行すると、最も一般的な Composer の問題 (接続の問題、使用されている Composer/PHP バージョン、使用可能なディスク容量、composer.json の有効性など) の自動チェックが実行されます。問題が特定されない場合は、Composer トラブルシューティングガイド(英語)を参照してください。

同等の Composer CLI コマンドは diagnose(英語) です。

更新のシミュレーション

このコマンドを実行して、実際に composer update を実行せずに依存関係の更新をシミュレートします。そうすることで、すべての依存関係が正常に解決されたかどうかを確認し、すべてをそのままにして変更をプレビューできます。

同等の Composer CLI コマンドは --dry-run を更新(英語)です。

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

自己更新

このコマンドを実行して、Composer 自体(つまり、composer.phar ファイル)を最新バージョンに更新します。

同等の Composer CLI コマンドは self-update(英語) です。

コマンドラインから Composer を実行する

コマンドラインモードでは、Composer コマンドの全範囲が提供されます。このモードで Composer を使用するには、Composer を外部コマンドラインツールとして構成する必要があります。コマンドラインツールの使用方法の詳細については、「PHP コマンドラインツール」を参照してください。

Composer のいくつかのインスタンスを設定し、Composer 初期化の間に関連するプロジェクトを指定することで、そのプロジェクトを別のプロジェクトに切り替えることができます。

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

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

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

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

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

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

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

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

Composer コマンドを実行する

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

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

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

    Running a composer command

コマンドを終了する

関連ページ:

コンテンツルート

PhpStorm では、コンテンツは現在作業しているファイルのコレクションであり、場合によってはサブフォルダーの階層に編成されています。この階層の最上位にあるフォルダーは、コンテンツルートフォルダー (略してコンテンツルート) と呼ばれます。プロジェクトには少なくとも 1 つのコンテンツルートフォルダーがあり、デフォルトではプロジェクトフォルダーそのものです。コンテンツルートを追加いくつかのコンテンツルートを持つことで、共通の直系親を持たない複数のディレクトリからのファイルを扱うことができます。これ...

ローカル PHP インタープリターを構成する

ローカル PHP インタープリターは、リモートホスト、Docker コンテナー、または Vagrant 仮想環境にインストールされるリモート PHP インタープリターとは対照的に、コンピューターにインストールされる PHP エンジンです。ローカル PHP インタープリターを構成するを押して設定を開き、を選択します。表示される PHP ページで、CLI インタープリターリストの横にあるをクリックします。表示される CLI インタープリターダイアログで、左側のペインのをクリックして、ポップアップメニュー...

リモート PHP インタープリターの構成

リモート PHP インタープリターという用語は、リモートホストまたは仮想環境にインストールされた PHP エンジンを指します。リモート PHP インタープリターという用語は、コンピューターにインストールされているローカル PHP インタープリターの対義語として使用されます (ローカル PHP インタープリターの構成を参照)。SSH、Docker、Docker Compose、Vagrant、WSL を介してリモート PHP インタープリターにアクセスできます。SSH を使用すると、PHP インター...

Docker イメージ

Docker イメージは、コンテナーを実行するための実行可能パッケージです。Docker はレジストリを使用してイメージを配布します。デフォルトでは、PhpStorm は Docker Hub を使用します。これは、さまざまな Linux フレーバー、データベース管理システム、Web サーバー、ランタイム環境など、最も一般的なイメージがすべて含まれるパブリックレジストリです。他にもパブリックおよびプライベートの Docker レジストリがあり、独自のレジストリサーバーをデプロイすることもできます。詳...

PHP

このページとこのノードのすべてのページは、PHP プラグインが有効な場合にのみ使用できます。PHP プラグインは PhpStorm にバンドルされており、デフォルトで有効になります。プラグインが無効になっている場合は、プラグインのマッピングの説明に従ってで有効にします。このページを使用して、使用可能な PHP インタープリターの 1 つを選択して、プロジェクトでの PHP 開発および単体テストのサポートを構成します。PHP 言語レベルこのリストでは、コーディング支援を受ける PHP 機能の範囲を指定...

ライブラリとライブラリルート

ライブラリは、プロジェクトでそのまま使用されるサードパーティのファイルまたはファイルのセットです。PHP ライブラリは、プロジェクト内で Composer によって管理されるのが最も一般的です。これにより、PHP ライブラリは依存関係として宣言され、vendor ディレクトリ内のフォルダーにインストールされます。プロジェクトファイルからライブラリを区別しながら、そのクラスとメソッドを IDE の内部情報に含めるために、PhpStorm はライブラリフォルダーをライブラリルートとしてマークします。詳細に...