基本代碼規(guī)范
本篇規(guī)范制定了代碼基本元素的相關(guān)標(biāo)準(zhǔn)，
以確保共享的PHP代碼間具有較高程度的技術(shù)互通性雀哨。
關(guān)鍵詞 “必須”("MUST")艇拍、“一定不可/一定不能”("MUST NOT")、“需要”("REQUIRED")骏掀、
“將會”("SHALL")鸠澈、“不會”("SHALL NOT")、“應(yīng)該”("SHOULD")截驮、“不該”("SHOULD NOT")笑陈、
“推薦”("RECOMMENDED")、“可以”("MAY")和”可選“("OPTIONAL")的詳細(xì)描述可參見 RFC 2119 侧纯。
1. 概覽
PHP代碼文件必須以
<?php或<?=標(biāo)簽開始新锈；PHP代碼文件必須以
不帶BOM的 UTF-8編碼；PHP代碼中應(yīng)該只定義類眶熬、函數(shù)妹笆、常量等聲明，或其他會產(chǎn)生
從屬效應(yīng)的操作（如：生成文件輸出以及修改.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. 從屬效應(yīng)（副作用）
一份PHP文件中應(yīng)該要不就只定義新的聲明徙菠，如類讯沈、函數(shù)或常量等不產(chǎn)生從屬效應(yīng)的操作，要不就只有會產(chǎn)生從屬效應(yīng)的邏輯操作婿奔，但不該同時具有兩者缺狠。
“從屬效應(yīng)”(side effects)一詞的意思是，僅僅通過包含文件萍摊，不直接聲明類挤茄、
函數(shù)和常量等，而執(zhí)行的邏輯操作冰木。
“從屬效應(yīng)”包含卻不僅限于：生成輸出穷劈、直接的 require 或 include、連接外部服務(wù)片酝、修改 ini 配置囚衔、拋出錯誤或異常、修改全局或靜態(tài)變量雕沿、讀或?qū)懳募取?/p>
以下是一個錯誤的例子练湿，一份包含聲明以及產(chǎn)生從屬效應(yīng)的代碼：
<?php
// 從屬效應(yīng)：修改 ini 配置
ini_set('error_reporting', E_ALL);
// 從屬效應(yīng)：引入文件
include "file.php";
// 從屬效應(yīng)：生成輸出
echo "<html>\n";
// 聲明函數(shù)
function foo()
{
// 函數(shù)主體部分
}
下面是一個范例，一份只包含聲明不產(chǎn)生從屬效應(yīng)的代碼：
<?php
// 聲明函數(shù)
function foo()
{
// 函數(shù)主體部分
}
// 條件聲明**不**屬于從屬效應(yīng)
if (! function_exists('bar')) {
function bar()
{
// 函數(shù)主體部分
}
}
3. 命名空間和類
命名空間以及類的命名必須遵循 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
{
}
4. 類的常量、屬性和方法
此處的“類”指代所有的類吊圾、接口以及可復(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ī)范不做強(qiáng)制要求，但無論遵循哪種命名方式檀何，都應(yīng)該在一定的范圍內(nèi)保持一致蝇裤。這個范圍可以是整個團(tuán)隊廷支、整個包、整個類或整個方法栓辜。
4.3. 方法
方法名稱必須符合 camelCase() 式的小寫開頭駝峰命名規(guī)范恋拍。
