基本代碼規(guī)范
本篇規(guī)范制定了代碼基本元素的相關(guān)標(biāo)準(zhǔn)， 以確保共享的PHP代碼間具有較高程度的技術(shù)互通性指厌。
關(guān)鍵詞 “必須”("MUST")、“一定不可/一定不能”("MUST NOT")踊跟、“需要”("REQUIRED")踩验、“將會(huì)”("SHALL")、“不會(huì)”("SHALL NOT")商玫、“應(yīng)該”("SHOULD")晰甚、“不該”("SHOULD NOT")、“推薦”("RECOMMENDED")决帖、“可以”("MAY")和”可選“("OPTIONAL")的詳細(xì)描述可參見(jiàn) RFC 2119 厕九。
1. 概覽
PHP代碼文件必須以
<?php或<?=標(biāo)簽開(kāi)始；PHP代碼文件必須以 不帶BOM的 UTF-8 編碼地回；
PHP代碼中應(yīng)該只定義類(lèi)扁远、函數(shù)、常量等聲明刻像，或其他會(huì)產(chǎn)生 從屬效應(yīng)的操作（如：生成文件輸出以及修改.ini配置文件等）畅买，二者只能選其一；
命名空間以及類(lèi)必須符合 PSR 的自動(dòng)加載規(guī)范：PSR-0 或 PSR-4 中的一個(gè)细睡；
類(lèi)的命名必須遵循 StudlyCaps 大寫(xiě)開(kāi)頭的駝峰命名規(guī)范谷羞；
類(lèi)中的常量所有字母都必須大寫(xiě)，單詞間用下劃線分隔溜徙；
方法名稱(chēng)必須符合 camelCase 式的小寫(xiě)開(kāi)頭駝峰命名規(guī)范湃缎。
2. 文件
- PHP標(biāo)簽
PHP代碼必須使用<?php ?>長(zhǎng)標(biāo)簽 或<?= ?>短輸出標(biāo)簽；一定不可使用其它自定義標(biāo)簽蠢壹。 - 字符編碼
PHP代碼必須且只可使用不帶BOM的UTF-8 編碼嗓违。 - 從屬效應(yīng)（副作用）
一份PHP文件中應(yīng)該要不就只定義新的聲明，如類(lèi)图贸、函數(shù)或常量等不產(chǎn)生從屬效應(yīng)的操作蹂季，要不就只有會(huì)產(chǎn)生從屬效應(yīng)的邏輯操作，但不該同時(shí)具有兩者疏日。
“從屬效應(yīng)”(side effects)一詞的意思是偿洁，僅僅通過(guò)包含文件，不直接聲明類(lèi)沟优、 函數(shù)和常量等涕滋，而執(zhí)行的邏輯操作。
“從屬效應(yīng)”包含卻不僅限于：生成輸出净神、直接的 require 或 include何吝、連接外部服務(wù)溉委、修改 ini 配置、拋出錯(cuò)誤或異常爱榕、修改全局或靜態(tài)變量瓣喊、讀或?qū)懳募取?br> 以下是一個(gè)反例，一份包含聲明以及產(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ù)主體部分}
下面是一個(gè)范例黔酥，一份只包含聲明不產(chǎn)生從屬效應(yīng)的代碼：
<?php
// 聲明函數(shù)
function foo(){ // 函數(shù)主體部分}
// 條件聲明**不**屬于從屬效應(yīng)
if (! function_exists('bar')) { function bar() { // 函數(shù)主體部分 }}
3. 命名空間和類(lèi)
命名空間以及類(lèi)的命名必須遵循 PSR-0.
根據(jù)規(guī)范藻三，每個(gè)類(lèi)都獨(dú)立為一個(gè)文件，且命名空間至少有一個(gè)層次：頂級(jí)的組織名稱(chēng)（vendor name）跪者。
類(lèi)的命名必須 遵循 StudlyCaps
大寫(xiě)開(kāi)頭的駝峰命名規(guī)范棵帽。
PHP 5.3及以后版本的代碼必須使用正式的命名空間。
例如：
<?php
// PHP 5.3及以后版本的寫(xiě)法
namespace Vendor\Model;
class Foo{}
5.2.x及之前的版本應(yīng)該使用偽命名空間的寫(xiě)法渣玲，約定俗成使用頂級(jí)的組織名稱(chēng)（vendor name）如 Vendor_
為類(lèi)前綴逗概。
<?php
// 5.2.x及之前版本的寫(xiě)法
class Vendor_Model_Foo{}
4. 類(lèi)的常量、屬性和方法
此處的“類(lèi)”指代所有的類(lèi)忘衍、接口以及可復(fù)用代碼塊（traits）
- 常量
類(lèi)的常量中所有字母都必須大寫(xiě)逾苫，詞間以下劃線分隔。參照以下代碼：
<?php
namespace Vendor\Model;
class Foo{
const VERSION = '1.0';
const DATE_APPROVED = '2012-06-01';
}
- 屬性
類(lèi)的屬性命名可以遵循 大寫(xiě)開(kāi)頭的駝峰式 ($StudlyCaps)枚钓、小寫(xiě)開(kāi)頭的駝峰式 ($camelCase) 又或者是 下劃線分隔式 ($under_score)铅搓，本規(guī)范不做強(qiáng)制要求，但無(wú)論遵循哪種命名方式搀捷，都應(yīng)該在一定的范圍內(nèi)保持一致星掰。這個(gè)范圍可以是整個(gè)團(tuán)隊(duì)、整個(gè)包嫩舟、整個(gè)類(lèi)或整個(gè)方法氢烘。 - 方法
方法名稱(chēng)必須符合 camelCase() 式的小寫(xiě)開(kāi)頭駝峰命名規(guī)范。
