PHP之PSR規範

PSR 是 PHP Standard Recommendations 的簡寫,由 PHP FIG 組織制定的 PHP 規範,是 PHP 開發的實踐標準。

PSR-1 基礎編碼規範
PHP代碼文件 必須 以 <?php 或 <?= 標籤開始;
PHP代碼文件 必須 以 不帶 BOM 的 UTF-8 編碼;
PHP代碼中 應該 只定義類、函數、常量等聲明,或其他會產生 副作用 的操作(如:生成文件輸出以及修改 .ini 配置文件等),二者只能選其一;
命名空間以及類 必須 符合 PSR 的自動加載規範:PSR-4 中的一個;
類的命名 必須 遵循 StudlyCaps 大寫開頭的駝峯命名規範;
類中的常量所有字母都 必須 大寫,單詞間用下劃線分隔;
方法名稱 必須 符合 camelCase 式的小寫開頭駝峯命名規範。
PSR-2 編碼風格規範
代碼 必須 使用4個空格符而不是「Tab 鍵」進行縮進。
每行的字符數 應該 軟性保持在 80 個之內,理論上 一定不可 多於 120 個,但 一定不可 有硬性限制。
每個 namespace 命名空間聲明語句和 use 聲明語句塊後面,必須 插入一個空白行。
類的開始花括號({) 必須 寫在函數聲明後自成一行,結束花括號(})也 必須 寫在函數主體後自成一行。
方法的開始花括號({) 必須 寫在函數聲明後自成一行,結束花括號(})也 必須 寫在函數主體後自成一行。
類的屬性和方法 必須 添加訪問修飾符(private、protected 以及 public),abstract 以及 final 必須 聲明在訪問修飾符之前,而 static 必須 聲明在訪問修飾符之後。
控制結構的關鍵字後 必須 要有一個空格符,而調用方法或函數時則 一定不可 有。
控制結構的開始花括號({) 必須 寫在聲明的同一行,而結束花括號(}) 必須 寫在主體後自成一行。
控制結構的開始左括號後和結束右括號前,都 一定不可 有空格符。
PSR-3 日誌接口規範
LoggerInterface 接口對外定義了八個方法,分別用來記錄 RFC 5424 中定義的八個等級的日誌:debug、 info、 notice、 warning、 error、 critical、 alert 以及 emergency 。
第九個方法 —— log,其第一個參數爲記錄的等級。可使用一個預先定義的等級常量作爲參數來調用此方法,必須 與直接調用以上八個方法具有相同的效果。如果傳入的等級常量參數沒有預先定義,則 必須 拋出 Psr\Log\InvalidArgumentException 類型的異常。在不確定的情況下,使用者 不該 使用未支持的等級常量來調用此方法。

PSR-4 自動加載規範
PSR-6 緩存接口規範
PSR-7 HTTP 消息接口規範

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章