PHP编码规范(PSR-1)-基本代码规范

时间 2019-11-17

标签 php 编码规范 psr 基本代码栏目 PHP 繁體版

原文原文链接

PSR-1 基本代码规范

1. 概况

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

2. 文件

2.1 PHP 标签

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

2.2 字符编码

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

2.3 从属效应（反作用）

一份PHP文件中应该要不就只定义新的声明，如类、函数或常量等不产生从属效应的操做，要不就只有会产生从属效应的逻辑操做，但不应同时具备二者。 "从属效应"(side effects)一词的意思是，仅仅经过包含文件，不直接声明类，函数和常量等，而执行的逻辑操做。 "从属效应"包含却不只限于:生成输出,直接的 require 或 include,链接外部服务,修改 ini 配置、抛出错误或异常、修改全局或静态变量、读或写文件等。如下是一个错误的例子，一份包含声明以及产生从属效应的代码:segmentfault

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

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

<?php
// declaration
function foo()
{
    // function body
}
// conditional declaration is *not* a side effect
if (! function_exists('bar')) {
    function bar()
    {
        // function body
    }
}

3. 命名空间和类

命名空间以及类的命名必须遵循 PSR-4。根据规范，每一个类都独立为一个文件，且命名空间至少有一个层次：顶级的组织名称（vendor name）。类的命名必须遵循 StudlyCaps 大写开头的驼峰命名规范。 PHP 5.3及之后版本的代码必须使用正式的命名空间。例如:函数

<?php
// PHP 5.3 and later:
namespace Vendor\Model;
class Foo
{
}

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

<?php
// PHP 5.2.x and earlier:
class Vendor_Model_Foo
{
}

4. 类的常量、属性和方法

此处的“类”指代全部的类、接口以及可复用代码块（traits）编码

4.1 常量

类的常量中全部字母都必须大写，词间如下划线分隔。参照如下代码：spa

<?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() 式的小写开头驼峰命名规范。code