PSR 1 基本编码规范

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

本文件中的必须，不得，需要，应，不应，应该，不应该，推荐，可能和可选等词按照 RFC 2119 中的描述进行解释

规范

PHP 文件必须且只能以 <?php 或 <?= 标签开始
PHP 文件必须且只能使用 不带 BOM 的 UTF-8 编码
PHP 文件应该要么只定义符号 ( 类、函数、常量等等) ，要么是会产生副作用的代码 ( 例如生成输出、修改 .ini 配置等等 )，不应该 同时出现两者
命名空间和类名必须符合「自动加载」规范： PSR-0， PSR-4
类的名称必须符合 StudlyCaps 大写开头的驼峰命名规范
类的常量的所有字母都必须大写，且使用下划线 ( _ ) 分隔不同的单词
类的方法名必须符合 camelCase 式的小写开头驼峰命名规范

2. 文件

2.1. PHP 标签

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

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()
{
    // function body
}

下面是一个范例，一份只包含声明不产生「副作用」的代码

<?php
// 声明函数
function foo()
{
    // function body
}

// 条件声明 **不** 属于「副作用」
if (! function_exists('bar')) {
    function bar()
    {
        // function body
    }
}

3. 命名空间和类名

命名空间和类名必须符合「自动加载」规范： PSR-0， PSR-4

这意味着每个类都独立为一个文件，并且至少在一个层次的命名空间内，那就是：顶级组织名 ( vendor name )
类名必须以类似 StudlyCaps 形式的大写开头的驼峰命名方式声明

PHP 5.3 及更高版本

PHP 5.3 及更高版本的代码必须使用标准的命名空间

<?php
// PHP 5.3 及更高的版本
namespace Vendor\Model;

class Foo
{
}

PHP 5.2 及更低版本

PHP 5.2 及更低版本应该使用约定俗成的伪命名空间

所有的类名以组织名称 Vendor_ 为类名前缀

<?php
// PHP 5.2.x 及更低的版本
class Vendor_Model_Foo
{
}

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

这里的「类」指代所有的类、接口以及可复用代码块 ( traits )

4.1. 类常量

类常量的所有字母都必须大写，并且以下划线 ( _ ) 分隔每个单词

<?php
namespace Vendor\Model;

class Foo
{
    const VERSION = '1.0';  // 必须是大写字母
    const DATE_APPROVED = '2012-06-01';  // 以下划线分隔单词
}

4.2. 属性

类的属性名可以遵循以下几种命名方式

大写开头的驼峰式 ( $StudlyCaps )
下划线分隔式 ( $under_score )
小写开头的驼峰式 ( $camelCase )

本规范不做强制要求，但无论遵循哪种命名方式，都应该在一定的范围内保持一致。这个范围可以是整个团队、整个包、整个类或整个方法。

4.3. 方法

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

范例

下面这种写法是正确的

function sendTo(){};

但是下面这几种写法是错误的

function send_to(){};
function SendTo(){};
function Sendto(){};

规范