舒孝元博客

[TOC]

# PSR-1 基础编码规范（节选）

## 1. 概述

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

- 类中的常量字母都 `必须` 大写，单词间用下划线分隔；

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

## 3. 命名空间和类名

- 命名空间和类名 `必须` 遵循 【自动加载】 规范

## 4. 类的常量、属性和方法
此处的「类」指代所有的类、接口以及可复用代码块（traits）。

- 类的常量所有字母必须大写，单词间以下划线分隔，例如：

```
<?php
namespace Vendor\Model;

class Foo
{
    const VERSION = '1.0';
    const DATE_APPROVED = '2012-06-01';
}
```

- 类的属性可以有以下几种
1.大写开头的驼峰式 ( `$StudlyCaps` )
2.小写开头的驼峰式 ( `$camelCase` )
3.下划线分隔式 ( `$under_score` )

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

# PSR-2 编码风格规范（节选）
## 1. 概述
- 代码 `必须` 使用 4 个空格而不是【tab键】进行缩进

- 每行的字符数 `应该` 软性保持在 80 个之内，理论上 `一定不可` 多于 120 个，但 `一定不可` 有硬性限制。

- 每个 `namespace` 命名空间声明语句和 `use` 声明语句块后面，`必须` 插入一个空白行。

- 类和方法的花括号 `必须` 另起一行

- 类的属性和方法 `必须` 添加访问修饰符（`private`、`protected` 以及 `public`），`abstract` 以及 `final` 必须 声明在访问修饰符之前，而 `static` 必须 声明在访问修饰符之后。

- 控制结构的关键字后 `必须` 要有一个空格符，而调用方法或函数时则 `一定不可` 有。

```
<?php
namespace Vendor\Package;

use FooInterface;
use BarClass as Bar;
use OtherVendor\OtherPackage\BazClass;

class Foo extends Bar implements FooInterface
{
    public function sampleMethod($a, $b = null)
    {
        if ($a === $b) {
            bar();
        } elseif ($a > $b) {
            $foo->bar($arg1);
        } else {
            BazClass::bar($arg2, $arg3);
        }
    }

final public static function bar()
    {
        // 方法体
    }
}
```

## 2. 通则

- 所有 PHP 文件 `必须` 使用 Unix LF (linefeed) 作为行的结束符。

- 所有 PHP 文件 `必须` 以一个空白行作为结束。

- 纯 PHP 代码文件 `必须` 省略最后的 ?> 结束标签。

- PHP 的关键字 `必须` 使用小写形式

- PHP 的常量 `ture`，`false`，还有 `null` 必须使用小写形式

## 3. 命名空间和使用声明
- `namespace` 声明之后 `必须` 存在一个空行

- 所有的 `use` 声明 `必须` 位于 `namespace` 声明之后。

- 每条 `use` 声明 `必须` 只有一个 `use` 关键字。

- `use` 语句块之后 `必须` 存在一个空行。

## 4. 类、属性和方法

- 关键词 `extends` 和 `implements` 必须 写在类名称的同一行。

- `implements` 的继承列表也 `可以` 分成多行，这样的话，每个继承接口名称都 `必须` 分开独立成行，包括第一个。

# PSR-4 自动加载规范

- 自动加载文件 `禁止` 抛出异常，`禁止` 出现任何级别的错误，也 `不建议` 有返回值。

# 参考资料

[《PHP PSR 标准规范》](https://learnku.com/docs/psr "《PHP PSR 标准规范》")