PHP編碼規(guī)范:PSR-1 基礎(chǔ)編碼規(guī)范

所有 PSR 規(guī)范請見:https://psr.phphub.org/

基本代碼規(guī)范

本篇規(guī)范制定了代碼基本元素的相關(guān)標(biāo)準(zhǔn)烂琴,以確保共享的PHP代碼間具有較高程度的技術(shù)互通性。

關(guān)于「能愿動詞」的使用


為了避免歧義,文檔大量使用了「能愿動詞」盹廷,對應(yīng)的解釋如下:

  • 必須 (MUST):絕對狗准,嚴(yán)格遵循,請照做赖晶,無條件遵守土居;
  • 一定不可 (MUST NOT):禁令,嚴(yán)令禁止嬉探;
  • 應(yīng)該 (SHOULD) :強(qiáng)烈建議這樣做擦耀,但是不強(qiáng)求;
  • 不該 (SHOULD NOT):強(qiáng)烈不建議這樣做涩堤,但是不強(qiáng)求眷蜓;
  • 可以 (MAY) 和 可選 (OPTIONAL) :選擇性高一點(diǎn),在這個文檔內(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ù)主體部分
    }
}

3. 命名空間和類


命名空間以及類的命名必須遵循 PSR-4变丧。
根據(jù)規(guī)范,每個類都獨(dú)立為一個文件绢掰,且命名空間至少有一個層次:頂級的組織名稱(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)隊(duì)、整個包渔期、整個類或整個方法运吓。

4.3. 方法

方法名稱 必須 符合 camelCase() 式的小寫開頭駝峰命名規(guī)范。

轉(zhuǎn)載自 「PSR 規(guī)范」PSR-1 基礎(chǔ)編碼規(guī)范

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市羽德,隨后出現(xiàn)的幾起案子几莽,更是在濱河造成了極大的恐慌迅办,老刑警劉巖宅静,帶你破解...
    沈念sama閱讀 218,122評論 6 505
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異站欺,居然都是意外死亡姨夹,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,070評論 3 395
  • 文/潘曉璐 我一進(jìn)店門矾策,熙熙樓的掌柜王于貴愁眉苦臉地迎上來磷账,“玉大人,你說我怎么就攤上這事贾虽√釉悖” “怎么了?”我有些...
    開封第一講書人閱讀 164,491評論 0 354
  • 文/不壞的土叔 我叫張陵蓬豁,是天一觀的道長绰咽。 經(jīng)常有香客問我,道長地粪,這世上最難降的妖魔是什么取募? 我笑而不...
    開封第一講書人閱讀 58,636評論 1 293
  • 正文 為了忘掉前任,我火速辦了婚禮蟆技,結(jié)果婚禮上玩敏,老公的妹妹穿的比我還像新娘。我一直安慰自己质礼,他們只是感情好旺聚,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,676評論 6 392
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著眶蕉,像睡著了一般砰粹。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上妻坝,一...
    開封第一講書人閱讀 51,541評論 1 305
  • 那天伸眶,我揣著相機(jī)與錄音,去河邊找鬼刽宪。 笑死厘贼,一個胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的圣拄。 我是一名探鬼主播嘴秸,決...
    沈念sama閱讀 40,292評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了岳掐?” 一聲冷哼從身側(cè)響起凭疮,我...
    開封第一講書人閱讀 39,211評論 0 276
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎串述,沒想到半個月后执解,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,655評論 1 314
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡纲酗,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,846評論 3 336
  • 正文 我和宋清朗相戀三年衰腌,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片觅赊。...
    茶點(diǎn)故事閱讀 39,965評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡右蕊,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出吮螺,到底是詐尸還是另有隱情饶囚,我是刑警寧澤,帶...
    沈念sama閱讀 35,684評論 5 347
  • 正文 年R本政府宣布鸠补,位于F島的核電站萝风,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏莫鸭。R本人自食惡果不足惜闹丐,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,295評論 3 329
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望被因。 院中可真熱鬧卿拴,春花似錦、人聲如沸梨与。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,894評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽粥鞋。三九已至缘挽,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間呻粹,已是汗流浹背壕曼。 一陣腳步聲響...
    開封第一講書人閱讀 33,012評論 1 269
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留等浊,地道東北人腮郊。 一個月前我還...
    沈念sama閱讀 48,126評論 3 370
  • 正文 我出身青樓,卻偏偏與公主長得像筹燕,于是被迫代替她去往敵國和親轧飞。 傳聞我的和親對象是個殘疾皇子衅鹿,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,914評論 2 355