phpfigPHP代码规范

当多名程序员在多个项目中互助时，就须要一个共同的编码规范，而本文中的风格规范源自于多个不同项目代码风格的共同特性，因此，本规范的代价在于我们都遵照这个编码风格，而不是在于它本身。

关键词 “必须”("MUST")、“一定不可/一定不能”("MUST NOT")、“须要”("REQUIRED")、 “将会”("SHALL")、“不会”("SHALL NOT")、“该当”("SHOULD")、“不该”("SHOULD NOT")、 “推举”("RECOMMENDED")、“可以”("MAY")和”可选“("OPTIONAL")的详细描述可拜会 RFC 2119 。

概览代码必须遵照 PSR-1 中的编码规范。
代码必须利用4个空格符而不是 tab键进行缩进。
每行的字符数该当软性保持在80个之内，理论上一定不可多于120个，但一定不能有硬性限定。
每个 namespace 命名空间声明语句和 use 声明语句块后面，必须插入一个空缺行。
类的开始花括号({)必须写在其声明后自成一行，结束花括号(})也必须写在其主体后自成一行。
方法的开始花括号({)必须写在函数声明后自成一行，结束花括号(})也必须写在函数主体后自成一行。
类的属性和方法必须添加访问润色符（private、protected 以及 public）， abstract 以及 final 必须声明在访问润色符之前，而 static 必须声明在访问润色符之后。
掌握构造的关键字后必须要有一个空格符，而调用方法或函数时则一定不能有。
掌握构造的开始花括号({)必须写在声明的同一行，而结束花括号(})必须写在主体后自成一行。
掌握构造的开始左括号后和结束右括号前，都一定不能有空格符。
1.1. 例子

以下例子程序大略地展示了以上大部分规范：

phpfigPHP代码规范 NoSQL

<?phpnamespace Vendor\Package;use FooInterface;use BarClass as Bar;use OtherVendor\OtherPackage\BazClass;class Foo extends Bar implements FooInterface{ public function sampleFunction($a, $b = null) { if ($a === $b) { bar(); } elseif ($a > $b) { $foo->bar($arg1); } else { BazClass::bar($arg2, $arg3); } } final public static function bar() { // method body }}通则2.1 基本编码准则

代码必须符合 PSR-1 中的所有规范。

2.2 文件

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

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

纯PHP代码文件必须省略末了的 ?> 结束标签。

2.3. 行

行的长度一定不能有硬性的约束。

软性的长度约束一定要限定在120个字符以内，若超过此长度，带代码规范检讨的编辑器一定要发出警告，不过一定不可发出错误提示。

每行不应该多于80个字符，大于80字符的行该当折成多行。

非空行后一定不能有多余的空格符。

空行可以使得阅读代码更加方便以及有助于代码的分块。

每行一定不能存在多于一条语句。

2.4. 缩进

代码必须利用4个空格符的缩进，一定不能用 tab键。

备注: 利用空格而不是tab键缩进的好处在于，避免在比较代码差异、打补丁、重阅代码以及注释时产生稠浊。
并且，利用空格缩进，让对齐变得更方便。

2.5. 关键字以及 True/False/Null

PHP所有关键字必须全部小写。

常量 true 、false 和 null 也必须全部小写。

namespace 以及 use 声明

namespace 声明后必须插入一个空缺行。

所有 use 必须在 namespace 后声明。

每条 use 声明语句必须只有一个 use 关键词。

use 声明语句块后必须要有一个空缺行。

例如：

<?phpnamespace Vendor\Package;use FooClass;use BarClass as Bar;use OtherVendor\OtherPackage\BazClass;// ... additional PHP code ...类、属性和方法

此处的“类”泛指所有的class类、接口以及traits可复用代码块。

4.1. 扩展与继续

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

类的开始花括号必须独占一行，结束花括号也必须在类主体后独占一行。

<?phpnamespace Vendor\Package;use FooClass;use BarClass as Bar;use OtherVendor\OtherPackage\BazClass;class ClassName extends ParentClass implements \ArrayAccess, \Countable{ // constants, properties, methods}

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

每个属性都必须添加访问润色符。

一定不可利用关键字 var 声明一个属性。

每条语句一定不可定义超过一个属性。

不要利用下划线作为前缀，来区分属性是 protected 或 private。

以下是属性声明的一个范例：

<?phpnamespace Vendor\Package;class ClassName{ public $foo = null;}4.3. 方法

所有方法都必须添加访问润色符。

不要利用下划线作为前缀，来区分方法是 protected 或 private。

方法名称后一定不能有空格符，其开始花括号必须独占一行，结束花括号也必须在方法主体后单独成一行。
参数左括号后和右括号前一定不能有空格。

一个标准的方法声明可参照以下范例，留神其括号、逗号、空格以及花括号的位置。

<?phpnamespace Vendor\Package;class ClassName{ public function fooBarBaz($arg1, &$arg2, $arg3 = []) { // method body }}4.4. 方法的参数

参数列表中，每个逗号后面必须要有一个空格，而逗号前面一定不能有空格。

有默认值的参数，必须放到参数列表的末端。

<?phpnamespace Vendor\Package;class ClassName{ public function foo($arg1, &$arg2, $arg3 = []) { // method body }}

参数列表可以分列成多行，这样，包括第一个参数在内的每个参数都必须单独成行。

拆分成多行的参数列表后，结束括号以及方法开始花括号必须写在同一行，中间用一个空格分隔。

<?phpnamespace Vendor\Package;class ClassName{ public function aVeryLongMethodName( ClassTypeHint $arg1, &$arg2, array $arg3 = [] ) { // method body }}4.5. abstract 、 final 、以及 static

须要添加 abstract 或 final 声明时，必须写在访问润色符前，而 static 则必须写在其后。

<?phpnamespace Vendor\Package;abstract class ClassName{ protected static $foo; abstract protected function zim(); final public static function bar() { // method body }}4.6. 方法及函数调用

方法及函数调用时，方法名或函数名与参数左括号之间一定不能有空格，参数右括号前也一定不能有空格。
每个逗号前一定不能有空格，但其后必须有一个空格。

<?phpbar();$foo->bar($arg1);Foo::bar($arg2, $arg3);

参数可以分列成多行，此时包括第一个参数在内的每个参数都必须单独成行。

<?php$foo->bar( $longArgument, $longerArgument, $muchLongerArgument);掌握构造

掌握构造的基本规范如下：

掌握构造关键词后必须有一个空格。
左括号 ( 后一定不能有空格。
右括号 ) 前也一定不能有空格。
右括号 ) 与开始花括号 { 间一定有一个空格。
构造体主体一定要有一次缩进。
结束花括号 } 一定在构造体主体后单独成行。

每个构造体的主体都必须被包含在成对的花括号之中，这能让构造体更加构造话，以及减少加入新行时，出错的可能性。

5.1. if 、 elseif 和 else

标准的 if 构造如下代码所示，留神括号、空格以及花括号的位置，把稳 else 和 elseif 都与前面的结束花括号在同一行。

<?phpif ($expr1) { // if body} elseif ($expr2) { // elseif body} else { // else body;}

该当利用关键词 elseif 代替所有 else if ，以使得所有的掌握关键字都像是单独的一个词。

5.2. switch 和 case

标准的 switch 构造如下代码所示，留神括号、空格以及花括号的位置。
case 语句必须相对 switch 进行一次缩进，而 break 语句以及 case 内的其它语句都必须相对 case 进行一次缩进。
如果存在非空的 case 直穿语句，主体里必须有类似 // no break 的注释。

<?phpswitch ($expr) { case 0: echo 'First case, with a break'; break; case 1: echo 'Second case, which falls through'; // no break case 2: case 3: case 4: echo 'Third case, return instead of break'; return; default: echo 'Default case'; break;}5.3. while 和 do while

一个规范的 while 语句该当如下所示，把稳其括号、空格以及花括号的位置。

<?phpwhile ($expr) { // structure body}

标准的 do while 语句如下所示，同样的，把稳其括号、空格以及花括号的位置。

<?phpdo { // structure body;} while ($expr);5.4. for

标准的 for 语句如下所示，把稳其括号、空格以及花括号的位置。

<?phpfor ($i = 0; $i < 10; $i++) { // for body}5.5. foreach

标准的 foreach 语句如下所示，把稳其括号、空格以及花括号的位置。

<?phpforeach ($iterable as $key => $value) { // foreach body}5.6. try, catch

标准的 try catch 语句如下所示，把稳其括号、空格以及花括号的位置。

<?phptry { // try body} catch (FirstExceptionType $e) { // catch body} catch (OtherExceptionType $e) { // catch body}闭包

闭包声明时，关键词 function 后以及关键词 use 的前后都必须要有一个空格。

开始花括号必须写在声明的同一行，结束花括号必须紧跟主体结束的下一行。

参数列表和变量列表的左括号后以及右括号前，必须不能有空格。

参数和变量列表中，逗号前必须不能有空格，而逗号后必须要有空格。

闭包中有默认值的参数必须放到列表的后面。

标准的闭包声明语句如下所示，把稳其括号、逗号、空格以及花括号的位置。

<?php$closureWithArgs = function ($arg1, $arg2) { // body};$closureWithArgsAndVars = function ($arg1, $arg2) use ($var1, $var2) { // body};

参数列表以及变量列表可以分成多行，这样，包括第一个在内的每个参数或变量都必须单独成行，而列表的右括号与闭包的开始花括号必须放在同一行。

以下几个例子，包含了参数和变量列表被分成多行的多情形。

<?php$longArgs_noVars = function ( $longArgument, $longerArgument, $muchLongerArgument) { // body};$noArgs_longVars = function () use ( $longVar1, $longerVar2, $muchLongerVar3) { // body};$longArgs_longVars = function ( $longArgument, $longerArgument, $muchLongerArgument) use ( $longVar1, $longerVar2, $muchLongerVar3) { // body};$longArgs_shortVars = function ( $longArgument, $longerArgument, $muchLongerArgument) use ($var1) { // body};$shortArgs_longVars = function ($arg) use ( $longVar1, $longerVar2, $muchLongerVar3) { // body};

把稳，闭包被直接用作函数或方法调用的参数时，以上规则仍旧适用。

<?php$foo->bar( $arg1, function ($arg2) use ($var1) { // body }, $arg3);总结

以上规范难免有轻忽，个中包括但不仅限于：

全局变量和常量的定义函数的定义操作符和赋值行内对齐注释和文档描述块类名的前缀及后缀最佳实践日志接口规范

本文制订了日志类库的通用接口规范。

本规范的紧张目的，是为了让日志类库以大略通用的办法，通过吸收一个 Psr\Log\LoggerInterface 工具，来记录日志信息。
框架以及CMS内容管理系统如有须要，可以对此接口进行扩展，但需遵照本规范，这才能担保在利用第三方的类库文件时，日志接口仍能正常对接。

本文中的实现者指的是实现了 LoggerInterface 接口的类库或者框架，反过来讲，他们便是 LoggerInterface 的利用者。

规范解释1.1 基本规范LoggerInterface 接口对外定义了八个方法，分别用来记录 RFC 5424 中定义的八个等级的日志：debug、 info、 notice、 warning、 error、 critical、 alert 以及 emergency 。
第九个方法 —— log，其第一个参数为记录的等级。
可利用一个预先定义的等级常量作为参数来调用此方法，必须与直接调用以上八个方法具有相同的效果。
如果传入的等级常量参数没有预先定义，则必须抛出 Psr\Log\InvalidArgumentException 类型的非常。
在不愿定的情形下，利用者不该利用未支持的等级常量来调用此方法。
1.2 记录信息以上每个方法都接管一个字符串类型或者是有 __toString() 方法的工具作为记录信息参数，这样，实现者就能把它当成字符串来处理，否则实现者必须自己把它转换成字符串。
记录信息参数可以携带占位符，实现者可以根据高下文将其它更换成相应的值。

个中占位符必须与高下文数组中的键名保持同等。

占位符的名称必须由一个左花括号 { 以及一个右括号 } 包含。
但花括号与名称之间一定不能有空格符。

占位符的名称该当只由 A-Z、 a-z,0-9、下划线 _、以及英文的句号 .组成，其它字符作为将来占位符规范的保留。

实现者可以通过对占位符采取不同的转义和转换策略，来天生终极的日志。
而利用者在不知道高下文的条件下，不该提前转义占位符。

以下是一个占位符利用的例子：

/ 用高下文信息更换记录信息中的占位符 /function interpolate($message, array $context = array()){ // 构建一个花括号包含的键名的更换数组 $replace = array(); foreach ($context as $key => $val) { $replace['{' . $key . '}'] = $val; } // 更换记录信息中的占位符，末了返回修正后的记录信息。 return strtr($message, $replace);}// 含有带花括号占位符的记录信息。 $message = "User {username} created";// 带有更换信息的高下文数组，键名为占位符名称，键值为更换值。 $context = array('username' => 'bolivar');// 输出 "Username bolivar created"echo interpolate($message, $context);1.3 高下文每个记录函数都接管一个高下文数组参数，用来装载字符串类型无法表示的信息。
它可以装载任何信息，以是实现者必须确保能精确处理其装载的信息，对付其装载的数据，一定不能抛出非常，或产生PHP出错、警告或提醒信息（error、warning、notice）。
如需通过高下文参数传入了一个 Exception 工具，必须以 'exception' 作为键名。
记录非常信息是很普遍的，以是如果它能够在记录类库的底层实现，就能够让实现者从非常信息中抽丝剥茧。
当然，实现者在利用它时，必须确保键名为 'exception' 的键值是否真的是一个 Exception，毕竟它可以装载任何信息。
1.4 助手类和接口Psr\Log\AbstractLogger 类使得只需继续它和实现个中的 log 方法，就能够很轻易地实现 LoggerInterface 接口，而其余八个方法就能够把记录信息和高下文信息传给它。
同样地，利用 Psr\Log\LoggerTrait 也只需实现个中的 log 方法。
不过，须要特殊把稳的是，在traits可复用代码块还不能实现接口前，还须要 implement LoggerInterface。
在没有可用的日志记录器时， Psr\Log\NullLogger 接口可以为利用者供应一个备用的日志“黑洞”。
不过，当高下文的构建非常花费资源时，带条件检讨的日志记录或许是更好的办法。
Psr\Log\LoggerAwareInterface 接口仅包括一个 setLogger(LoggerInterface $logger) 方法，框架可以利用它实现自动连接任意的日志记录实例。
Psr\Log\LoggerAwareTrait trait可复用代码块可以在任何的类里面利用，只需通过它供应的 $this->logger，就可以轻松地实现等同的接口。
Psr\Log\LogLevel 类装载了八个记录等级常量。
包

上述的接口、类和干系的非常类，以及一系列的实现检测文件，都包含在 psr/log 文件包中。

Psr\Log\LoggerInterface

<?phpnamespace Psr\Log;/ 日志记录实例日志信息变量 —— message，必须是一个字符串或是实现了 __toString() 方法的工具。日志信息变量中可以包含格式如 “{foo}” (代表foo) 的占位符，它将会由高下文数组中键名为 "foo" 的键值替代。高下文数组可以携带任意的数据，唯一的限定是，当它携带的是一个 exception 工具时，它的键名必须是 "exception"。详情可参阅： https://github.com/PizzaLiu/PHP-FIG/blob/master/PSR-3-logger-interface-cn.md /interface LoggerInterface{ / 系统不可用 @param string $message @param array $context @return null / public function emergency($message, array $context = array()); / 必须急速采纳行动例如：在全体网站都垮掉了、数据库不可用了或者其他的情形下，该当发送一条警报短信把你叫醒。 @param string $message @param array $context @return null / public function alert($message, array $context = array()); / 紧急情形例如：程序组件不可用或者涌现非预期的非常。 @param string $message @param array $context @return null / public function critical($message, array $context = array()); / 运行时涌现的缺点，不须要急速采纳行动，但必须记录下来以备检测。 @param string $message @param array $context @return null / public function error($message, array $context = array()); / 涌现非缺点性的非常。例如：利用了被弃用的API、缺点地利用了API或者非预想的不必要缺点。 @param string $message @param array $context @return null / public function warning($message, array $context = array()); / 一样平常性主要的事宜。 @param string $message @param array $context @return null / public function notice($message, array $context = array()); / 主要事宜例如：用户登录和SQL记录。 @param string $message @param array $context @return null / public function info($message, array $context = array()); / debug 详情 @param string $message @param array $context @return null / public function debug($message, array $context = array()); / 任意等级的日志记录 @param mixed $level @param string $message @param array $context @return null / public function log($level, $message, array $context = array());}Psr\Log\LoggerAwareInterface

<?phpnamespace Psr\Log;/ logger-aware 定义实例 /interface LoggerAwareInterface{ / 设置一个日志记录实例 @param LoggerInterface $logger @return null / public function setLogger(LoggerInterface $logger);}Psr\Log\LogLevel

<?phpnamespace Psr\Log;/ 日志等级常量定义 /class LogLevel{ const EMERGENCY = 'emergency'; const ALERT = 'alert'; const CRITICAL = 'critical'; const ERROR = 'error'; const WARNING = 'warning'; const NOTICE = 'notice'; const INFO = 'info'; const DEBUG = 'debug';}Autoloader1. 概述

本 PSR 是关于由文件路径自动载入对应类的干系规范，本规范是可互操作的，可以作为任一自动载入规范的补充，个中包括 PSR-0，此外，本 PSR 还包括自动载入的类对应的文件存放路径规范。

2. 详细解释此处的“类”泛指所有的class类、接口、traits可复用代码块以及其它类似构造。
一个完全的类名需具有以下构造:

\<命名空间>(\<子命名空间>)\<类名>完全的类名必须要有一个顶级命名空间，被称为 "vendor namespace"；完全的类名可以有一个或多个子命名空间；完全的类名必须有一个终极的类名；完全的类名中任意一部分中的下划线都是没有分外含义的；完全的类名可以由任意大小写字母组成；所有类名都必须是大小写敏感的。
当根据完全的类名载入相应的文件……完全的类名中，去掉最前面的命名空间分隔符，前面连续的一个或多个命名空间和子命名空间，作为“命名空间前缀”，其必须与至少一个“文件基目录”相对应；紧接命名空间前缀后的子命名空间必须与相应的”文件基目录“相匹配，个中的命名空间分隔符将作为目录分隔符。
末端的类名必须与对应的以 .php 为后缀的文件同名。
自动加载器（autoloader）的实现一定不能抛出非常、一定不能触发任一级别的缺点信息以及不应该有返回值。
3. 例子

下表展示了符合规范完全类名、命名空间前缀和文件基目录所对应的文件路径。

无法复制加载中的内容

关于本规范的实现，可参阅干系实例

把稳：实例并不属于规范的一部分，且随时会有所变动。

参考：https://github.com/PizzaLiu/PHP-FIG

4. 代码规范工具PHP Mess Detector(http://phpmd.org/)

PHP项目体检工具，根据你设定的标准（如单一文件代码体积，未利用的参数个数，未利用的方法数）检讨PHP代码，超出设定的标准时报警。

PHP Copy Paste Detector(https://github.com/sebastianbergmann/...)

顾名思义，检讨冗余代码的

PHP Dead Code Detector(https://github.com/sebastianbergmann/...)

看名字就知道了，检讨从未被调用过的方法

PHP Code Sniffer(http://pear.php.net/package/PHP_CodeS...)