基本代碼規(guī)范
本篇規(guī)范制定了代碼基本元素的相關(guān)標(biāo)準(zhǔn)，以確保共享的PHP代碼間具有較高程度的技術(shù)互通性。
關(guān)于「能愿動詞」的使用
為了避免歧義，文檔大量使用了「能愿動詞」，對應(yīng)的解釋如下：
-
必須 (MUST)：絕對，嚴(yán)格遵循，請照做，無條件遵守； -
一定不可 (MUST NOT)：禁令，嚴(yán)令禁止； -
應(yīng)該 (SHOULD)：強烈建議這樣做，但是不強求； -
不該 (SHOULD NOT)：強烈不建議這樣做，但是不強求； -
可以 (MAY)和可選 (OPTIONAL)：選擇性高一點，在這個文檔內(nèi)，此詞語使用較少；
參見：RFC 2119
1. 概覽
PHP代碼文件 必須 以
<?php或<?=標(biāo)簽開始；PHP代碼文件 必須 以
不帶 BOM 的 UTF-8編碼；PHP代碼中 應(yīng)該 只定義類、函數(shù)、常量等聲明，或其他會產(chǎn)生
副作用的操作（如：生成文件輸出以及修改 .ini 配置文件等），二者只能選其一；命名空間以及類 必須 符合 PSR 的自動加載規(guī)范：PSR-4 中的一個；
類的命名 必須 遵循
StudlyCaps大寫開頭的駝峰命名規(guī)范；類中的常量所有字母都 必須 大寫，單詞間用下劃線分隔；
方法名稱 必須 符合
camelCase式的小寫開頭駝峰命名規(guī)范。
2. 文件
2.1. PHP標(biāo)簽
PHP代碼 必須 使用 <?php ?> 長標(biāo)簽 或 <?= ?> 短輸出標(biāo)簽；
一定不可 使用其它自定義標(biāo)簽。
2.2. 字符編碼
PHP代碼 必須 且只可使用 不帶BOM的UTF-8 編碼。
2.3. 副作用
一份 PHP 文件中 應(yīng)該 要不就只定義新的聲明，如類、函數(shù)或常量等不產(chǎn)生 副作用 的操作，要不就只書寫會產(chǎn)生 副作用 的邏輯操作，但 不該 同時具有兩者。
「副作用」(side effects) 一詞的意思是，僅僅通過包含文件，不直接聲明類、函數(shù)和常量等，而執(zhí)行的邏輯操作。
「副作用」包含卻不僅限于：
- 生成輸出
- 直接的
require或include - 連接外部服務(wù)
- 修改 ini 配置
- 拋出錯誤或異常
- 修改全局或靜態(tài)變量
- 讀或?qū)懳募?/li>
以下是一個 反例，一份包含「函數(shù)聲明」以及產(chǎn)生「副作用」的代碼：
<?php
// 「副作用」：修改 ini 配置
ini_set('error_reporting', E_ALL);
// 「副作用」：引入文件
include "file.php";
// 「副作用」：生成輸出
echo "<html>\n";
// 聲明函數(shù)
function foo()
{
// 函數(shù)主體部分
}
下面是一個范例，一份只包含聲明不產(chǎn)生「副作用」的代碼：
<?php
// 聲明函數(shù)
function foo()
{
// 函數(shù)主體部分
}
// 條件聲明 **不** 屬于「副作用」
if (! function_exists('bar')) {
function bar()
{
// 函數(shù)主體部分
}
}
- 命名空間和類
命名空間以及類的命名必須遵循 PSR-4。
根據(jù)規(guī)范，每個類都獨立為一個文件，且命名空間至少有一個層次：頂級的組織名稱（vendor name）。
類的命名 必須 遵循 StudlyCaps 大寫開頭的駝峰命名規(guī)范。
PHP 5.3 及以后版本的代碼 必須 使用正式的命名空間。
例如：
<?php
// PHP 5.3及以后版本的寫法
namespace Vendor\Model;
class Foo
{
}
5.2.x 及之前的版本 應(yīng)該 使用偽命名空間的寫法，約定俗成使用頂級的組織名稱（vendor name）如 Vendor_ 為類前綴。
<?php
// 5.2.x及之前版本的寫法
class Vendor_Model_Foo
{
}
- 類的常量、屬性和方法
此處的「類」指代所有的類、接口以及可復(fù)用代碼塊（traits）。
4.1. 常量
類的常量中所有字母都 必須 大寫，詞間以下劃線分隔。
參照以下代碼：
<?php
namespace Vendor\Model;
class Foo
{
const VERSION = '1.0';
const DATE_APPROVED = '2012-06-01';
}
4.2. 屬性
類的屬性命名 可以 遵循：
- 大寫開頭的駝峰式 (
$StudlyCaps) - 小寫開頭的駝峰式 (
$camelCase) - 下劃線分隔式 (
$under_score)
本規(guī)范不做強制要求，但無論遵循哪種命名方式，都 應(yīng)該 在一定的范圍內(nèi)保持一致。這個范圍可以是整個團隊、整個包、整個類或整個方法。
4.3. 方法
方法名稱 必須 符合 camelCase() 式的小寫開頭駝峰命名規(guī)范。
