PhpStorm 2024.1 ヘルプ

Pest

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

始める前に

Pest サポートを有効にする

  1. プロジェクトに Pest(英語) をインストールして初期化します。PhpStorm 内から Pest をインストールする手順については、Pest のインストールと初期化を参照してください。

  2. Pest プラグインが有効になっていることを確認してください。Pest プラグインは PhpStorm にバンドルされており、デフォルトで有効になります。プラグインが無効になっている場合は、プラグインのマッピングの説明に従って設定 | プラグインで有効にします。

共通設定

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

項目

説明

名前

実行構成の名前を指定して、編集または実行時に他の構成の間ですばやく識別できるようにします。

複数のインスタンスを許可する

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

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

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

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

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

テストランナーエリア

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

項目

説明

テストスコープ

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

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

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

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

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

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

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

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

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

代替構成ファイルを使用

必要に応じて、チェックボックスを選択し、「 the Browse button 」をクリックして、代替 phpunit.xml 設定ファイル(英語)へのパスを指定します。

デフォルトの構成ファイルを使用するには、チェックボックスを選択解除したままにしておきます。

Pest のデフォルト構成ファイルがテストフレームワークページに設定されているかどうかを簡単に確認するには、フィールドの右側にある the Settings button をクリックします。

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

このフィールドでは、テストの実行時に Pest に渡すオプションを指定します。利用可能なオプションの完全なリストについては、「Pest のドキュメント(英語)」を参照してください。

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

優先カバレッジエンジン

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

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

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

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

    詳細は、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 をクリックしてコマンドラインオプションダイアログに希望のオプションを入力します。各オプションを新しい行に入力してください。ダイアログを閉じると、それらはすべてコマンドラインオプションフィールドにスペースとして区切り記号として表示されます。

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

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

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

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

環境変数

このフィールドには、組み込みサーバーに渡す環境変数を指定します。環境変数の名前と値のペアを手動で追加するには、 をクリックするか、 をクリックしてコンピューター上の .env ファイルを参照します。

詳細は、Apache の環境変数(英語)を参照してください。

Docker Compose エリア

この領域は、インタープリターフィールドで Docker Compose ベースのリモートインタープリターを選択した場合にのみ表示されます。ここで、実行構成にオプション付きの Docker Compose コマンド(英語)を追加できます。

項目

説明

コマンドとオプション

Docker Compose コマンドラインインターフェースの次のコマンドを使用できます。

コマンド

サポートされているオプション

上へ (英語): サービスのコンテナーをビルド、作成、開始、アタッチします。

  • --abort-on-container-exit

  • --build

  • --exit-code-from SERVICE

  • --scale SERVICE=NUM...

  • --timeout TIMEOUT

run(英語): サービスに対して 1 回限りのコマンドを実行します。

  • --entrypoint CMD

  • -l, --label KEY=VAL

  • --name NAME

  • -p, --publish=[]

  • --rm

  • --service-ports

  • --use-aliases

  • -u, --user=""

  • -v, --volume=[]

exec(英語): サービスで任意のコマンドを実行します。

  • --index=index

  • --privileged

  • -u, --user USER

コマンドプレビュー

このフィールドを使用して、完全なコマンド文字列をプレビューします。

例: コマンドとオプションフィールドの up --build exec --user jetbrains の組み合わせは、プレビューで次の出力を生成します。

Docker Compose Command preview

起動前

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

項目

ショートカット

説明

the Add button

Alt+Insert

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

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

  • 別の構成を実行 : 別の実行 / デバッグ構成を実行することを選択し、それが完了するまで待ってから現在の構成を開始します。複数の構成を並行して実行する場合は、複合実行 / デバッグ構成を使用してください。

  • Web ブラウザーの起動 : ブラウザーを起動するにはこのオプションを選択します。開いたダイアログで、ブラウザーの種類を選択し、開始 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 を押すことにより、構成に対応するツールウィンドウを自分で開くことができます。

ツールバー

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

項目

ショートカット

説明

the Add button

Alt+Insert

実行 / デバッグ構成を作成します。

the Remove button

Alt+Delete

選択した実行 / デバッグ構成を削除します。デフォルト設定は削除できません。

Copy

Ctrl+D

選択した実行 / デバッグ構成のコピーを作成します。デフォルト設定のコピーを作成してください。

Save configuration

このボタンは、一時的な構成を選択した場合にのみ表示されます。このボタンをクリックして、一時的な構成を永続的なものとして保存します。

Move into new folder / Create new folder

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

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

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

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

Sort configurations

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

PHPUnit PHP Web ページ

関連ページ：

Pest

PhpStorm には Pest テストフレームワークのサポートが付属しています。ファイルエディターまたは PhpStorm の実行 / デバッグ構成を使用して、Pest テストを実行、コードカバレッジを使用して実行、またはデバッグできます。IDE は Pest 期待 API を理解するため、Pest アサーションおよびユーザー定義のテストメソッドを操作するときに、コード補完の使用、使用箇所の検索、その他のコーディング支援機能を使用できます。Pest のインストールと初期化：PhpStorm 内...

プラグインのインストール

プラグインは PhpStorm のコア機能を拡張します。例: プラグインをインストールして、次の機能を取得します。バージョン管理システム、課題追跡システム、ビルド管理サーバー、その他のツールとの統合。さまざまな言語とフレームワークのコーディング支援サポート。ショートカットのヒント、ライブプレビュー、ファイルウォッチャーなど。新しいプログラミング言語を学ぶのに役立つコーディング演習。プラグイン設定を開くを押して設定を開き、を選択します。マーケットプレースタブを使用して、JetBrains マーケッ...

PhpStorm を使用したデバッグ

クイックスタート：以下は、ローカルまたはリモート Web サーバー上で実行される PHP アプリケーションをデバッグするために PhpStorm と Xdebug 3 を使用するためのクイックスタートガイドです。PHP テストのデバッグや SSH 経由のリモートデバッグなどの他のデバッグシナリオについては、デバッグシナリオを参照してください。1. Xdebug をインストールする Xdebug デバッグエンジンは PHP の拡張機能であるため、アプリケーションが実行されるローカルまたはリモート...

ローカル 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 インター...

外部ツール

サードパーティのコマンドラインアプリケーションを外部ツールとして構成して、PhpStorm から実行します。例: ワークフローでは、特定のスクリプト、コードジェネレーター、アナライザー、プリプロセッサーまたはポストプロセッサー、データベースユーティリティなどの実行が必要になる場合があります。外部ツールとして構成することにより、PhpStorm は専用のアクションを提供します。これは、メインメニューや特定のコンテキストメニューから実行したり、ショートカットを割り当てたり、特定の実行構成を起動すると...