導入
導入 – 説明および単純な使用例
説明
PHP_CodeSniffer は PHP5 用のスクリプトで、PHP や JavaScript のコードについて構文解析や "sniff (クンクンにおいを嗅ぐこと)" を行い、 コーディング規約に反するところを検出します。 開発者には不可欠であろうこのツールを使用することで、 あなたのコードをきれいで一貫性のあるものにできます。 また、開発者がおかしがちな間違いを防ぐ助けにもなります。
PHP_CodeSniffer におけるコーディング規約とは、 sniff ファイル群のことです。 各 sniff ファイルは、コーディング規約のひとつの項目のみをチェックします。 PHP_CodeSniffer では複数のコーディング規約を使用することができるので、 一度インストールすれば複数のプロジェクトでそれを使用できます。 PHP_CodeSniffer がデフォルトで使用するのは、 PEAR のコーディング規約です。
例
PEAR コーディング規約を用いてファイルをチェックするには、単純にそのファイルの場所を指定します。
PHP_CodeSniffer によるファイルのチェック
$ phpcs /path/to/code/myfile.php
FILE: /path/to/code/myfile.php
--------------------------------------------------------------------------------
FOUND 5 ERROR(S) AFFECTING 2 LINE(S)
--------------------------------------------------------------------------------
2 | ERROR | Missing file doc comment
20 | ERROR | PHP keywords must be lowercase; expected "false" but found "FALSE"
47 | ERROR | Line not indented correctly; expected 4 spaces but found 1
51 | ERROR | Missing function doc comment
88 | ERROR | Line not indented correctly; expected 9 spaces but found 6
--------------------------------------------------------------------------------
あるいは、ディレクトリ全体をチェックしたい場合はディレクトリの場所を指定します。
PHP_CodeSniffer によるディレクトリのチェック
$ phpcs /path/to/code
FILE: /path/to/code/myfile.php
--------------------------------------------------------------------------------
FOUND 5 ERROR(S) AFFECTING 5 LINE(S)
--------------------------------------------------------------------------------
2 | ERROR | Missing file doc comment
20 | ERROR | PHP keywords must be lowercase; expected "false" but found "FALSE"
47 | ERROR | Line not indented correctly; expected 4 spaces but found 1
51 | ERROR | Missing function doc comment
88 | ERROR | Line not indented correctly; expected 9 spaces but found 6
--------------------------------------------------------------------------------
FILE: /path/to/code/yourfile.php
--------------------------------------------------------------------------------
FOUND 1 ERROR(S) AND 1 WARNING(S) AFFECTING 1 LINE(S)
--------------------------------------------------------------------------------
21 | ERROR | PHP keywords must be lowercase; expected "false" but found
| | "FALSE"
21 | WARNING | Equals sign not aligned with surrounding assignments
--------------------------------------------------------------------------------
忘却曲線を使ってこの知識を確実に記憶に残す
