PHP_CodeSniffer

PHP_CodeSniffer を Composer と共にインストールすると、PhpStorm は必要なスクリプトを自動的にダウンロードし、IDE に登録し、オプションで対応するコードインスペクションを有効にして構成します。

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

2. 以下のいずれか 1 つを実行します:

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

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

composer.json エディターガターのパッケージレコードの横にあるをクリックして、対応する設定 / 環境設定ページにジャンプし、PHP_CodeSniffer を手動で構成します。

PHP_CodeSniffer 設定をリセット

PHP_CodeSniffer が最初に構成された後、composer.json をさらに変更しても、インスペクション構成には影響しません。新しい変更を適用するには、PHP_CodeSniffer 構成をリセットします。

1. 設定 / 環境設定ダイアログ Ctrl+Alt+S で、言語 & フレームワーク | PHP | 品質ツールにナビゲートします。

2. 開いている品質ツールページで、PHP_CodeSniffer 領域を展開し、構成リストの横にあるをクリックします。

3. 開いた PHP_CodeSniffer ダイアログで、PHP_CodeSniffer パスフィールドを空にします。

   

4. composer.json エディターパネルの上部にある更新をクリックして、プロジェクト Composer の依存関係を更新します。詳細については、依存関係の更新を参照してください。

PhpStorm は、PHP_CodeSniffer 構成を新たに実行するため、composer.json の変更を適用します。

使用する PHP_CodeSniffer スクリプトを選択する

1. 設定 / 環境設定ダイアログ Ctrl+Alt+S で、言語 & フレームワーク | PHP | 品質ツールにナビゲートします。

2. 開いた品質ツールページで、PHP_CodeSniffer 領域を展開します。構成リストから、PHP_CodeSniffer スクリプトを選択します。

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

   • ローカルスクリプトを使用するには、ローカルを選択します。この場合、プロジェクトで使用されている PHP インタープリター（ローカルまたはリモート）に関係なく、ローカルの PHP_CodeSniffer が実行されます。PhpStorm は PHP エンジンへのパスを含むスクリプト（Windows の場合は phpcs.bat、Linux および macOS の場合は phpcs ）を実行するため、PHP_CodeSniffer のローカル構成は 1 つしか存在できないことに注意してください。

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

ローカルの PHP_CodeSniffer スクリプトを構成する

1. PHP_CodeSniffer(英語) スクリプトをダウンロードしてインストールします。

   PHP_CodeSniffer のインストールを確認するには、インストールディレクトリに切り替えて、次のコマンドを実行します。

   phpcs --version

   ツールが利用可能な場合は、次の形式のメッセージが表示されます。

   PHP_CodeSniffer version <version> (stable) by Squiz. (http://www.squiz.net)

   独自のカスタムコーディング標準に対してコードをチェックするには、コードを作成し(英語)ます。ルールと指す ruleset.xml ファイルをコーディング標準のルートディレクトリに保存します。

2. ローカルの PHP_CodeSniffer スクリプトを PhpStorm に登録します。

   • 設定 / 環境設定ダイアログ Ctrl+Alt+S で、言語 & フレームワーク | PHP | 品質ツールにナビゲートします。

   • 開いている品質ツールページで、PHP_CodeSniffer 領域を展開し、構成リストの横にあるをクリックします。

   • 開く PHP_CodeSniffer ダイアログで、PHP_CodeSniffer パスフィールドに phpcs.bat または phpcs PHP_CodeSniffer 実行可能ファイルの場所を指定します。パスを手動で入力するか、をクリックして、表示されるダイアログで関連するフォルダーを選択します。

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

3. 必要に応じて、ツールプロセスのタイムアウトフィールドで、PhpStorm が PHP_CodeSniffer からの結果を待機する時間を指定します。その後、CPU とメモリの過剰な使用を防ぐために、プロセスが終了します。

4. 必要に応じて、PHP コードの美化と修正の設定領域で、phpcbf へのパスフィールドに PHP コードの美化と修正(英語)ツールへのパスを指定します。これにより、PHP_CodeSniffer によって検出されたエラーの多くを自動的に修正できます。PHP_CodeSniffer を Composer とともにインストールすると、PHP コードの美化と修正が検出され、自動的にセットアップされます。

PHP インタープリターに関連付けられた PHP_CodeSniffer スクリプトを構成する

1. 設定 / 環境設定ダイアログ Ctrl+Alt+S で、言語 & フレームワーク | PHP | 品質ツールに移動します。

2. 開いた品質ツールページで、PHP_CodeSniffer 領域を展開し、構成リストの横にあるをクリックします。PHP_CodeSniffer ダイアログが開き、左側のペインに構成済みのすべての PHP_CodeSniffer スクリプトのリストが表示されます。そのうちの 1 つはローカルタイプで、その他はスクリプトが関連付けられている PHP インタープリターにちなんで名付けられています。

3. ツールバーのをクリックします。開いたリモートインタープリターによる PHP_CodeSniffer ダイアログで、関連するスクリプトを使用するリモート PHP インタープリターを選択します。リストに関連するインタープリターが含まれていない場合は、をクリックし、リモート PHP インタープリターの構成の説明に従って CLI インタープリターダイアログでリモートインタープリターを構成します。

   OK をクリックすると、PhpStorm によって PHP_CodeSniffer ダイアログに戻り、新しい PHP_CodeSniffer 構成がリストに追加され、右側のペインに選択されたリモート PHP インタープリター、それに関連付けられた PHP_CodeSniffer へのパス、および高度な PHP_CodeSniffer オプションが表示されます。

4. 必要に応じて、ツールプロセスのタイムアウトフィールドで、PhpStorm が PHP_CodeSniffer からの結果を待機する時間を指定します。その後、CPU とメモリの過剰な使用を防ぐために、プロセスが終了します。

5. 必要に応じて、PHP コードの美化と修正の設定領域で、phpcbf へのパスフィールドに PHP コードの美化と修正(英語)ツールへのパスを指定します。これにより、PHP_CodeSniffer によって検出されたエラーの多くを自動的に修正できます。PHP_CodeSniffer を Composer とともにインストールすると、PHP コードの美化と修正が検出され、自動的にセットアップされます。