PSR-2 コーディング スタイル ガイド

コードスタイル仕様

この仕様は、PSR-1 の基本コード仕様を継承および拡張したものです。

この仕様は、PHP コードを標準化するための一連のルールを策定することにより、さまざまな作成者のコードを参照するときに、さまざまなコーディング スタイルによって引き起こされる不便を軽減することを目的としています。

複数のプログラマが複数のプロジェクトで共同作業する場合、共通のコーディング標準が必要です。

この記事のスタイル仕様は、複数の異なるプロジェクトのコーディング スタイルの共通の特性から派生しています。

したがって、この記事の値は仕様はそれ自体ではなく、私たち全員が従うコーディング スタイルにあります。

1. 概要

• コードは、PSR-1 のコーディング規約に従う必要があります。

• コードでは、インデントにタブ キーの代わりに 4 つのスペースを使用する必要があります。
  1 行あたりの文字数
は、緩やかに 80 以内に保つ必要があります。理論的には、
• 120 を超えてはなりませんが、

  ハード制限を設けてはなりません 。 各名前空間宣言ステートメントと use 宣言ブロックの後に、 空白行を挿入する必要があります。

• 左中括弧 ({) は関数宣言の後の独自の行に記述する必要があり、右中括弧 (}) も関数本体の後の独自の行に記述する必要があります。

• 左中括弧 ({)

  は関数宣言の後の独自の行に記述する必要があり、右中括弧 (}) も関数本体の後の独自の行に記述する必要があります。 クラスのプロパティとメソッドは

  アクセス修飾子(private、protected、public)、abstractとfinalを追加する必要があります
アクセス修飾子の前に宣言する必要があります
• 、staticはアクセス修飾子の後に宣言する必要があります

  。 制御構造のキーワード

  の後にはスペース文字
が必要ですが、メソッドまたは関数を呼び出すときは
• 存在してはなりません。

  コントロール構造の左中括弧 ( {) は宣言と同じ行に記述する必要があり、右中括弧 ( }) は本文の後の独自の行に 記述する必要があります。

• 制御構造の左括弧の開始と右括弧の前にスペースがあってはなりません。 1.1. 例

次のサンプル プログラムは、上記の仕様のほとんどを簡単に示しています:

• <?phpnamespace Vendor\Package;use FooInterface;use BarClass as Bar;use OtherVendor\OtherPackage\BazClass;class Foo extends Bar implements FooInterface{    public function sampleFunction($a, $b = null)    {        if ($a === $b) {            bar();        } elseif ($a > $b) {            $foo->bar($arg1);        } else {            BazClass::bar($arg2, $arg3);        }    }    final public static function bar()    {        // method body    }}

  一般規則 2.1 基本的なコーディング ガイドライン

コード
• は PSR-1 のすべての仕様に準拠する必要があります。

  2.2 ファイル

  すべての PHP ファイルは、
Unix LF (改行) を行末記号として使用する必要があります。

すべての PHP ファイルは

空白行で終わる必要があります

。

純粋な PHP コード ファイル
1. 最後の ?> 終了タグを省略する必要があります。

2.3. 線

線の長さ

には厳しい制約があってはなりません

。 ソフトな長さの制約 は 120 文字に制限する必要があります

この長さを超える場合、コード仕様チェックのあるエディターは警告を

発行する必要がありますが、エラー プロンプトを

発行してはなりません

。 各行は 80 文字を超えてはならず、

80 文字を超える行は複数行に折りたたむ必要があります

。 非空白行の後には 余分なスペースがあってはなりません。

空白行 を使用すると、 コードが読みやすくなり、コードが分割されやすくなります。

各行に

複数のステートメントを含めることはできません

。 2.4. インデント コードでは 4 つのスペースのインデントを使用する必要があり、Tab キーを使用してはなりません

。

注: インデントにタブ キーの代わりにスペースを使用する利点は、コードの相違点の比較、パッチ適用、コードの再読み込み、およびコメントの混乱を回避できることです。 また、位置合わせを容易にするために、インデントにスペースを使用します。

2.5. キーワードと True/False/Null PHP すべてのキーワードはすべて小文字でなければなりません。

定数 true、false、null も すべて小文字でなければなりません 。

名前空間と use 宣言

名前空間宣言の後には空行を挿入する必要があります。 すべての使用は名前空間の後に宣言する必要があります。

各 use ステートメントには use キーワードを 1 つだけ含める必要があります。

use ステートメント ブロックの後には空行が必要です。 例:

<?phpnamespace Vendor\Package;use FooClass;use BarClass as Bar;use OtherVendor\OtherPackage\BazClass;// ... additional PHP code ...

クラス、プロパティ、メソッド

ここでの「クラス」は、すべてのクラス、インターフェイス、および特性の再利用可能なコード ブロックを指します。

4.1. 扩展与继承

关键词 extends和 implements 必须写在类名称的同一行。

类的开始花括号 必须独占一行，结束花括号也 必须在类主体后独占一行。

<?phpnamespace Vendor\Package;use FooClass;use BarClass as Bar;use OtherVendor\OtherPackage\BazClass;class ClassName extends ParentClass implements \ArrayAccess, \Countable{    // constants, properties, methods}

implements的继承列表也 可以分成多行，这样的话，每个继承接口名称都 必须分开独立成行，包括第一个。

<?phpnamespace Vendor\Package;use FooClass;use BarClass as Bar;use OtherVendor\OtherPackage\BazClass;class ClassName extends ParentClass implements    \ArrayAccess,    \Countable,    \Serializable{    // constants, properties, methods}

4.2. 属性

每个属性都 必须添加访问修饰符。

一定不可使用关键字 var声明一个属性。

每条语句 一定不可定义超过一个属性。

不要使用下划线作为前缀，来区分属性是 protected 或 private。

以下是属性声明的一个范例：

<?phpnamespace Vendor\Package;class ClassName{    public $foo = null;}

4.3. 方法

所有方法都 必须添加访问修饰符。

不要使用下划线作为前缀，来区分方法是 protected 或 private。

方法名称后 一定不能有空格符，其开始花括号 必须独占一行，结束花括号也 必须在方法主体后单独成一行。参数左括号后和右括号前 一定不能有空格。

一个标准的方法声明可参照以下范例，留意其括号、逗号、空格以及花括号的位置。

<?phpnamespace Vendor\Package;class ClassName{    public function fooBarBaz($arg1, &$arg2, $arg3 = [])    {        // method body    }}

4.4. 方法的参数

参数列表中，每个逗号后面 必须要有一个空格，而逗号前面 一定不能有空格。

有默认值的参数， 必须放到参数列表的末尾。

<?phpnamespace Vendor\Package;class ClassName{    public function foo($arg1, &$arg2, $arg3 = [])    {        // method body    }}

参数列表 可以分列成多行，这样，包括第一个参数在内的每个参数都 必须单独成行。

拆分成多行的参数列表后，结束括号以及方法开始花括号 必须 写在同一行，中间用一个空格分隔。

<?phpnamespace Vendor\Package;class ClassName{    public function aVeryLongMethodName(        ClassTypeHint $arg1,        &$arg2,        array $arg3 = []    ) {        // method body    }}

4.5. abstract、 final、 以及 static

需要添加 abstract或 final声明时， 必须写在访问修饰符前，而 static则 必须写在其后。

<?phpnamespace Vendor\Package;abstract class ClassName{    protected static $foo;    abstract protected function zim();    final public static function bar()    {        // method body    }}

4.6. 方法及函数调用

方法及函数调用时，方法名或函数名与参数左括号之间 一定不能有空格，参数右括号前也 一定不能有空格。每个参数前 一定不能有空格，但其后 必须有一个空格。

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

参数 可以分列成多行，此时包括第一个参数在内的每个参数都 必须单独成行。

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

1. 控制结构

控制结构的基本规范如下：

• 控制结构关键词后 必须有一个空格。
• 左括号 (后 一定不能有空格。
• 右括号 )前也 一定不能有空格。
• 右括号 )与开始花括号 {间 一定有一个空格。
• 结构体主体 一定要有一次缩进。
• 结束花括号 } 一定在结构体主体后单独成行。

每个结构体的主体都 必须被包含在成对的花括号之中，

这能让结构体更加结构话，以及减少加入新行时，出错的可能性。

5.1. if、 elseif和 else

标准的 if结构如下代码所示，留意 括号、空格以及花括号的位置，

注意 else和 elseif都与前面的结束花括号在同一行。

<?phpif ($expr1) {    // if body} elseif ($expr2) {    // elseif body} else {    // else body;}

应该使用关键词 elseif代替所有 else if，以使得所有的控制关键字都像是单独的一个词。

5.2. switch和 case

标准的 switch结构如下代码所示，留意括号、空格以及花括号的位置。

case语句 必须相对 switch进行一次缩进，而 break语句以及 case内的其它语句都 必须 相对 case进行一次缩进。

如果存在非空的 case直穿语句，主体里必须有类似 // no break的注释。

<?phpswitch ($expr) {    case 0:        echo 'First case, with a break';        break;    case 1:        echo 'Second case, which falls through';        // no break    case 2:    case 3:    case 4:        echo 'Third case, return instead of break';        return;    default:        echo 'Default case';        break;}

5.3. while和 do while

一个规范的 while语句应该如下所示，注意其 括号、空格以及花括号的位置。

<?phpwhile ($expr) {    // structure body}

标准的 do while语句如下所示，同样的，注意其 括号、空格以及花括号的位置。

<?phpdo {    // structure body;} while ($expr);

5.4. for

标准的 for语句如下所示，注意其 括号、空格以及花括号的位置。

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

5.5. foreach

标准的 foreach语句如下所示，注意其 括号、空格以及花括号的位置。

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

5.6. try, catch

标准的 try catch语句如下所示，注意其 括号、空格以及花括号的位置。

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

1. 闭包

闭包声明时，关键词 function后以及关键词 use的前后都 必须要有一个空格。

开始花括号 必须写在声明的同一行，结束花括号 必须紧跟主体结束的下一行。

参数列表和变量列表的左括号后以及右括号前， 必须不能有空格。

参数和变量列表中，逗号前 必须不能有空格，而逗号后 必须要有空格。

闭包中有默认值的参数 必须放到列表的后面。

标准的闭包声明语句如下所示，注意其 括号、逗号、空格以及花括号的位置。

<?php$closureWithArgs = function ($arg1, $arg2) {    // body};$closureWithArgsAndVars = function ($arg1, $arg2) use ($var1, $var2) {    // body};

参数列表以及变量列表 可以分成多行，这样，包括第一个在内的每个参数或变量都 必须单独成行，而列表的右括号与闭包的开始花括号 必须放在同一行。

以下几个例子，包含了参数和变量列表被分成多行的多情况。

<?php$longArgs_noVars = function (    $longArgument,    $longerArgument,    $muchLongerArgument) {   // body};$noArgs_longVars = function () use (    $longVar1,    $longerVar2,    $muchLongerVar3) {   // body};$longArgs_longVars = function (    $longArgument,    $longerArgument,    $muchLongerArgument) use (    $longVar1,    $longerVar2,    $muchLongerVar3) {   // body};$longArgs_shortVars = function (    $longArgument,    $longerArgument,    $muchLongerArgument) use ($var1) {   // body};$shortArgs_longVars = function ($arg) use (    $longVar1,    $longerVar2,    $muchLongerVar3) {   // body};

注意，闭包被直接用作函数或方法调用的参数时，以上规则仍然适用。

<?php$foo->bar(    $arg1,    function ($arg2) use ($var1) {        // body    },    $arg3);

1. 总结

以上规范难免有疏忽，其中包括但不仅限于：

• 全局变量和常量的定义

• 函数的定义

• 操作符和赋值

• 行内对齐

• 注释和文档描述块

• 类名的前缀及后缀

• 最佳实践

本规范之后的修订与扩展将弥补以上不足。