PhpStorm 2020.3 ヘルプ

PHPUnit

このダイアログを使用して、PHPUnit フレームワークを使用してコンソールで PHP アプリケーションの単体テストを実行およびデバッグするために使用する構成を作成します。

始める前に

PHPUnit サポートを有効にする

  1. コンピューターに PHPUnit(英語) をインストールして設定します。https://phpunit.readthedocs.io/en/9.0/installation.html(英語) を参照してください。

  2. PHP プラグインが有効になっていることを確認します。PHP プラグインは PhpStorm にバンドルされており、デフォルトで有効になっています。プラグインが無効になっている場合は、プラグインの管理に従って、設定 / 環境設定 | プラグインページでプラグインを有効にします。

テストランナーエリア

この領域では、起動する単体テストと、テストランナーに渡すコマンドラインスイッチを指定します。

項目 説明
テストスコープ

この領域には、テストの場所または設定ファイルがリストされている場所を指定します。

  • ディレクトリ : ディレクトリ内のすべてのユニットテストを起動するには、このオプションを選択します。

    ディレクトリフィールドで、単体テストを検索するディレクトリを指定します。ディレクトリへのパスを手動で入力するか、the Browse button をクリックして表示されるテストディレクトリを選択するダイアログで目的のディレクトリを選択します。

  • クラス : テストクラス内のすべてのユニットテストを起動するには、このオプションを選択します。

    クラスフィールドに、目的のクラスの名前を入力します。クラスをすばやく見つけるには、コード補完 Ctrl+Space を使用します。選択したクラスの場所は、コントロールファイルの読み取り専用フィールドに表示されます。

  • メソッド : 特定のテスト方法を起動するには、このオプションを選択します。

    クラスフィールドに、目的のクラスの名前を入力します。クラスをすばやく見つけるには、コード補完 Ctrl+Space を使用します。選択したクラスの場所は、コントロールファイルの読み取り専用フィールドに表示されます。

    メソッドフィールドで、目的の方法を指定します。クラスをすばやく見つけるには、コード補完 Ctrl+Space を使用します。

  • 構成ファイルで定義 : テストランナーに専用の XML 設定ファイルからテストを実行させるには、このオプションを選択します。

  • コンポジット : テストランナーに任意のテスト選択からテストを実行させるには、このオプションを選択します。

    コンポジットテストパターン領域で、AddRemovethe Edit button を使用して、構成に含まれるテストパターン(つまり、テストクラスまたはテストメソッド)のリストを管理します。

    テストパターンを追加するには、the Add button をクリックします。既存のパターンを編集するには、the Edit button をクリックします。開いた PHPUnit テストパターンを追加ダイアログで、名前で検索タブまたはプロジェクトタブを使用して目的のテストクラスまたはテストメソッドシンボルを見つけます。選択したテスト方法でデータプロバイダを使用している場合は、データセットフィールドにデータセットの名前を入力します。複数のデータセットの場合は、それらのそれぞれに対して別々のパターンエントリを作成する必要があります。

    デフォルトでは、PhpStorm はプロジェクト構造に基づいてテストパターンの位置を自動的に検出しようとします。テストパターンを含むディレクトリを明示的に指定するには、代替パターンのベースパスを使用するチェックボックスを選択してから the Browse button をクリックし、表示されるダイアログで目的のディレクトリを探します。

代替構成ファイルを使用

このフィールドで、PHPUnit 設定ファイル(英語)の場所を選択します。

  • 設定 / 環境設定ダイアログ Ctrl+Alt+Sテストフレームワークページで指定されたデフォルトの構成ファイルを使用するには、代替構成ファイルを使用チェックボックスをオフにします。テストフレームワークページでデフォルトの構成ファイルが指定されていない場合、実行 / デバッグ構成は無効です。テストフレームワークページをすばやく開くには、the Settings button をクリックします。

  • カスタム設定ファイルからテストを実行するには、代替構成ファイルを使用チェックボックスを選択し、the Browse button をクリックして、使用するファイルの場所を指定します。

代替ブートストラップファイルを使用する

このフィールドで、テストを開始する前に実行される、ブートストラップ PHP スクリプトの場所を選択します。

  • 設定 / 環境設定ダイアログ Ctrl+Alt+Sテストフレームワークページで指定されたデフォルトのブートストラップファイルを使用するには、代替ブートストラップファイルを使用するチェックボックスをオフにします。

  • カスタムブートストラップファイルを実行するには、代替ブートストラップファイルを使用するチェックボックスを選択し、the Browse button をクリックして、使用するファイルの場所を指定します。

テストランナーオプション

このフィールドで、テストランナースイッチ(英語)を指定します。

必要に応じて Expand をクリックし、コマンドラインオプションダイアログに目的のスイッチを入力します。各スイッチを新しい行に入力します。ダイアログを閉じると、指定したスイッチがテストランナーオプションフィールドに区切り文字としてスペースとともに表示されます。

優先カバレッジエンジン

このリストから、構成済みのコードカバレッジランナーの 1 つを選択します。

  • Xdebug(英語) は、デバッグ機能とコードカバレッジ機能の両方を提供するデバッグ拡張機能です。

    Xdebug を有効にするには、アクティブな php.ini ファイルの [xdebug] セクションで少なくとも次の設定が指定されていることを確認してください。

    [xdebug] zend_extension="<path to xdebug extension>" xdebug.coverage_enable=1
    [xdebug] zend_extension="<path to xdebug extension>" xdebug.mode=coverage

    詳細は Xdebug を構成するを参照してください。

  • PCOV(英語) は、コードカバレッジ機能のみを提供する軽量拡張です。

    PCOV を有効にするには、PCOV のドキュメント(英語)の説明に従って拡張機能をダウンロードしてインストールします。次に、アクティブな php.ini ファイルで少なくとも以下の設定が指定されていることを確認します。

    extension="<path to pcov extension>"
  • phpdbg(英語)、デバッグおよびコードカバレッジモジュール。PHP5.6(英語) 以降にバンドルされており、追加の構成は必要ありません。

コマンドラインエリア

この領域では、PHP インタープリターを選択し、PHP 実行可能ファイルに渡すオプションと引数を指定して、その動作をカスタマイズします。

項目 説明
インタープリター リストには、現在設定されているすべてのローカルおよびリモート PHP インタープリターが含まれています。リストから構成済みの PHP インタープリターのいずれかを選択するか、the Browse button をクリックして、ローカル PHP インタープリターを構成するおよびリモート PHP インタープリターの構成の説明に従って新しいインタープリターを定義します。
インタープリターオプション

このフィールドで、PHP 実行可能ファイルに渡されるオプション(英語)を指定します。これらは、PHP インタープリターのデフォルトの動作をオーバーライドするか、追加のアクティビティが確実に実行されるようにします。

必要に応じて、the Expand button をクリックしてコマンドラインオプションダイアログに希望のオプションを入力します。各オプションを新しい行に入力してください。ダイアログを閉じると、それらはすべてコマンドラインオプションフィールドにスペースとして区切り記号として表示されます。

カスタム作業ディレクトリ

このフィールドでは、テストのあるフォルダーの外にあり、テストで相対パスを介して参照されるファイルの場所を指定します。

この設定では、テストの実行場所が常に対応するファイルおよび / またはディレクトリのフルパスで指定されるため、テストの実行はブロックされません。

デフォルトでは、フィールドは空で、作業ディレクトリはプロジェクトのルートです。

環境変数 このフィールドでは、組み込みサーバーに渡す環境変数を指定します。詳細については、Apache の環境変数(英語)を参照してください。

共通

実行構成を編集するとき(ただし実行構成テンプレートは編集しないとき)、次のオプションを指定できます。

項目

説明

名前

実行 / デバッグ構成の名前を指定して、たとえば実行ポップアップ Alt+Shift+F10 から構成を編集または実行するときにすばやく識別します。

並列実行を許可する

この実行構成の複数のインスタンスを並行して実行できるようにする場合に選択します。

デフォルトでは無効になっており、別のインスタンスの実行中にこの構成を開始すると、PhpStorm は実行中のインスタンスを停止して別のインスタンスを開始することを提案します。これは、実行 / デバッグ構成が多くのリソースを消費し、複数のインスタンスを実行する正当な理由がない場合に役立ちます。

プロジェクトファイルとして保存

実行構成設定を含むファイルを保存して、他のチームメンバーと共有します。デフォルトの場所は .idea/runConfigurations です。ただし、.idea ディレクトリを共有したくない場合は、プロジェクト内の他のディレクトリに構成を保存できます。

デフォルトでは無効になっており、PhpStorm は実行構成設定を .idea/workspace.xml に保存します。

ツールバー

実行 / デバッグ構成のツリー表示には、プロジェクトで使用可能な構成を管理したり、デフォルトの構成テンプレートを調整したりするのに役立つツールバーがあります。

項目 ショートカット 説明
the Add button Alt+Insert 実行 / デバッグ構成を作成します。
the Remove button Alt+Delete 選択した実行 / デバッグ構成を削除します。デフォルト設定は削除できません。
Copy Ctrl+D 選択した実行 / デバッグ構成のコピーを作成します。デフォルト設定のコピーを作成してください。
Save configuration このボタンは、一時的な構成を選択した場合にのみ表示されます。このボタンをクリックして、一時的な構成を永続的なものとして保存します。
Edit Templates テンプレート(つまり、デフォルトの実行 / デバッグ構成設定)を表示および編集します。テンプレートはテンプレートノードに表示され、新しく作成された構成に使用されます。
Method up / Method down Alt+Up / Alt+Down

選択した実行 / デバッグ構成をリスト内で上下に移動します。

リスト内の設定の順序によって、実行 / デバッグ構成を選択したときに表示される設定の順序が決まります。

実行 / デバッグ構成のデフォルトのテンプレートは、常にアルファベット順にソートされています。

Move into new folder / Create new folder

新しいフォルダーに移動 / 新しいフォルダーを作成します。実行 / デバッグ構成は、フォルダーに配置することでグループ化できます。

フォルダーを作成するには、カテゴリ内の設定を選択し、Folder をクリックしてフォルダー名を指定します。カテゴリだけにフォーカスがある場合は、空のフォルダーが作成されます。

次に、設定をフォルダー内、フォルダー間、またはフォルダー外に移動するには、ドラッグまたは Move Up ボタンと Move Down ボタンを使用します。

グループ化を解除するには、フォルダーを選択して Remove Configuration をクリックします。

Sort configurations このボタンをクリックすると、設定がアルファベット順にソートされます。

起動前

この領域では、選択した実行 / デバッグ構成を開始する前に実行しなければならないタスクを指定できます。タスクはリストに表示されている順序で実行されます。

項目 ショートカット 説明
the Add button Alt+Insert

このアイコンをクリックして、以下の使用可能なタスクのいずれかを追加します。

  • 外部ツールの実行 : 外部アプリケーションを実行するように選択します。開いたダイアログで、実行したい 1 つまたは複数のアプリケーションを選択します。PhpStorm でまだ定義されていない場合は、その定義を追加してください。詳しくは、外部ツールおよび外部ツールを参照してください。

  • 別の構成を実行 : 別の実行 / デバッグ構成を実行することを選択します。開いたダイアログで、実行する設定を選択します。

  • ウェブブラウザーの起動 : ブラウザーを起動するにはこのオプションを選択します。開いたダイアログで、ブラウザーの種類を選択し、開始 URL を入力します。また、ブラウザーを JavaScript デバッガーで起動するかどうかを指定します。

  • ファイル監視の実行 : PhpStorm に現在アクティブなすべてのファイル監視を適用させるには、このオプションを選択します。

  • Grunt タスクの実行 : Grunt タスクを実行するには、このオプションを選択してください。

    表示される Grunt タスクダイアログで、必要なタスクが定義されている Gruntfile.js を指定し、実行するタスクを選択して、Grunt ツールに渡す引数を指定します。

    Node.js インタープリターの場所、渡すパラメーター、grunt-cli パッケージへのパスを指定します。

  • gulp タスクの実行 : Gulp タスクを実行するには、このオプションを選択してください。

    表示される Gulp タスクダイアログで、必要なタスクが定義されている Gulpfile.js を指定し、実行するタスクを選択して、Gulp ツールに渡す引数を指定します。

    Node.js インタープリターの場所、それに渡すパラメーター、および gulp パッケージへのパスを指定します。

  • npm スクリプトの実行 : npm スクリプトを実行するには、このオプションを選択してください。

    開いた NPM スクリプトダイアログで、npm 実行 / デバッグ構成設定を指定します。
  • TypeScript のコンパイル : 組み込み TypeScript コンパイラーを実行するように選択し、TypeScript コードに加えたすべての変更が生成された JavaScript ファイルに反映されるようにします。表示される TypeScript コンパイル設定ダイアログで、エラーをチェックチェックボックスを選択または選択解除して、エラーが検出された場合のコンパイラーの動作を設定します。

    • エラーをチェックチェックボックスが選択されていると、コンパイラーはすべてのエラーを表示し、実行構成は開始されません。

    • エラーをチェックチェックボックスがオフの場合、コンパイラーは検出されたすべてのエラーを表示しますが、実行構成は起動されます。

  • Phing ターゲットの実行 : 実行またはデバッグの前に、指定された Phing ターゲットを実行するためにこのタスクを追加してください。Phing ターゲットを指定するには、参照 the Browse button をクリックして表示されるダイアログで目的のターゲットを選択します。

  • CoffeeScript ソースマップの生成 : CoffeeScript ソースのソースマップを生成するには、このオプションを選択してください。表示されるダイアログで、CoffeeScript のソースファイルがある場所を指定します。

  • リモート外部ツールの実行 : リモート SSH 外部ツールを追加します。

the Remove button Alt+Delete このアイコンをクリックして、選択したタスクをリストから削除します。
Edit Enter 選択したタスクを編集するには、このアイコンをクリックします。開いたダイアログで必要な変更を加えます。
Method up / Method down Alt+Up / Alt+Down これらのアイコンをクリックして、選択したタスクをリスト内で 1 行上または下に移動します。タスクは、リストに表示されている順に実行されます。
このページを表示する 実行 / デバッグ構成を実際に開始する前に、実行 / デバッグ構成設定を表示するには、このチェックボックスを選択します。
ツールウィンドウをアクティブにする

デフォルトではこのチェックボックスは選択されており、実行 / デバッグ構成を開始すると実行またはデバッグツールウィンドウが開きます。

それ以外の場合、チェックボックスがオフの場合、ツールウィンドウは非表示になります。ただし、構成が実行されている場合は、Alt+4 または Alt+5 を押すことにより、構成に対応するツールウィンドウを自分で開くことができます。

関連ページ:

プラグインを管理する

このサイトのメニューやアクション名表記は日本語です。PhpStorm を日本語化するには、日本語言語パックのインストールを参照してください。プラグインは以下に示すように PhpStorm のコア機能を拡張します。バージョン管理システム、アプリケーションサーバー、およびその他のツールとの統合を提供する、さまざまな言語とフレームワークのコーディング支援サポートを追加する、ショートカットヒント、ライブプレビュー、ファイルウォッチャーなどで生産性を向上、コーディング演習と検証で新しいプログラミング言語を...

テストフレームワーク

このページを使用して、PHP 固有のテストフレームワークと現在のプロジェクトの PhpStorm を統合します。PhpStorm を使用すると、PHPUnit、Behat、Codeception、PHPSpec テストを実行およびデバッグできます。ページは 2 つのペインで構成されています。中央ペインには、異なるインタープリター用のテストフレームワークの既存の設定が表示されます。右側のペインの内容は、テストフレームワークと選択されたインタープリターのタイプによって異なります。プロジェクトでテストフ...

PhpStorm でデバッグする: 基本ガイド

このセクションでは、PhpStorm で PHP のデバッグを開始するのに役立つチュートリアルをいくつか紹介します。クイックスタート:いずれかのデバッグシナリオに進む前に、デバッグエンジンを選択して PHP 環境にインストールする必要があります。これらのチュートリアルでは、インストールプロセスについて説明します。デバッグエンジンがインストールされている場合、ゼロコンフィギュレーションデバッグアプローチに従ってデバッグを開始できます。ブラウザーに適したブラウザー拡張機能を選択してインストールしま...

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

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

実行 / デバッグ構成を操作する

PhpStorm でコードを実行またはデバッグするには、実行 / デバッグ構成を使用できます。各実行 / デバッグ構成は、名前付きの実行 / デバッグ起動プロパティのセットを表します。PhpStorm を使用して実行、デバッグ、またはテストの操作を実行するときは、常にそのパラメーターを使用して、既存の構成のいずれかに基づいてプロセスを開始します。PhpStorm には、さまざまな実行、デバッグ、テストの問題に対して、いくつかの実行 / デバッグ構成タイプが付属しています。特定のタイプの独自の実行...

外部ツール

サードパーティのアプリケーションを外部ツールとして定義し、PhpStorm から実行できます。PhpStorm を使用すると、プロジェクトから外部ツールにコンテキスト情報をコマンドライン引数(現在選択されているファイルやプロジェクトのソースパスなど)として渡し、ツールによって生成された出力を表示し、実行前にツールを起動するように構成できます。/ debug 構成など。PhpStorm に追加できる外部ツールにはいくつかの種類があります。ローカルツールは、コンピューター上でローカルに実行されるアプ...