PSR-1 基础编码规范

时间 2019-11-20

原文原文链接

本篇规范制定了代码基本元素的相关标准，以确保共享的PHP代码间具备较高程度的技术互通性。php

关键词 “必须”("MUST")、“必定不可/必定不能”("MUST NOT")、“须要”("REQUIRED")、 “将会”("SHALL")、“不会”("SHALL NOT")、“应该”("SHOULD")、“不应”("SHOULD NOT")、 “推荐”("RECOMMENDED")、“能够”("MAY")和”可选“("OPTIONAL")的详细描述可参见 RFC 2119 。html

概览

PHP代码文件必须以 <?php 或 <?= 标签开始；git
PHP代码文件必须以 不带BOM的 UTF-8 编码；github
PHP代码中应该只定义类、函数、常量等声明，或其余会产生 从属效应 的操做（如：生成文件输出以及修改.ini配置文件等），两者只能选其一；ide
命名空间以及类必须符合 PSR 的自动加载规范：PSR-4；函数
类的命名必须遵循 StudlyCaps 大写开头的驼峰命名规范；ui
类中的常量全部字母都必须大写，单词间用下划线分隔；编码
方法名称必须符合 camelCase 式的小写开头驼峰命名规范。spa

文件

2.1. PHP标签

PHP代码必须使用 <?php ?> 长标签或 <?= ?> 短输出标签；必定不可以使用其它自定义标签。code

2.2. 字符编码

PHP代码必须且只可以使用不带BOM的UTF-8编码。

2.3. 从属效应（反作用）

一份PHP文件中应该要不就只定义新的声明，如类、函数或常量等不产生从属效应的操做，要不就只有会产生从属效应的逻辑操做，但不应同时具备二者。

“从属效应”(side effects)一词的意思是，仅仅经过包含文件，不直接声明类、函数和常量等，而执行的逻辑操做。

“从属效应”包含却不只限于：生成输出、直接的 require 或 include、链接外部服务、修改 ini 配置、抛出错误或异常、修改全局或静态变量、读或写文件等。

如下是一个错误的例子，一份包含声明以及产生从属效应的代码：

 
  <?php // 从属效应：修改 ini 配置
ini_set('error_reporting', E_ALL); // 从属效应：引入文件
include "file.php"; // 从属效应：生成输出
echo "<html>\n"; // 声明函数
function foo() { // 函数主体部分
} 
 

下面是一个范例，一份只包含声明不产生从属效应的代码：

 
  <?php // 声明函数
function foo() { // 函数主体部分
} // 条件声明**不**属于从属效应
if (! function_exists('bar')) { function bar() { // 函数主体部分
 } } 
 

命名空间和类

命名空间以及类的命名必须遵循 PSR-4。

根据规范，每一个类都独立为一个文件，且命名空间至少有一个层次：顶级的组织名称（vendor name）。

类的命名必须遵循 StudlyCaps 大写开头的驼峰命名规范。

PHP 5.3及之后版本的代码必须使用正式的命名空间。

例如：

 
  <?php // PHP 5.3及之后版本的写法
namespace Vendor\Model; class Foo { }

5.2.x及以前的版本应该使用伪命名空间的写法，约定俗成使用顶级的组织名称（vendor name）如 Vendor_ 为类前缀。

 
  <?php // 5.2.x及以前版本的写法
class Vendor_Model_Foo { }

类的常量、属性和方法

此处的“类”指代全部的类、接口以及可复用代码块（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)，本规范不作强制要求，但不管遵循哪一种命名方式，都应该在必定的范围内保持一致。这个范围能够是整个团队、整个包、整个类或整个方法。

4.3. 方法

方法名称必须符合 camelCase() 式的小写开头驼峰命名规范。