PhpStorm 2020.3 ヘルプ

品質ツール

Windows および Linux: ファイル | 設定 | 言語およびフレームワーク | PHP | 品質ツール
macOS: PhpStorm | 環境設定 | 言語およびフレームワーク | PHP | 品質ツール
Ctrl+Alt+S the Settings button

このページは、PHP プラグインが有効になっている場合にのみ使用できます。PHP プラグインは PhpStorm にバンドルされており、デフォルトでアクティブになっています。プラグインが無効になっている場合は、プラグインの管理に従って、設定 / 環境設定 | プラグインページでプラグインを有効にします。

PHP_CodeSniffer

このセクションでは、使用する PHP_CodeSniffer スクリプトを選択します。

項目 説明
構成 コード品質ツールスクリプトを選択します。
  • 特定のリモート PHP インタープリターに関連するスクリプトを使用するには、このインタープリターの名前を選択します。

  • ローカルスクリプトを使用するには、ローカルを選択します。この場合、ローカルコード品質ツールは、プロジェクトで使用されている PHP インタープリター(ローカルまたはリモート)に関係なく実行されます。PhpStorm は PHP エンジンへのパスを含むスクリプト(Windows の場合は phpcs.bat、Linux の場合は phpcs、macOS)を実行するため、コード品質ツールのローカル構成は 1 つだけであることに注意してください。

  • 既定のプロジェクトインタープリター、つまり設定 / 環境設定ダイアログの PHP ページで選択したスクリプトを使用するには、デフォルトでプロジェクトインタープリターを選択します。

無視されたファイルの表示

クリックすると、PHP_CodeSniffer 無視されたファイルダイアログが開きます。このダイアログには、PHP_CodeSniffer がスキップするファイルがリストされています。PhpStorm は、PHP_CodeSniffer からの応答がツールプロセスのタイムアウトフィールドで指定された制限を超えている場合、インスペクションの間にリストに新しいファイルを追加することを提案します。これは、処理速度の低下を防ぐために行われます。各ファイルについて、PhpStorm はその名前と場所を表示します。

  • ファイルを追加するには、the Add button をクリックし、表示されるダイアログで目的のファイルを探します。

  • リストからファイルを削除し、PHP_CodeSniffer に再度処理させるには、ファイルを選択してファイルの除去ボタン the Remove button をクリックします。

  • 一覧からすべてのファイルを削除するには、the Close button をクリックします。

PHP_CodeSniffer ダイアログ

PHP_CodeSniffer ページの構成リストの隣にある the Browse button をクリックするとダイアログが開きます。

このダイアログを使用して、ローカルの PHP_CodeSniffer スクリプトまたはリモート PHP インタープリターに関連付けられたスクリプトを構成し、PHP_CodeSniffer の動作を構成します。詳細については、PHP_CodeSniffer を参照してください。

項目 説明
PHP_CodeSniffer パス

このフィールドで、PHP_CodeSniffer スクリプトの場所を指定します。Windows の場合は phpcs.bat、Linux および macOS の場合は phpcs です。

スクリプトが PHP インタープリターに関連付けられている場合、PhpStorm はそのパスを検出し、フィールドに自動的に入力しますが、必要に応じて編集できます。パスを手動で入力するか、the Browse button をクリックして、開いたダイアログでパスを選択します。

phpcs.bat または phpcs への指定されたパスが PhpStorm と PHP_CodeSniffer 間の相互作用を保証することを確認するには、つまり、ツールを PhpStorm から起動でき、PhpStorm はそこから問題レポートを受信し、検証ボタンをクリックします。この検証は、phpcs --version コマンドの実行と同等です。検証に成功すると、PhpStorm は検出された PHP_CodeSniffer バージョンに関する情報を表示します。

インタープリター このフィールドには、PHP_CodeSniffer を使用するために選択した PHP インタープリターが表示されます。
ツールプロセスのタイムアウト このフィールドで、PhpStorm が PHP_CodeSniffer からの結果を待機する時間を指定します。タイムアウトを超えると、CPU とメモリの過剰な使用を防ぐために、プロセスが終了します。これにより、コンピューターの構成と使用するルールセットに応じて、PHP_CodeSniffer プロセスの動作を微調整できます。
PHP コードの美化と修正の設定 この領域で、phpcbf へのパスフィールドに PHP コードの美化と修正(英語)ツールへのパスを入力します。手動でパスを入力するか、the Browse button をクリックして表示されるダイアログでパスを選択します。

PHP Mess Detector

このセクションでは、使用する Mess Detector スクリプトを選択してください。

項目 説明
構成 Mess Detector スクリプトを選択してください。
  • 特定のリモート PHP インタープリターに関連するスクリプトを使用するには、このインタープリターの名前を選択します。

  • ローカルスクリプトを使用するには、ローカルを選択します。この場合、ローカルの Mess Detector は、どの PHP インタープリター(ローカルまたはリモート)がプロジェクトに使用されていても実行されます。PhpStorm は PHP エンジンへのパスを含むスクリプト(Windows の場合は phpmd.bat、Linux の場合は phpmd、macOS の場合)を実行するため、Mess Detector のローカル構成は 1 つだけです。

  • 既定のプロジェクトインタープリター、つまり設定 / 環境設定ダイアログの PHP ページで選択したスクリプトを使用するには、デフォルトでプロジェクトインタープリターを選択します。

無視されたファイルの表示

クリックすると Mess Detector 無視されたファイルダイアログが開き、Mess Detector がスキップするファイルが一覧表示されます。PhpStorm は、Mess Detector からの応答を待っているときにツールプロセスのタイムアウトフィールドで指定された制限を超えると、インスペクション中に新しいファイルをリストに追加することを提案します。これは処理が遅くなるのを防ぐために行われます。各ファイルについて、PhpStorm はその名前と場所を表示します。

  • ファイルを追加するには、the Add button をクリックし、表示されるダイアログで目的のファイルを探します。

  • リストからファイルを削除して Mess Detector に再度処理させるには、ファイルを選択してファイルの除去ボタン the Remove button をクリックします。

  • 一覧からすべてのファイルを削除するには、the Close button をクリックします。

Mess Detector ダイアログ

Mess Detector ページの構成リストの隣にある the Browse button をクリックするとダイアログが開きます。

このダイアログを使用して、ローカル Mess Detector スクリプトまたはリモート PHP インタープリターに関連付けられたスクリプトを構成し、Mess Detector の動作を構成します。詳細については、PHP Mess Detector を参照してください。

項目 説明
Mess Detector パス

このフィールドで、Mess Detector スクリプトの場所を指定します。Windows の場合は phpmd.bat、Linux および macOS の場合は phpmd です。

スクリプトが PHP インタープリターに関連付けられている場合、PhpStorm はそのパスを検出し、フィールドに自動的に入力しますが、必要に応じて編集できます。パスを手動で入力するか、the Browse button をクリックして、開いたダイアログでパスを選択します。

phpmd.bat または phpmd への指定されたパスが PhpStorm と Mess Detector 間の相互作用を保証することを確認するには、つまり、ツールを PhpStorm から起動でき、PhpStorm がそこから問題レポートを受信することを確認するには、検証ボタンをクリックします。この検証は、phpmd --version コマンドの実行と同じです。検証に合格すると、PhpStorm は検出された Mess Detector バージョンに関する情報を表示します。

インタープリター このフィールドには、Mess Detector を使用するために選択された PHP インタープリターが表示されます。
ツールプロセスのタイムアウト このフィールドで、PhpStorm が Mess Detector からの結果を待機する時間を指定します。タイムアウトを超えると、CPU とメモリの過剰な使用を防ぐために、プロセスが終了します。これにより、コンピューターの構成と使用するルールセットに応じて、Mess Detector プロセスの動作を微調整できます。

PHP CS Fixer

このセクションでは、使用する PHP CS Fixer スクリプトを選択してください。

項目 説明
構成 PHP CS Fixer スクリプトを選択してください。
  • 特定のリモート PHP インタープリターに関連するスクリプトを使用するには、このインタープリターの名前を選択します。

  • ローカルスクリプトを使用するには、ローカルを選択します。この場合、ローカルの PHP CS Fixer は、どの PHP インタープリター(ローカルまたはリモート)がプロジェクトに使用されていても実行されます。PhpStorm は PHP エンジンへのパスを含むスクリプト(Windows では php-cs-fixer.bat、Linux では php-cs-fixer、macOS は macOS)を実行するため、PHP CS Fixer 用のローカル構成は 1 つだけです。

  • 既定のプロジェクトインタープリター、つまり設定 / 環境設定ダイアログの PHP ページで選択したスクリプトを使用するには、デフォルトでプロジェクトインタープリターを選択します。

無視されたファイルの表示

クリックすると PHPCS フィクサーが無視したファイルダイアログが開き、PHP CS Fixer がスキップするファイルが一覧表示されます。PhpStorm は、PHP CS Fixer からの応答をツールプロセスのタイムアウトフィールドで指定された制限を超えると、インスペクション中に新しいファイルをリストに追加するよう提案します。これは処理が遅くなるのを防ぐために行われます。各ファイルについて、PhpStorm はその名前と場所を表示します。

  • ファイルを追加するには、the Add button をクリックし、表示されるダイアログで目的のファイルを探します。

  • リストからファイルを削除し、PHP CS Fixer で再度ファイルを処理するには、ファイルを選択してファイルの除去ボタン the Remove button をクリックします。

  • 一覧からすべてのファイルを削除するには、the Close button をクリックします。

PHP CS Fixer ダイアログ

PHP CS Fixer ページの構成リストの隣にある the Browse button をクリックするとダイアログが開きます。

このダイアログを使用して、ローカルの PHP CS Fixer スクリプトまたはリモート PHP インタープリターに関連付けられたスクリプトを設定したり、PHP CS Fixer の動作を設定したりします。詳細は PHP CS Fixer を参照してください。

項目 説明
PHP CS Fixer のパス

このフィールドで、PHP CS Fixer スクリプトの場所を指定します。Windows の場合は php-cs-fixer.bat、Linux および macOS の場合は php-cs-fixer です。

スクリプトが PHP インタープリターに関連付けられている場合、PhpStorm はそのパスを検出し、フィールドに自動的に入力しますが、必要に応じて編集できます。パスを手動で入力するか、the Browse button をクリックして、開いたダイアログでパスを選択します。

php-cs-fixer.bat または php-cs-fixer への指定されたパスが PhpStorm と PHP CS Fixer の間の対話を確実にすること、つまり PhpStorm からツールを起動でき、PhpStorm がそこから問題レポートを受け取ることを確認するには、検証ボタンをクリックします。この検証は、php-cs-fixer --version コマンドを実行することと同じです。検証に成功した場合、PhpStorm は検出された PHP CS Fixer のバージョンに関する情報を表示します。

インタープリター このフィールドには、PHP CS Fixer の使用元として選択された PHP インタープリターが表示されます。
ツールプロセスのタイムアウト このフィールドで、PhpStorm が PHP CSFixer からの結果を待機する時間を指定します。タイムアウトを超えると、CPU とメモリの過剰な使用を防ぐために、プロセスが終了します。これにより、コンピューターの構成と使用するルールセットに応じて、PHP CSFixer プロセスの動作を微調整できます。

Psalm

このセクションでは、使用する Psalm スクリプトを選択してください。

項目 説明
構成 Psalm スクリプトを選択してください。
  • 特定のリモート PHP インタープリターに関連するスクリプトを使用するには、このインタープリターの名前を選択します。

  • ローカルスクリプトを使用するには、ローカルを選択します。この場合、ローカルの Psalm は、どの PHP インタープリター(ローカルまたはリモート)がプロジェクトに使用されていても実行されます。PhpStorm は PHP エンジンへのパスを含むスクリプト(Windows の場合は psalm.bat、Linux の場合は psalm、macOS の場合)を実行するため、Psalm のローカル構成は 1 つだけです。

  • 既定のプロジェクトインタープリター、つまり設定 / 環境設定ダイアログの PHP ページで選択したスクリプトを使用するには、デフォルトでプロジェクトインタープリターを選択します。

無視されたファイルの表示

クリックすると Psalm 無視されたファイルダイアログが開き、Psalm がスキップするファイルが一覧表示されます。PhpStorm は、Psalm からの応答を待っているときにツールプロセスのタイムアウトフィールドで指定された制限を超えると、インスペクション中に新しいファイルをリストに追加することを提案します。これは処理が遅くなるのを防ぐために行われます。各ファイルについて、PhpStorm はその名前と場所を表示します。

  • ファイルを追加するには、the Add button をクリックし、表示されるダイアログで目的のファイルを探します。

  • リストからファイルを削除して Psalm に再度処理させるには、ファイルを選択してファイルの除去ボタン the Remove button をクリックします。

  • 一覧からすべてのファイルを削除するには、the Close button をクリックします。

Psalm ダイアログ

Psalm ページの構成リストの隣にある the Browse button をクリックするとダイアログが開きます。

このダイアログを使用して、ローカル Psalm スクリプトまたはリモート PHP インタープリターに関連付けられたスクリプトを構成し、Psalm の動作を構成します。詳細については、Psalm を参照してください。

項目 説明
Psalm パス

このフィールドで、Psalm スクリプトの場所を指定します。Windows の場合は psalm.bat、Linux および macOS の場合は psalm です。

スクリプトが PHP インタープリターに関連付けられている場合、PhpStorm はそのパスを検出し、フィールドに自動的に入力しますが、必要に応じて編集できます。パスを手動で入力するか、the Browse button をクリックして、開いたダイアログでパスを選択します。

psalm.bat または psalm への指定されたパスが PhpStorm と Psalm 間の相互作用を保証することを確認するには、つまり、ツールを PhpStorm から起動でき、PhpStorm がそこから問題レポートを受信することを確認するには、検証ボタンをクリックします。この検証は、psalm --version コマンドの実行と同じです。検証に合格すると、PhpStorm は検出された Psalm バージョンに関する情報を表示します。

インタープリター このフィールドには、Psalm を使用するために選択された PHP インタープリターが表示されます。
ツールプロセスのタイムアウト このフィールドで、PhpStorm が Psalm からの結果を待機する時間を指定します。タイムアウトを超えると、CPU とメモリの過剰な使用を防ぐために、プロセスが終了します。これにより、コンピューターの構成と使用するルールセットに応じて、Psalm プロセスの動作を微調整できます。

PHPStan

このセクションでは、使用する PHPStan スクリプトを選択します。

項目 説明
構成 PHPStan スクリプトを選択します。
  • 特定のリモート PHP インタープリターに関連するスクリプトを使用するには、このインタープリターの名前を選択します。

  • ローカルスクリプトを使用するには、ローカルを選択します。この場合、ローカル PHPStan は、プロジェクトで使用されている PHP インタープリター(ローカルまたはリモート)に関係なく実行されます。PhpStorm は PHP エンジンへのパスを含むスクリプト(Windows の場合は phpstan.bat、Linux の場合は phpstan、macOS)を実行するため、PHPStan のローカル構成は 1 つだけであることに注意してください。

  • 既定のプロジェクトインタープリター、つまり設定 / 環境設定ダイアログの PHP ページで選択したスクリプトを使用するには、デフォルトでプロジェクトインタープリターを選択します。

無視されたファイルの表示

クリックして PHPStan 無視ファイルダイアログを開きます。このダイアログには、PHPStan がスキップするファイルが一覧表示されます。PhpStorm は、PHPStan からの応答を待機しているときに、ツールプロセスのタイムアウトフィールドで指定された制限を超えたときに、インスペクション中に新しいファイルをリストに追加することを提案します。これは、処理の速度低下を防ぐために行われます。ファイルごとに、PhpStorm はその名前と場所を表示します。

  • ファイルを追加するには、the Add button をクリックし、表示されるダイアログで目的のファイルを探します。

  • リストからファイルを削除して PHPStan に再度処理させるには、ファイルを選択してファイルの除去ボタン the Remove button をクリックします。

  • 一覧からすべてのファイルを削除するには、the Close button をクリックします。

PHPStan ダイアログ

PHPStan ページの構成リストの隣にある the Browse button をクリックするとダイアログが開きます。

このダイアログを使用して、ローカル PHPStan スクリプトまたはリモート PHP インタープリターに関連付けられたスクリプトを構成し、PHPStan の動作を構成します。詳細については、PHPStan を参照してください。

項目 説明
PHPStan パス

このフィールドで、PHPStan スクリプトの場所を指定します。Windows の場合は phpstan.bat、Linux および macOS の場合は phpstan です。

スクリプトが PHP インタープリターに関連付けられている場合、PhpStorm はそのパスを検出し、フィールドに自動的に入力しますが、必要に応じて編集できます。パスを手動で入力するか、the Browse button をクリックして、開いたダイアログでパスを選択します。

phpstan.bat または phpstan への指定されたパスが PhpStorm と PHPStan 間の相互作用を保証することを確認するには、つまり、ツールを PhpStorm から起動でき、PhpStorm がそこから問題レポートを受信することを確認するには、検証ボタンをクリックします。この検証は、phpstan --version コマンドの実行と同じです。検証に合格すると、PhpStorm は検出された PHPStan バージョンに関する情報を表示します。

インタープリター このフィールドには、PHPStan を使用するために選択された PHP インタープリターが表示されます。
ツールプロセスのタイムアウト このフィールドで、PhpStorm が PHPStan からの結果を待機する時間を指定します。タイムアウトを超えると、CPU とメモリの過剰な使用を防ぐために、プロセスが終了します。これにより、コンピューターの構成と使用するルールセットに応じて、PHPStan プロセスの動作を微調整できます。

関連ページ:

プラグインを管理する

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

PHP_CodeSniffer

PhpStorm は、PHP_CodeSniffer ツールとの統合を通じてコードスタイルチェックを提供します。PHP_CodeSniffer ツールは、選択したコーディング標準との整合性についてコードを検証します。事前定義されたコーディング標準の 1 つを指定するか、デフォルトの PHP_CodeSniffer の Standards ディレクトリの外側にあるルートディレクトリで、以前に定義した独自のコーディング標準を使用できます。さらに、カスタムコーディングスタイルをチームと共有できます。コマンドラ...

PHP Mess Detector

組み込みのコーディング支援に加えて、PhpStorm は、PHP Mess Detector ツールとの統合を通じてソースコードのチェックを提供します。PHP Mess Detector ツールは、コードサイズ、不整合、未使用のコード、命名規則の違反、不適切な設計などに関連する潜在的な問題を検出します。コマンドラインではなく PhpStorm から PHP Mess Detector を使用するには、PhpStorm に登録し、PhpStorm コードインスペクションとして設定する必要があります。Ph...

PHP CS Fixer

組み込みのコーディング支援に加えて、PhpStorm は、コード内のコーディング標準の問題を検出する PHP CS Fixer ツールとの統合によってソースコードをチェックします。コマンドラインの代わりに PhpStorm から PHP CS Fixer を使用するには、それを PhpStorm に登録し、PhpStorm コードインスペクションとして構成する必要があります。PhpStorm にインストールして有効にすると、ツールは開いているすべての PHP ファイルで使用できるようになり、起動するた...

Psalm

PhpStorm は、Psalm ツールとの統合を通じてコード品質チェックを提供します。このツールは、一連の検証ルールに対してコードの整合性を検証します。コマンドラインの代わりに PhpStorm から Psalm を使用するには、PhpStorm に登録し、PhpStorm コードインスペクションとして構成する必要があります。PhpStorm にインストールして有効にすると、開いている PHP ファイルでツールを使用できるようになり、起動するために追加の手順は必要ありません。オンザフライのコードチ...

PHPStan

PhpStorm は、PHPStan ツールとの統合を通じてコード品質チェックを提供します。このツールは、一連の検証ルールに対してコードの整合性を検証します。コマンドラインの代わりに PhpStorm から PHPStan を使用するには、PHPStan を PhpStorm に登録し、PhpStorm コードインスペクションとして構成する必要があります。PhpStorm にインストールして有効にすると、開いている PHP ファイルでツールを使用できるようになり、起動するために追加の手順は必要ありま...