https://github.com/PizzaLiu/PHP-FIG
PSR(Proposing a Standards Recommondation), 即PHP编码规范,目前PSR更新为2016.5.26的PSR4,后续我们将持续关注。
PSR(Proposing a Standards Recommendation),PHP编码规范:
1. PSR-0(已弃用);
2. PSR-1概览:
PHP代码必须使用标签:<?php;
代码编码只可使用不带BOM的UTF-8编码;
从属效应:一份PHP文件应该要么就只定义新的声明,比如类、函数、常量等不产生从属效应的操作,要不就是只会产生从属效应【仅仅通过包含文件,不直接声明类、 函数和常量等,而执行的逻辑操作】的逻辑操作,而不应该同时具有两者。
命名空间以及类名必须遵循PSR-4;
常量所有字母大写,词间以下划线分割;类属性可驼峰式,可下划线,可小写驼峰式;方法名必须符合小写驼峰式开头的命名规范;
3. PSR-2概览:
代码必须符合PSR-1中所有规范;
所有PHP文件必须以一个空白行作为结束;
纯PHP代码文件必须省略最后的 ?>标签;
行的长度一定不能有硬性的约束;【80/120】;非空行后一定不能有多余空格字符;每行一定不能存在多于一条语句;
代码缩进必须使用4个空格字符缩进,一定不能用tab键;
PHP中所有关键字必须小写,包括true false null;
Namespace 声明后必须插入一个空白行,所有use必须在namespace后声明,use声明语句块后必须要有一个空白行;
关键词extends、implements必须写在类名称同一行;类开始和结束花括号必须在类代码中独占一行;
每个属性和方法必须添加访问修饰符;方法名称后一定不能有空格,其开始花括号和结束符号必须独占一行;参数左、右括号前一定不能有空格;参数列表中每个逗号后必须有一个空格,而逗号前一定不能有空格,有默认值的参数一定放到参数末尾;
类的属性和方法必须添加访问修饰符(private、protected以及public),abstract以及final必须声明在访问修饰符之前,而static必须声明在访问修饰符之后;
4. PSR-3概览:
本文制定了日志类库的通用接口规,是为了让日志类库以简单通用的方式,通过接收一个Psr\Log\LoggerInterface对象,来记录日志信息。
5. PSR-4 概览:
文件路径载入规范,autoload:类名==》文件名==》文件磁盘路径;
此处类泛指所有的class类、接口、traits可复用代码块以及其他类似结构;
一个完整的类名具有以下结构:
\<命名空间>(\<子命名空间>)*\<类名>
i:完整的类名必须有一个顶级命名空间,被称为“vendor namespace”;
ii:完整的类名可以有一个或多个子命名空间;
iii:完整的类名必须有一个最终的类名【大小写敏感】;
当根据完整类名文件加载相应的文件:
I:完整的类名中,去掉最前面的命名空间分隔符,前面连续的一个或多个命名空间和子命名空间,作为“命名空间前缀”,其必须与至少一个“文件基目录”相对应;
ii:紧挨命名空间前缀后的子命名空间必须与相应的“文件基目录”相匹配,其中命名空间分隔符将作为目录分隔符。
iii:末尾的类名必须与对应的以.php为后缀的文件同名。
iiii:自动加载器(autoloader)的实现一定不能抛出异常、一定不能触发任一级别的错误信息以及不应该有返回值。