PSR-1.jpg
基本代码规范
本规范制定了代码基本元素的相关标准，确保 PHP 代码间具有较高程度的技术互通性。
1. Overview
- PHP 文件 必须 以
<?php或<?=标签开始； - PHP 文件 必须 以
不带 BOM 的 UTF-8编码； - 命名空间以及类 必须 符合 PSR 的自动加载规范： PSR-4，PSR-0 (Deprecated 已废弃)；
- 类的命名 必须 遵循
StudlyCaps大写开头的骆峰命名规范； - 方法命名 必须 符合
camelCase()小写开头的骆峰命名规范； - 类中的常量所有字母都 必须 大写，单词间用
_下划线分隔； - PHP 文件 应该 只定义类、函数、常量等声明，或其它会产生 副作用( side-effects ) 的操作(生成文件输出、更改 .ini 配置文件等)，但 不该 同时出现(Do Both)。
2. Files
2.1. PHP 标签
PHP 代码 必须 使用 长标签 <?php ?> 长标签 或 <?= ?> 短标签 输出；
一定不可 使用其它自定义标签。
2.2. 字符编码
PHP 代码 必须 且只可使用 不带 BOM 的 UTF-8 编码。
2.3. 副作用( side-effects )
PHP 文件中 应该 要么只定义新的声明，如类、函数或常量等不产生「副作用」的操作，要么只写会产生「副作用」 的逻辑操作，但 不该 同时具有两者。
「副作用」( side-effects )：仅通过包含文件，不直接声明类、函数或常量等，而执行的逻辑操作。
「副作用」包含且不仅限于：
- 生成输出
- 直接的
require或include - 连接外部服务
- 修改 ini 配置
- 抛出错误或异常
- 修改全局或静态变量
- 读写文件等
以下举一 「反例」则一目了然，包含「函数声明」和产生「副作用」的例子：
<?php
//「副作用」：生成输出
echo "<html>\n";
//「副作用」：修改 ini 配置
ini_set('error_reporting', E_ALL);
//「副作用」:引入文件
include "file.php";
// 声明函数
function test()
{
//函数主体部分
}
3. Namespace and Class Names
命名空间以及类的命名必须遵循 PSR-4 规范。
根据规范，每个类都独立一个文件，且命名空间至少有一个层次：顶级的「组织名称」( vendor name )。
"vendor": Someone who promotes or exchanges goods or services for money.
类的命名 必须 遵循 StudlyCaps 大写开头的骆峰命名规范。
PHP 5.3 及以后版本的代码 必须 使用正式的命名空间。
<?php
//PHP 5.3 及以后版本写法
namespace Vendor\Model;
class Foo
{
}
PHP 5.2.x 及以前的版本 应该 使用伪命名空间的写法，约定俗成使用顶级的「组织名称」，如 Vendor_ 为类前缀。
<?php
// PHP 5.2.x 及之前版本写法
class Vendor_Model_Foo
{
}
4. Class Constants,Properties,and Methods
The term “class” refers to all classes, interfaces, and traits.
4.1. 常量(Constants)
类常量所有字母都 必须 大写，词间用 _ 下划线分隔。
4.2. 属性(Properties)
类的属性命名 可以 遵循：
- 大写开头的骆峰规范
$StudlyCaps - 小写开头的骆峰规范
$camelCase - 或者下划线分隔形式
$under_score
本规范不强制要求，但一定范围内 应该 保持一致。这个范围可以是整个团队、整个包、整个类或整个方法。
4.3. 方法(Methods)
方法名称 必须 符合 camelCase() 式的小写开头骆峰命名规则。
文章中会有一些必要的英文原著、备注，这是由于本人觉得在有些技术文档上，相比译文，原来的英文能在理解上有更大的帮助。
参考文献
GitHub: https://github.com/php-fig/fig-standards
php-fig： https://www.php-fig.org/psr/
网友评论