PhpStorm 2020.2 ヘルプ

Composer 依存関係マネージャー

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

PhpStorm は、composer.json を操作するための包括的なコーディング支援と、一般的な Composer コマンドを実行するための専用ユーザーインターフェースを提供します。

上記のコマンドを実行すると、PhpStorm は Composer ログコンソールを介して出力を表示します。

PhpStorm プロジェクトですべての Composer コマンド(英語)を使用する場合は、Composer を外部 command-line ツールとして構成して実行できます。

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

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

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

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

Composer プロジェクトを管理する

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

新しい Composer プロジェクトを作成する

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

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

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

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

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

      • 左側のペインで、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 を初期化すると、composer.json が作成されます。このファイルには、プロジェクトの依存関係とその他のメタデータがリストされ、プロジェクトのデフォルトとして自動的に設定されます。

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

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

    the Composer Settings dialog
  2. Composer コマンドの実行方法を選択します。
    • グローバルにインストール作曲の実行可能ファイル経由でコマンドを実行するには、'composer' 実行可能ファイルを選択し、フィールドにその場所を指定します。

    • ローカルの composer.phar アーカイブを介してコマンドを実行するには、composer.phar を選択します。次に、フィールドに既存の composer.phar ファイルの場所を指定するか、getcomposer.org から composer.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 プロジェクトを開く

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

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

    PhpStorm は通知を表示します:

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

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

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

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

      PhpStorm は PSR-0 / PSR-4 ソースルートとそれらの名前空間プレフィックスを認識しています。 autoload セクションに基づいてソースルートthe Source root iconを設定し、autoload-dev セクションに基づいてテストルートthe Tests root iconを設定します。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.phar アーカイブを介してコマンドを実行するには、composer.phar を選択します。次に、フィールドに既存の composer.phar ファイルの場所を指定するか、getcomposer.org から composer.phar をダウンロードするチェックボックスを選択してファイルの新しいインスタンスをダウンロードします。ダウンロードした composer.phar ファイルはプロジェクトのルートフォルダーに保存されます。

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

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

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

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

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

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

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

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

    エディターで 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 プロジェクトに単一の Composer 構成ファイルがある場合、composer.json のパスフィールドは自動的に入力されます。

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

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

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

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

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

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

composer.json を操作する

composer.json ファイルはプロジェクトの依存関係を記述し、他のメタデータを含むこともあります。PhpStorm は、composer.json を使用するための包括的なコーディング支援を提供し、コードエディターから直接、多くの Composer 関連タスクを実行できます。

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

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

  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/Preferences buttonを表示します。クリックすると、対応する設定 / 環境設定ページに直接ジャンプします。

    the Open Settings button in the gutter of composer.json

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

依存性の管理

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

使用可能なパッケージの更新を取得し、より優れた composer.json でのコーディング支援を提供するために、PhpStorm は、プロジェクトを開くか composer.json を変更するたびに --dry-run を更新(英語)コマンドをバックグラウンドで実行します。必要に応じて、コマンドの実行を無効にすることができます。設定 / 環境設定ダイアログ 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 はベンダーの下に新しいサブフォルダーを作成し、その中にパッケージを格納します。composer.lock(英語) ファイルの場合。現在のディレクトリに存在する場合、そこにリストされているパッケージの正確なバージョンがインストールされます。それ以外の場合、composer.lock ファイルが欠落していると、Composer はパッケージのインストール後にファイルを作成し、プロジェクトを特定のバージョンにロックします。

依存関係の更新

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

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

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

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

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

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

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

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

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

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

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

Composer スクリプトを定義する

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

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

    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.json と同期させることができます。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.phar アーカイブを介してコマンドを実行するには、composer.phar を選択します。次に、フィールドに既存の composer.phar ファイルの場所を指定するか、getcomposer.org から composer.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 ログコンソールに表示されます。

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

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

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

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

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

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

  • パッケージが Packagist 対応であるかどうかを確認する : 選択すると、パッケージの composer.jsonPackagist(英語) 公開要件と照合されます。一般に、Packagist 対応のパッケージには、composer.json ファイルの name , description および require セクションを指定する必要があります。パッケージの公開の詳細については、Packagist のドキュメント(英語)を参照してください。

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

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

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

オートローダーのダンプ

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

キャッシュのクリア

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

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

ライセンスの一覧表示

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

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

診断

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

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

更新のシミュレーション

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

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

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

自己更新

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

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

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

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

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

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

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

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

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

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

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

    ファイル分析が完了すると、PhpStorm はコマンドラインツールのサポートページに戻り、指定されたファイルが PhpStorm で使用可能なコマンドラインツールのリストに追加されます。

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

Composer コマンドを実行する

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

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

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

    Running a composer command

コマンドを終了する

最終更新日 :

関連ページ:

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

ローカル PHP インタープリターは、リモート PHP インタープリターの反対側にコンピューターにインストールされた PHP エンジンであり、リモートホストまたはVagrantインスタンスにセットアップされた仮想環境にインストールできます。リモート PHP インタープリターの構成を参照してくだ...

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

リモート PHP インタープリターという用語は、リモートホストまたは仮想環境にインストールされた PHP エンジンを意味します。リモート PHP インタープリターという用語は、コンピューターにインストールされているローカル PHP インタープリターの反対語として使用されます。ローカル PHP イ...

Docker

Dockerを使用すると、開発者はアプリケーションをコンテナー内にデプロイして、実稼働と同じ環境でコードをテストできます。PhpStorm は、Dockerプラグインを使用して Docker サポートを提供します。プラグインはバンドルされ、デフォルトで有効になっています。Dockerプラグインは P...

プロジェクトツールウィンドウ

このツールウィンドウを使用すると、プロジェクトをさまざまな観点から見て、新しい項目(ディレクトリ、ファイル、クラスなど)の作成、エディターでのファイルの開き、目的のコードフラグメントへの移動などのタスクを実行できます。このツールウィンドウのほとんどの機能には、コンテンツペインのコンテキストメニューコ...

名前の変更リファクタリング

基本 :名前変更リファクタリングでは、コード内のすべての参照が自動的に修正されたシンボルやファイルの名前を変更できます。PhpStorm で使用できる名前変更リファクタリングは次のとおりです。クラスの名前変更。以下の使用箇所が名前変更されます :インポートステートメント、クラスの修飾名、メソッドの名...

実行 / デバッグ構成の作成および編集

ナビゲーションバーが表示されると(表示 | 外観 | ナビゲーションバー)、使用可能な実行 / デバッグ構成が実行エリアの実行 / デバッグ構成セレクタに表示されます。PhpStorm は、実行 / デバッグ構成を処理するためのツールとして実行 / デバッグ構成ダイアログを提供します:設定プ...