【PHP】PSR-2 Coding Style Guide（コーディングスタイルガイド）

基本的なコーディング標準

コードは、PSR-1に記載されているすべてのルールに従う。

ファイル

• すべてのPHPファイルはUnix LF（改行）行末を使用する。
• すべてのPHPファイルは空白行で終わらせる。
• PHPのみのファイルの場合、終了タグ?>は省略する。

行

このセクションでは、行レベルでの記述（１行につき）について定めています。

インデント

インデントはタブではなく、4つのスペースを使用する。

スペースをタブと混合しないで空白のみを使用すれば、差分、パッチ、履歴、注釈の問題を回避できる。調整の為に細かいサブインデントを挿入するのも簡単になる。

キーワードとTrue / False / Null

• PHPのキーワードは小文字で記述する。
• PHPの定数「true」「false」「null」は小文字で記述する。

拡張と実装

• extendsとimplementsはクラス名と同じ行で宣言する。
• クラスの開始波括弧（オープニングブレース） { は次の行にそれのみで記述する。
• クラスの終了波括弧（クローズドブレース） } は本文の次の行に記述する。

class MyClass extends YouClass implements SheClass, HeClass
{
  
}

複数のimplementsは複数行に分ける事ができる。そうする場合は、1つめから改行を行い、1行につき1つの運ターフェイスを記述する。

class ClassName extends ParentClass implements
  \ArrayAccess,
  \Countable,
  \Serializable
{

プロパティ

すべてのプロパティで可視性を宣言する。

class SampleClass
{
  public $foo;
  private $bar;
  protected $haystack;
}

• プロパティの宣言にvarは使わない。
• 1つのステートメントで2つ以上のプロパティは定義しない。

class SampleClass
{
  public $foo, $bar; // ← この書き方はダメ
}

プロパティ名には、暗黙のprivateを示す為に接頭辞アンダースコアを付ける事はしない。

メソッド

• すべてのメソッドで可視性を宣言する。
• メソッド名には、暗黙のprivateを示すような接頭辞アンダースコアは付けない。
• メソッド名の後ろにはスペースを入れない。
• 開始/終了波括弧は単体それのみで１行に記述する。
• 開始括弧の後ろにはスペースを入れない。
• 閉じ括弧の前にはスペースを入れない。

class SampleController
{
    public function index($arg1, $arg2)
    {

    }

メソッドの引数

• 引数を記述する際には、カンマの前にスペースは入れない。
• カンマの後にスペースを1つ入れる。
• デフォルト値を持つメソッド引数は最後に置く。

public function index($arg1, &$arg2, $arg3 = [])
{

}

引数リストは複数の行に分割OK。その場合は1つめから改行し、1行に1つの引数を記述する。また、その場合、閉じ括弧と開始波括弧は1つのスペースを挟んで1行に記述する

public function aVeryLongMethodName(
    ClassTypeHint $arg1,
    &$arg2,
    array $arg3 = []
) {
  // method body
}

abstract/final/static

• abstractとfinalは可視性の宣言の前に記述する。
• staticは可視性の宣言の後に記述する。

abstract class ClassName
{
    protected static $foo;
  
    abstract protected function zim();
  
    final public static function bar()
    {
      // method body
    }
}

メソッドと関数のコール

• メソッドや関数を呼び出す時は、メソッド・関数名と開始括弧の間にスペースを入れない。
• 開始括弧の後にスペースを入れない。
• 閉じ括弧の前にスペースを入れない。
• 引数リストでは各カンマの前にスペースを入れない。
• 引数リストでは各カンマの後ろにスペースを1つ入れる。

<?php
bar();
$foo->bar($arg1);
Foo::bar($arg2, $arg3);

引数リストは複数行に分割OK。その場合は第一引数も改行し、1行に1つの引数を記述する。

<?php
$foo->bar(
  $longArgument,
  $longerArgument,
  $muchLongerArgument
);

if/elseif/else

ifの書式は以下の通り。

<?php

if ($foo) {
  
} elseif ($bar) {
  
} else {
  
}

• 括弧、スペース、および中括弧の配置に注意する。
• elseとelseifは前のボディの閉じた終了波括弧と同じ行にある。
• 全ての制御キーワードが単一のように見えるように、else if ではなく elseif を使う。

switch/case

switch構造は以下の通り。

<?php

switch ($hoge) {
    case 0:
        echo '通常パターン。breakします。';
        break;
    case 1:
        echo 'no breakパターン。処理は継続されます。';
    // no break
    case 2:
    case 3:
    case 4:
        echo 'returnパターン, breakの代わりにreturnします。';
        return;
    default:
        echo 'Default case';
        break;
}

• 括弧、スペース、中括弧の配置に注意する。
• case文はswitchから一度インデントする。
• breakキーワード（または他の終了キーワード）はcase本体と同じレベルでインデントする。
• 空ではないケース本体でフォールスルーを行う場合は // no break などのコメントを記述する。

while/do while

while構造は以下の通り。

<?php

while ($expr) {
    // structure body
}

do {
    // structure body;
} while ($expr);

括弧、スペース、中括弧の配置に注意する。

for

for構造は以下の通り。

<?php

for ($i = 0; $i < 10; $i++) {
    // for body
}

括弧、スペース、中括弧の配置に注意する。

foreach

foreach構造は以下の通り。

<?php

foreach ($iterable as $key => $value) {
    // foreach body
}

括弧、スペース、中括弧の配置に注意する。

try catch

try catchブロックは以下の通り。

<?php

try {
    // try body
} catch (FirstExceptionType $e) {
    // catch body
} catch (OtherExceptionType $e) {
    // catch body
}

括弧、スペース、中括弧の配置に注意する。

未来のPSR-2拡張要素

このガイド（PSR-2）で意図的に省略されたスタイルと実践の多くの要素があります。 これには以下のものが含まれます。

• グローバル変数とグローバル定数の宣言
• 関数の宣言
• 演算子と代入
• ライン間アライメント
• コメントとドキュメントブロック
• クラス名の接頭辞と接尾辞
• ベストプラクティス

スタイルや実践のそれらの要素や他の要素に対処するために、このガイドを改訂し、拡張することができる。

調査・アンケート

PSR-2策定のために、ワークグループはメンバーに対してコーディングスタイルについてのアンケートを行っているそうです。

その調査項目・回答結果についての全てのデータが公表されています。
https://www.php-fig.org/psr/psr-2/#appendix-a-survey