PHP_CodeSniffer

Composer で PHP_CodeSniffer をインストールする

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

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

2. 次のいずれかを実行します：

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

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

composer.json エディターのガター内のパッケージレコードの横にある をクリックすると、対応する 設定 ページが表示され、そこで PHP_CodeSniffer を手動で構成できます。

PHP_CodeSniffer 設定をリセット

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

1. 設定 ダイアログ (Ctrl+Alt+S) で、 PHP | 品質ツール | PHP_CodeSniffer に移動します。

2. 構成 リストの横にある をクリックします。

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

   

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

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

PhpStorm で PHP_CodeSniffer を構成する

Composer を使用して PHP_CodeSniffer をインストールすると、PhpStorm は vendor/bin フォルダー内の PHP_CodeSniffer および PHP Code Beautifier and Fixer の実行可能ファイルを自動的に検出し、システムパスで構成された PHP インタープリターを設定して実行します。

設定 (Ctrl+Alt+S) | PHP | 品質ツール | PHP_CodeSniffer で、デフォルトの PHP インタープリターを変更したり、パスを 手動でダウンロードしてインストールした PHP_CodeSniffer 実行可能ファイルに設定したり、PhpStorm で PHP_CodeSniffer を実行する際に渡されるオプションを追加できます。

• 構成: このフィールドでは、デフォルトの PHP インタープリターと、PHP_CodeSniffer および PHP Code Beautifier と Fixer の実行可能ファイルへのパスを変更できます。

  1. インタープリターのみを変更するには、プロジェクトで構成されたローカルおよびリモート PHP インタープリターのリストから必要な項目を選択します。

  2. 実行可能ファイルへのパス、またはインタープリターとパスの両方を変更するには、 構成 リストの横にある をクリックして PHP_CodeSniffer ダイアログを開き、 PHP_CodeSniffer ダイアログ リファレンスページの説明に従ってフィールドを編集します。

• 無視対象ファイルの表示: この設定を使用して、 PHP_CodeSniffer 検証インスペクションからファイルを除外します。 詳細については、 品質ツール リファレンスページを参照してください。

• オプション: この領域で、 PHP_CodeSniffer を PhpStorm インスペクションとして実行するオプションを追加します。 PHP_CodeSniffer リファレンスページの説明に従って、フィールドを編集します。

PHP_CodeSniffer インスペクションを Composer で有効にする

composer.json の スクリプト(英語)セクション内に、デフォルトおよびカスタムの PHP_CodeSniffer ルールセットに関する情報を含めることができます。 プロジェクトの依存関係を インストールまたは 更新すると、指定されたルールセットが検出され、 PHP_CodeSniffer 検証インスペクションが自動的に有効になります。

composer.json の スクリプト セクションにルールセットが指定されていない場合、PhpStorm はさらにプロジェクトルートをチェックして、 phpcs.xml のデフォルト名でルールセットを探します。 ファイルが存在する場合は、インスペクションの カスタムルールセットとして自動的に選択されます。

• composer.json の スクリプト セクションで、 phpcs PHP_CodeSniffer 起動コマンドをリーフ要素の 1 つに追加します。

  使用するコーディング標準を示すために --標準 引数を指定します。 例: 次のレコードを追加すると PSR2 にコーディング標準が設定されます。

  "scripts": { "phpcs": "phpcs --standard=PSR2" }

  次のレコードを追加すると、コーディング標準が カスタムに設定され、ルールセットのパスが <project root>/phpcs.xml に設定されます。

  "scripts": { "phpcs": "phpcs --standard=phpcs.xml" }

さらに、 composer.json の require-dev セクション内にカスタムの非 PSR 標準依存関係を提供して、自動的に検出させることもできます。 現在、以下の規格がサポートされています。

• Doctrine(英語)

• Drupal Coder(英語)

• Joomla(英語)

• Magento(英語)

• MediaWiki(英語)

• PHPCompatibility(英語)

• Symfony(英語)

• WordPress(英語)

• Yii(英語)

インスペクション設定で PHP_CodeSniffer 検証を有効にする

1. 設定 ダイアログ（Ctrl+Alt+S ）で、 エディター の インスペクション をクリックします。

2. 開いている インスペクション ページで、 PHP | 品質ツール ノードを展開し、 PHP_CodeSniffer 検証 の横にあるチェックボックスを選択します。

   

3. ページの右側のペインで、PhpStorm が PHP_CodeSniffer インスペクション出力をどのように処理するかを構成してください：

   • スコープ: インスペクションアプリケーションを制限する スコープを選択します。

   • 重大度: インスペクションの 重大度を選択します。 選択した値によって、検出された不一致が PhpStorm でどの程度深刻に扱われ、 インスペクション結果に表示されるかが決まります。

   • エディター内のハイライト: インスペクションによって検出された問題をエディターでハイライトする方法を選択します。

1. メインメニューで コード | コードのインスペクション へ移動します。

2. 開いた インスペクションスコープの指定 ダイアログで、リストからインスペクションプロファイルを選択するか、 構成… をクリックして インスペクションダイアログを開き、新しいプロファイルを構成します。

   構成… をクリックして、選択したインスペクションプロファイルの範囲内で適用される修正を確認し、 PHP_CodeSniffer 検証インスペクションが有効になっていることを確認することもできます。

3. インスペクションの結果を 問題ツールウィンドウ で見る。 PHP_CodeSniffer によって報告されるエラーおよび警告は、PhpStorm の内部インスペクションと区別するために phpcs の接頭辞が付けられます。

   

クイックフィックスを使用して問題を修正する

PhpStorm は問題を検出すると、PHP_CodeSniffer インスペクション設定に従ってハイライトします。

1. 検出された問題にキャレットを置いて をクリックするか、 Alt+Enter を押します。

2. ポップアップメニューから PHP コードの美化と修正: ファイル全体を修正する を選択してください。 これにより、現在のファイルで検出されたすべての問題が修正されます。

バッチモードで問題を検出したり、 コードの再フォーマットで自動的に修正したりすることもできます。

コードの再フォーマットに関する問題を修正する

コードの再フォーマットアクションを実行することで、PHP_CodeSniffer によって検出された問題を修正できます。

1. 品質ツールの設定で PHP コードの美化と修正 を外部フォーマッタとして設定します。

   これを行うには、 設定 ダイアログ (Ctrl+Alt+S) で PHP | 品質ツール に移動し、 外部フォーマッター セクションで PHP コードの美化と修正 を選択します。

   

2. 必要なファイルまたはプロジェクトスコープに コードの整形を適用します。

   • エディターで開かれたコードフラグメントまたはファイルの場合、メインメニューから コード | コードの整形 を選択するか、 Ctrl+Alt+L を押します。

   • プロジェクト ツールウィンドウで選択したファイル、ディレクトリ、ファイルのグループについて、コンテキストメニューから コードの整形​ を選択するか、 Ctrl+Alt+L を押します。

1. 設定 ダイアログ (Ctrl+Alt+S) で、 PHP | 品質ツール | PHP_CodeSniffer に移動します。

2. 無視対象ファイルの表示 リンクをクリックします。

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

   • リストからファイルを削除し、PHP_CodeSniffer で再度処理するには、ファイルを選択して をクリックします。

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