PHP PSR-2コーディングスタイル仕様

コードスタイルの指定

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

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

複数のプログラマーが複数のプロジェクトで共同作業する場合、共通のコーディング仕様が必要です。
この記事のスタイル仕様は、複数の異なるプロジェクトのコーディング スタイルの共通の特性に基づいています。
したがって、この仕様の価値は私たち全員にあります。それ自体ではなく、このコーディング スタイルに従ってください。

キーワード「しなければならない」（「MUST」）、「してはならない/してはならない」（「MUST NOT」）、「必要」（「必須」）、
「するつもり」（「SHALL」）、「しない」（ 「してはならない」)、「すべきである」(「すべきである」)、「すべきではない」(「すべきではない」)、
「推奨する」(「推奨」)、「できる」(「してもよい」)、および「オプション」(" OPTIONAL") については、[RFC 2119][] で詳細に説明されています。

概要

---

コードは [PSR-1][] のコーディング規約に従わなければなりません。

コードでは、インデントにタブ キーの代わりに 4 つのスペースを使用する必要があります。

1 行あたりの文字数 は、ソフト的に 80 以内に抑える必要があります。理論的には

120 を超えてはなりませんが、

ハード制限を設けてはなりません 。 各名前空間宣言と use 宣言ブロックの後に、空行を挿入する必要があります。 クラスの開き中括弧 ({)

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

メソッドの開き中括弧 ({) は関数宣言の後の独自の行に記述する必要があり、閉じ中括弧 (}) も関数本体の後の独自の行に記述する必要があります。

クラスのプロパティとメソッドは、アクセス修飾子(private、protected、public)、abstractとfinalを追加する必要があり、アクセス修飾子の前に宣言する必要があり、staticはアクセス修飾子の後に宣言する必要があります。

制御構造のキーワードの後に​​はスペースが必要です が、メソッドまたは関数を呼び出すときに があってはなりません 。

コントロール構造の左中括弧 ({)

は宣言と同じ行に記述する必要があり、右中括弧 (}) は本文の後の独自の行に 記述する必要があります。 制御構造の左括弧の後と右括弧の前にスペース文字があってはなりません。 1.1. 例

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

use FooInterface; use OtherVendorOtherPackageBazClass; $b = null) { if ($a === $b) {

bar();

} elseif ($a > $b) { $foo-> ;bar($arg1); } else { BazClass::bar($arg2, $arg3); }

}

Final public static function bar() {

// メソッド本体

}

}

一般ルール

2.1 基本的なコーディングガイドライン
コード  は、[PSR-1][] のすべての仕様に  準拠する必要があります。 
2.2 ドキュメント
すべての PHP ファイル  は、行終端文字として Unix LF (改行) を使用する必要があります。 
すべての PHP ファイルは  空行で終わる必要があります。 
純粋な PHP コード ファイルは最後の ?> 終了タグを省略する必要があります。 
2.3. OK
線の長さ  に厳密な制限を設けてはなりません 。 
ソフトな長さの制約は 120 文字に制限する必要があります、この長さを超える場合、コード仕様チェックを備えたエディターは警告を発行する必要がありますが、エラー プロンプトを発行してはなりません。 
各行は 80 文字を超えてはならず、80 文字を超える行は複数行にする必要があります。 
非空白行の後には余分なスペースがあってはなりません。 
空白行  を使用すると、  コードが読みやすくなり、コードを分割しやすくなります。 
各行に  複数のステートメントを含めることはできません。 
2.4. インデント
コードでは、インデントに 4 つのスペースを使用する必要があり、Tab キーを使用してはなりません。 
注: インデントにタブ キーの代わりにスペースを使用する利点は、コードの相違点の比較、パッチ適用、コードの再読み込み、およびコメントの際の混乱を回避できることです。 また、位置合わせを容易にするために、インデントにスペースを使用します。 
2.5. キーワードと True/False/Null
PHP では、[キーワード][] すべて小文字にする必要があります。 
定数 true、false、null も すべて小文字でなければなりません。 
名前空間と使用宣言

名前空間宣言の後に空行を挿入する必要があります。 
すべての使用は名前空間の後に宣言する必要があります。 
各 use ステートメントには use キーワードを 1 つだけ含める必要があります。 
 use ステートメント ブロックの宣言の後には空行が必要です。 
例: 


namespace VendorPackage;
use FooClass;use BarClass as Bar;use OtherVendorOtherPackageBazClass;// ... 追加の PHP コード ...

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


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

4.1. 拡張と継承
キーワード extends とimplements
はクラス名と同じ行に記述する必要があります。
 は、最初の行も含めて別々の行に分割する必要があります。 


namespace VendorPackage;FooClassを使用;BarClassをBarとして使用;OtherVendorOtherPackageBazClassを使用;class ClassName extends ParentClass実装 ArrayAccess、Countable、Serializable 

コードをコピー

4.2.
各プロパティにはアクセス修飾子が追加されている必要があります
。

プロパティを宣言するためにキーワード var を

使用してはなりません
。
以下はプロパティ宣言の例です: 
namespace VendorPackage;
class ClassName{
 public $foo = null;
}


メソッドをコピーします。

すべてのメソッドは
アクセス修飾子を追加する必要があります。 

メソッドが保護されているかプライベートであるかを区別するために、プレフィックスとしてアンダースコアを使用しないでください。 


 メソッド名の後に 
 スペースがあってはなりません。左中括弧 
 は単独の行になければならず、閉じ中括弧 
 はメソッド本体の後に単独の行になければなりません。パラメータの左括弧の後と右括弧の前にスペースを入れてはなりません。 

標準メソッド宣言では、括弧、カンマ、スペース、中括弧の位置に注意して、次の例を参照できます。
{
 public $foo = null;
}


メソッドをコピーします。
すべてのメソッドは
アクセス修飾子を追加する必要があります。

メソッドが保護されているかプライベートであるかを区別するために、プレフィックスとしてアンダースコアを使用しないでください。

 メソッド名の後に
 スペースがあってはなりません。左中括弧
 は単独の行になければならず、閉じ中括弧
 はメソッド本体の後に単独の行になければなりません。パラメータの左括弧の後と右括弧の前にスペースを入れてはなりません。

4.4. メソッドのパラメータ

パラメータリストでは、各カンマの後にスペースが必要であり、カンマの前にスペースがあってはなりません。 デフォルト値を持つパラメータは

パラメータリストの最後に配置する必要があります。

class ClassName
{
 public function foo($arg1, &$arg2, $arg3 = [])
 {
 // メソッド本体
 }
}


コードをコピーします

パラメータリストは複数の行に分割することができます。そのため、最初のパラメータを含む各パラメータは独自の行になければなりません

。 パラメータリストを複数の行に分割した後、メソッドの閉じ括弧と開き括弧を同じ行に記述し、中央にスペースで区切る必要があります。

namespace VendorPackage;

class ClassName
1. {
2. public function aVeryLongMethodName(
3. ClassTypeHint $arg1,
4. &$arg2,
5. array $arg3 = []
6. ) {
7. // メソッド本体
8. }
9. }
12. コードをコピー

4.5. 抽象、最終、静的

抽象宣言や最終宣言を追加する必要がある場合は、アクセス修飾子の前に記述し、その後に static

を記述する必要があります。

namespace VendorPackage;

abstract class ClassName
1. {
2. protected static $foo;
4. abstract protected function zim();
6. Final public static function bar()
7. {
8. // メソッドbody
9. }
10. }
13. コードをコピー

4.6. メソッドと関数の呼び出し

メソッドや関数を呼び出す場合、メソッド名または関数名とパラメーターの左括弧の間にスペースがあってはならず、またパラメーターの右括弧の前にスペースがあってはなりません。各パラメーターの前にスペースを入れてはなりません が、後ろにスペースを入れなければなりません

。 bar();$foo->bar($arg1);Foo::bar($arg2, $arg3);

パラメータ
 OK
このとき、最初のパラメータを含む各パラメータは

$foo->bar( $longArgument, $longerArgument, $muchLongerArgument

);

制御構造


制御構造の基本仕様は以下の通りです:

左括弧 (.

) の後には

スペースがあってはなりません

---

右括弧の前に

スペースがあってはなりません)。

右括弧 ) と開始中括弧 { の間には スペースが 1 つ必要です。

構造体の本体は 1 回インデントする必要があります。

閉じ中括弧 }

は、構造体の本体の後の別の行に配置する必要があります。 各構造の本体は

必ず中括弧のペアで囲む必要があります

これにより構造がより構造化され、新しい行を追加する際のエラーの可能性が減ります。 5.1. if、elseif、else 標準の if 構造は次のコードに示すとおりです。大括弧、スペース、中括弧の位置に注意してください。

else と elseif は両方とも前の閉じ中括弧と同じ行にあることに注意してください。

if ($expr1) { // if body

} elseif ($expr2) {

// elseif body} else { // else body;
}

Copyコード

5.2. スイッチとケース
標準的なスイッチ構造は次のコードのようになります。括弧、スペース、中括弧の位置に注意してください。
case ステートメント
は switch に対して相対的にインデントする必要がありますが、break ステートメントと case 内の他のステートメントは case に対して相対的にインデントする必要があります。
空ではない case through ステートメントがある場合は、本文に // no Break のようなコメントが必要です。

echo '最初のケース、ブレイクあり';

Break; case 1: echo '2 番目のケース、失敗する';

// ブレークなし

case 2:
case 3: case 4: echo '3 番目のケース、ブレークの代わりに return';
return;

default:

Copyコード

5.3. while と do while

 標準化された while ステートメントは次のようになります。大括弧、スペース、中括弧の位置に注意してください。 

while ($expr) {
 // 構造体
}
 標準的な do while ステートメントも同様に、括弧、スペース、およびスペースに注意してください。花の位置。 

do {
 // 構造体;
} while ($expr);5.4。

記述の基準は以下の通りです。括弧、スペース、中括弧の位置に注意してください。 

for ($i = 0; $i  // 本体
}5.5.

標準の foreach ステートメントは次のとおりです。括弧、スペース、中括弧の位置に注意してください。 

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

標準の try catch ステートメントは次のとおりです。括弧、スペース、中括弧の位置に注意してください。 

try {
 // 本体を試す
} catch (FirstExceptionType $e) {
 // 本体をキャッチ
} catch (OtherExceptionType $e) {
 // 本体を試す
}
閉鎖

クロージャを宣言する場合、キーワード関数の後とキーワード使用の前後にスペースが必要です。 
開き中括弧  は宣言と同じ行に記述する必要があり、閉じ中括弧  は本文の終わりの直後の行に  続ける必要があります。 
パラメータリストと変数リストの左括弧の後と右括弧の前にスペースがあってはなりません。 
パラメータと変数のリストでは、カンマの前にスペースを入れてはならず、コンマの後にスペースを入れなければなりません。 
クロージャ内のデフォルト値を持つパラメータは、リストの最後に配置する必要があります。 
標準的なクロージャー宣言ステートメントは次のとおりです。括弧、コンマ、スペース、中括弧の位置に注意してください。 

$closureWithArgs = function ($arg1, $arg2) { // body // body
};


コードをコピー


パラメータ リストと変数リスト は同じ行に配置する必要があります  。 
次の例には、パラメーターと変数のリストが複数の行に分割されている複数の状況が含まれています。 
$longArgs_noVars = function ( $longArgument, // body
};

$noArgs_longVars = function () use (
 $longバージョン 1 ,
 $longerVar2,
 $muchLongerVar3
) {
 // body
};

$longArgs_longVars = function (
 $longArgument,
 $longerArgument,
 $muchLongerArgument
) use (
 $longVar1,
 $longerV) ar2 、
 $ MuchLongervar3 ( $arg) use (
 $longVar1,
 $longerVar2,
 $muchLongerVar3
) {
 // body
};


コードをコピー


クロージャが関数またはメソッド呼び出しのパラメータとして直接使用される場合、上記のルールは引き続き適用されます。





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