這是給小組制定的php編碼規范
該 PHP 編碼規范基本上是同 PSR 規范的。有一部分的編碼規范 PSR 中是建議，此編碼規范會強制要求。
此編碼規范 是以 PSR-1 / PSR-2 / PSR-2擴展 為藍本，並增加了相應的細節說明。
通則
基本編碼
- PHP代碼必須使用
<?php ?>長標簽 或<?= ?>短輸出標簽；一定不可使用其它自定義標簽。 - PHP代碼必須且只可使用
不帶BOM的UTF-8編碼 - 一份PHP文件中應該要不就只定義新的聲明，如類、函數或常量等不產生從屬效應的操作，要不就只有會產生從屬效應的邏輯操作，但不該同時具有兩者
“從屬效應”(side effects)一詞的意思是，僅僅通過包含文件，不直接聲明類、
函數和常量等，而執行的邏輯操作。
“從屬效應”包含卻不僅限於：生成輸出、直接的require或include、連接外部服務、修改 ini 配置、拋出錯誤或異常、修改全局或靜態變量、讀或寫文件等。
以下是一個錯誤的例子，一份包含聲明以及產生從屬效應的代碼：
<?php
// 從屬效應：修改 ini 配置
ini_set('error_reporting', E_ALL);
// 從屬效應：引入文件
include "file.php";
// 從屬效應：生成輸出
echo "<html>\n";
// 聲明函數
function foo()
{
// 函數主體部分
}
下面是一個范例，一份只包含聲明不產生從屬效應的代碼：
<?php
// 聲明函數
function foo()
{
// 函數主體部分
}
// 條件聲明**不**屬於從屬效應
if (! function_exists('bar')) {
function bar()
{
// 函數主體部分
}
}
文件
所有PHP文件必須使用Unix LF (linefeed)作為行的結束符。
所有PHP文件必須以一個空白行作為結束。
純PHP代碼文件必須省略最后的 ?> 結束標簽。
行
行的長度一定不能有硬性的約束。
軟性的長度約束限制在120個字符以內
每行不應該多於80個字符，大於80字符的行應該折成多行。
非空行后一定不能有多余的空格符。
空行可以使得閱讀代碼更加方便以及有助於代碼的分塊。
每行一定不能存在多於一條語句。
縮進
代碼必須使用4個空格符的縮進，一定不能用 tab鍵 。
備注: 使用空格而不是tab鍵縮進的好處在於，
避免在比較代碼差異、打補丁、重閱代碼以及注釋時產生混淆。
並且，使用空格縮進，讓對齊變得更方便。
關鍵字 以及 True/False/Null
PHP所有 關鍵字必須全部小寫。
常量 true 、false 和 null 也必須全部小寫。
namespace 以及 use 聲明
namespace
namespace 聲明后 必須 插入一個空白行。
所有 use 必須 在 namespace 后聲明。
每條 use 聲明語句 必須 只有一個 use 關鍵詞。
use
use 聲明語句塊后 必須 要有一個空白行。
例如：
<?php
namespace Vendor\Package;
use FooClass;
use BarClass as Bar;
use OtherVendor\OtherPackage\BazClass;
// ... additional PHP code ...
類、屬性和方法
此處的“類”泛指所有的class類、接口以及traits可復用代碼塊。
類名規則
一個完整的類名需具有以下結構:
\<命名空間>(\<子命名空間>)*\<類名>
1. 完整的類名必須要有一個頂級命名空間，被稱為 "vendor namespace"；
2. 完整的類名可以有一個或多個子命名空間；
3. 完整的類名必須有一個最終的類名；
4. 完整的類名中任意一部分中的下划線都是沒有特殊含義的；
5. 完整的類名可以由任意大小寫字母組成；
6. 所有類名都必須是大小寫敏感的。
7. 類的命名必須 遵循 StudlyCaps 大寫開頭的駝峰命名規范。
類名自動加載規則
當根據完整的類名載入相應的文件
1. 完整的類名中，去掉最前面的命名空間分隔符，前面連續的一個或多個命名空間和子命名空間，作為“命名空間前綴”，其必須與至少一個“文件基目錄”相對應；
2. 緊接命名空間前綴后的子命名空間必須與相應的”文件基目錄“相匹配，其中的命名空間分隔符將作為目錄分隔符。
3. 末尾的類名必須與對應的以 `.php` 為后綴的文件同名。
4. 自動加載器（autoloader）的實現一定不能拋出異常、一定不能觸發任一級別的錯誤信息以及不應該有返回值。
擴展與繼承
關鍵詞 extends 和 implements必須寫在類名稱的同一行。
類的開始花括號必須獨占一行，結束花括號也必須在類主體后獨占一行。
<?php
namespace Vendor\Package;
use FooClass;
use BarClass as Bar;
use OtherVendor\OtherPackage\BazClass;
class ClassName extends ParentClass implements \ArrayAccess, \Countable
{
// constants, properties, methods
}
implements 的繼承列表也可以分成多行，這樣的話，每個繼承接口名稱都必須分開獨立成行，包括第一個。
當需要擴展多個接口時，extends 的相關規范與 4.1 節中 implements 的規范一致。
<?php
namespace Vendor\Package;
use FooClass;
use BarClass as Bar;
use OtherVendor\OtherPackage\BazClass;
class ClassName extends ParentClass implements
\ArrayAccess,
\Countable,
\Serializable
{
// constants, properties, methods
}
屬性
每個屬性都必須添加訪問修飾符。
一定不可使用關鍵字 var 聲明一個屬性。
每條語句一定不可定義超過一個屬性。
不要使用下划線作為前綴，來區分屬性是 protected 或 private。
以下是屬性聲明的一個范例：
<?php
namespace Vendor\Package;
class ClassName
{
public $foo = null;
}
方法
所有方法都必須添加訪問修飾符。
不要使用下划線作為前綴，來區分方法是 protected 或 private。
方法名稱后一定不能有空格符，其開始花括號必須獨占一行，結束花括號也必須在方法主體后單獨成一行。參數左括號后和右括號前一定不能有空格。
一個標准的方法聲明可參照以下范例，留意其括號、逗號、空格以及花括號的位置。
<?php
namespace Vendor\Package;
class ClassName
{
public function fooBarBaz($arg1, &$arg2, $arg3 = [])
{
// method body
}
}
方法的參數
參數列表中，每個逗號后面必須要有一個空格，而逗號前面一定不能有空格。
有默認值的參數，必須放到參數列表的末尾。
<?php
namespace Vendor\Package;
class ClassName
{
public function foo($arg1, &$arg2, $arg3 = [])
{
// method body
}
}
abstract 、 final 、 以及 static
需要添加 abstract 或 final 聲明時， 必須寫在訪問修飾符前，而 static 則必須寫在其后。
<?php
namespace Vendor\Package;
abstract class ClassName
{
protected static $foo;
abstract protected function zim();
final public static function bar()
{
// method body
}
}
方法及函數調用
方法及函數調用時，方法名或函數名與參數左括號之間一定不能有空格，參數右括號前也 一定不能有空格。每個逗號前一定不能有空格，但其后必須有一個空格。
<?php
bar();
$foo->bar($arg1);
Foo::bar($arg2, $arg3);
參數可以分列成多行，此時包括第一個參數在內的每個參數都必須單獨成行。
<?php
$foo->bar(
$longArgument,
$longerArgument,
$muchLongerArgument
);
在參數表中的數組和匿名函數是可以單獨分列成多行的。
以下的例子是符合規范的：
<?php
somefunction($foo, $bar, [
// ...
], $baz);
$app->get('/hello/{name}', function ($name) use ($app) {
return 'Hello '.$app->escape($name);
});
控制結構
控制結構的基本規范如下：
- 控制結構關鍵詞后必須有一個空格。
- 左括號
(后一定不能有空格。 - 右括號
)前也一定不能有空格。 - 右括號
)與開始花括號{間一定有一個空格。 - 結構體主體一定要有一次縮進。
- 結束花括號
}一定在結構體主體后單獨成行。
每個結構體的主體都必須被包含在成對的花括號之中，
這能讓結構體更加結構話，以及減少加入新行時，出錯的可能性。
if 、 elseif 和 else
標准的 if 結構如下代碼所示，留意 括號、空格以及花括號的位置，
注意 else 和 elseif 都與前面的結束花括號在同一行。
<?php
if ($expr1) {
// if body
} elseif ($expr2) {
// elseif body
} else {
// else body;
}
應該使用關鍵詞 elseif 代替所有 else if ，以使得所有的控制關鍵字都像是單獨的一個詞。
switch 和 case
標准的 switch 結構如下代碼所示，留意括號、空格以及花括號的位置。
case 語句必須相對 switch 進行一次縮進，而 break 語句以及 case 內的其它語句都 必須 相對 case 進行一次縮進。
如果存在非空的 case 直穿語句，主體里必須有類似 // no break 的注釋。
<?php
switch ($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;
}
while 和 do while
一個規范的 while 語句應該如下所示，注意其 括號、空格以及花括號的位置。
<?php
while ($expr) {
// structure body
}
標准的 do while 語句如下所示，同樣的，注意其 括號、空格以及花括號的位置。
<?php
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
}
閉包
閉包聲明時，關鍵詞 function 后以及關鍵詞 use 的前后都必須要有一個空格。
開始花括號必須寫在聲明的同一行，結束花括號必須緊跟主體結束的下一行。
參數列表和變量列表的左括號后以及右括號前，必須不能有空格。
參數和變量列表中，逗號前必須不能有空格，而逗號后必須要有空格。
閉包中有默認值的參數必須放到列表的后面。
標准的閉包聲明語句如下所示，注意其 括號、逗號、空格以及花括號的位置。
<?php
$closureWithArgs = function ($arg1, $arg2) {
// body
};
$closureWithArgsAndVars = function ($arg1, $arg2) use ($var1, $var2) {
// body
};
例子
以下例子程序簡單地展示了以上大部分規范：
<?php
namespace 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
}
}