PHP代码规范
本规范希望通过制定一系列规范化PHP代码的规则，以减少在浏览不同作者的代码时，因代码风格的不同而造成不便。
当多名程序员在多个项目中合作时，就需要一个共同的编码规范，而本文中的风格规范源自于多个不同项目代码风格的共同特性，因此，本规范的价值在于我们都遵循这个编码风格，而不是在于它本身。
关键词“必须”("MUST")、“一定不可/一定不能”("MUSTNOT")、“需要”("REQUIRED")、“将会”("SHALL")、“不会”("SHALLNOT")、“应该”("SHOULD")、“不该”("SHOULDNOT")、“推荐”("RECOMMENDED")、“可以”("MAY")和”可选“("OPTIONAL")的详细描述可参见RFC2119。
概览
代码必须遵循PSR-1中的编码规范。
代码必须使用4个空格符而不是tab键进行缩进。
每行的字符数应该软性保持在80个之内，理论上一定不可多于120个，但一定不能有硬性限制。
每个namespace命名空间声明语句和use声明语句块后面，必须插入一个空白行。
类的开始花括号({)必须写在其声明后自成一行，结束花括号(})也必须写在其主体后自成一行。
方法的开始花括号({)必须写在函数声明后自成一行，结束花括号(})也必须写在函数主体后自成一行。
类的属性和方法必须添加访问修饰符（private、protected以及public），abstract以及final必须声明在访问修饰符之前，而static必须声明在访问修饰符之后。
控制结构的关键字后必须要有一个空格符，而调用方法或函数时则一定不能有。
控制结构的开始花括号({)必须写在声明的同一行，而结束花括号(})必须写在主体后自成一行。
控制结构的开始左括号后和结束右括号前，都一定不能有空格符。
以下例子程序简单地展示了以上大部分规范：
?phpnamespaceVor\Package;useFooInterface;useBarClassasBar;useOtherVor\OtherPackage\BazClass;classFooextsBarimplementsFooInterface{publicfunctionsampleFunction($a,$b=null){if($a===$b){bar();}elseif($a$b){$foo-bar($arg1);}else{BazClass::bar($arg2,$arg3);}}finalpublicstaticfunctionbar(){//methodbody}}
通则
代码必须符合PSR-1中的所有规范。
所有PHP文件必须使用UnixLF(linefeed)作为行的结束符。
所有PHP文件必须以一个空白行作为结束。
纯PHP代码文件必须省略最后的?结束标签。
行的长度一定不能有硬性的约束。
软性的长度约束一定要限制在120个字符以内，若超过此长度，带代码规范检查的编辑器一定要发出警告，不过一定不可发出错误提示。
每行不应该多于80个字符，大于80字符的行应该折成多行。
非空行后一定不能有多余的空格符。
空行可以使得阅读代码更加方便以及有助于代码的分块。
每行一定不能存在多于一条语句。
代码必须使用4个空格符的缩进，一定不能用tab键。
PHP所有关键字必须全部小写。
常量true、false和null也必须全部小写。
namespace以及use声明
namespace声明后必须插入一个空白行。
所有use必须在namespace后声明。
每条use声明语句必须只有一个use关键词。
use声明语句块后必须要有一个空白行。
例如：
?phpnamespaceVor\Package;useFooClass;useBarClassasBar;useOtherVor\OtherPackage\BazClass;//additionalPHPcode
类、属性和方法
此处的“类”泛指所有的class类、接口以及traits可复用代码块。
关键词exts和implements必须写在类名称的同一行。
类的开始花括号必须独占一行，结束花括号也必须在类主体后独占一行。
?phpnamespaceVor\Package;useFooClass;useBarClassasBar;useOtherVor\OtherPackage\BazClass;classClassNameextsParentClassimplements\ArrayAccess,\Countable{//constants,properties,methods}
implements的继承列表也可以分成多行，这样的话，每个继承接口名称都必须分开独立成行，包括第一个。
?phpnamespaceVor\Package;useFooClass;useBarClassasBar;useOtherVor\OtherPackage\BazClass;classClassNameextsParentClassimplements\ArrayAccess,\Countable,\Serializable{//constants,properties,methods}
4.2.属性每个属性都必须添加访问修饰符。
一定不可使用关键字var声明一个属性。
每条语句一定不可定义超过一个属性。
不要使用下划线作为前缀，来区分属性是protected或private。
以下是属性声明的一个范例：
?phpnamespaceVor\Package;classClassName{public$foo=null;}
4.3.方法所有方法都必须添加访问修饰符。
不要使用下划线作为前缀，来区分方法是protected或private。
方法名称后一定不能有空格符，其开始花括号必须独占一行，结束花括号也必须在方法主体后单独成一行。参数左括号后和右括号前一定不能有空格。
一个标准的方法声明可参照以下范例，留意其括号、逗号、空格以及花括号的位置。
?phpnamespaceVor\Package;classClassName{publicfunctionfooBarBaz($arg1,$arg2,$arg3=[]){//methodbody}}
4.4.方法的参数参数列表中，每个逗号后面必须要有一个空格，而逗号前面一定不能有空格。
有默认值的参数，必须放到参数列表的末尾。
?phpnamespaceVor\Package;classClassName{publicfunctionfoo($arg1,$arg2,$arg3=[]){//methodbody}}
参数列表可以分列成多行，这样，包括第一个参数在内的每个参数都必须单独成行。
拆分成多行的参数列表后，结束括号以及方法开始花括号必须写在同一行，中间用一个空格分隔。
?phpnamespaceVor\Package;classClassName{publicfunctionaVeryLongMethodName(ClassTypeHint$arg1,$arg2,array$arg3=[]){//methodbody}}
4.5.abstract、final、以及static需要添加abstract或final声明时，必须写在访问修饰符前，而static则必须写在其后。
?phpnamespaceVor\Package;abstractclassClassName{protectedstatic$foo;abstractprotectedfunctionzim();finalpublicstaticfunctionbar(){//methodbody}}4.6.方法及函数调用
方法及函数调用时，方法名或函数名与参数左括号之间一定不能有空格，参数右括号前也一定不能有空格。每个逗号前一定不能有空格，但其后必须有一个空格。
?phpbar();$foo-bar($arg1);Foo::bar($arg2,$arg3);
参数可以分列成多行，此时包括第一个参数在内的每个参数都必须单独成行。
?php$foo-bar($longArgument,$longerArgument,$muchLongerArgument);
控制结构
控制结构的基本规范如下：
控制结构关键词后必须有一个空格。
左括号(后一定不能有空格。
右括号)前也一定不能有空格。
右括号)与开始花括号{间一定有一个空格。
结构体主体一定要有一次缩进。
结束花括号}一定在结构体主体后单独成行。
每个结构体的主体都必须被包含在成对的花括号之中，这能让结构体更加结构话，以及减少加入新行时，出错的可能性。
标准的if结构如下代码所示，留意括号、空格以及花括号的位置，注意else和elseif都与前面的结束花括号在同一行。
?phpif($expr1){//ifbody}elseif($expr2){//elseifbody}else{//elsebody;}
应该使用关键词elseif代替所有elseif，以使得所有的控制关键字都像是单独的一个词。
标准的switch结构如下代码所示，留意括号、空格以及花括号的位置。case语句必须相对switch进行一次缩进，而break语句以及case内的其它语句都必须相对case进行一次缩进。如果存在非空的case直穿语句，主体里必须有类似//nobreak的注释。
?phpswitch($expr){case0:echo'Firstcase,withabreak';break;case1:echo'Secondcase,whichfallsthrough';//nobreakcase2:case3:case4:echo'Thirdcase,returninsteadofbreak';return;default:echo'Defaultcase';break;}
5.3.while和dowhile一个规范的while语句应该如下所示，注意其括号、空格以及花括号的位置。
?phpwhile($expr){//structurebody}
标准的dowhile语句如下所示，同样的，注意其括号、空格以及花括号的位置。
?phpdo{//structurebody;}while($expr);
5.4.for标准的for语句如下所示，注意其括号、空格以及花括号的位置。
?phpfor($i=0;$i10;$i++){//forbody}
5.5.foreach标准的foreach语句如下所示，注意其括号、空格以及花括号的位置。
?phpforeach($iterableas$key=$value){//foreachbody}
5.6.try,catch标准的trycatch语句如下所示，注意其括号、空格以及花括号的位置。
?phptry{//trybody}catch(FirstExceptionType$e){//catchbody}catch(OtherExceptionType$e){//catchbody}
闭包
闭包声明时，关键词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的使用者。
规范说明
LoggerInterface接口对外定义了八个方法，分别用来记录RFC5424中定义的八个等级的日志：debug、info、notice、warning、error、critical、alert以及emergency。
第九个方法——log，其第一个参数为记录的等级。可使用一个预先定义的等级常量作为参数来调用此方法，必须与直接调用以上八个方法具有相同的效果。如果传入的等级常量参数没有预先定义，则必须抛出Psr\Log\InvalidArgumentException类型的异常。在不确定的情况下，使用者不该使用未支持的等级常量来调用此方法。
以上每个方法都接受一个字符串类型或者是有__toString()方法的对象作为记录信息参数，这样，实现者就能把它当成字符串来处理，否则实现者必须自己把它转换成字符串。
记录信息参数可以携带占位符，实现者可以根据上下文将其它替换成相应的值。
其中占位符必须与上下文数组中的键名保持一致。
占位符的名称必须由一个左花括号{以及一个右括号}包含。但花括号与名称之间一定不能有空格符。
占位符的名称应该只由A-Z、a-z,0-9、下划线_、以及英文的句号.组成，其它字符作为将来占位符规范的保留。
实现者可以通过对占位符采用不同的转义和转换策略，来生成最终的日志。而使用者在不知道上下文的前提下，不该提前转义占位符。
以下是一个占位符使用的例子：
/***用上下文信息替换记录信息中的占位符*/functioninterpolate($message,array$context=array()){//构建一个花括号包含的键名的替换数组$replace=array();foreach($contextas$key=$val){$replace['{'.$key.'}']=$val;}//替换记录信息中的占位符，最后返回修改后的记录信息。returnstrtr($message,$replace);}//含有带花括号占位符的记录信息。$message="User{username}created";//带有替换信息的上下文数组，键名为占位符名称，键值为替换值。$context=array('username'='bolivar');//输出"Usernamebolivarcreated"echointerpolate($message,$context);
1.3上下文每个记录函数都接受一个上下文数组参数，用来装载字符串类型无法表示的信息。它可以装载任何信息，所以实现者必须确保能正确处理其装载的信息，对于其装载的数据，一定不能抛出异常，或产生PHP出错、警告或提醒信息（error、warning、notice）。
如需通过上下文参数传入了一个Exception对象，必须以'exception'作为键名。记录异常信息是很普遍的，所以如果它能够在记录类库的底层实现，就能够让实现者从异常信息中抽丝剥茧。当然，实现者在使用它时，必须确保键名为'exception'的键值是否真的是一个Exception，毕竟它可以装载任何信息。
Psr\Log\AbstractLogger类使得只需继承它和实现其中的log方法，就能够很轻易地实现LoggerInterface接口，而另外八个方法就能够把记录信息和上下文信息传给它。
同样地，使用Psr\Log\LoggerTrait也只需实现其中的log方法。不过，需要特别注意的是，在traits可复用代码块还不能实现接口前，还需要implementLoggerInterface。
在没有可用的日志记录器时，Psr\Log\NullLogger接口可以为使用者提供一个备用的日志“黑洞”。不过，当上下文的构建非常消耗资源时，带条件检查的日志记录或许是更好的办法。
Psr\Log\LoggerAwareInterface接口仅包括一个setLogger(LoggerInterface$logger)方法，框架可以使用它实现自动连接任意的日志记录实例。
Psr\Log\LoggerAwareTraittrait可复用代码块可以在任何的类里面使用，只需通过它提供的$this-logger，就可以轻松地实现等同的接口。
Psr\Log\LogLevel类装载了八个记录等级常量。
包
上述的接口、类和相关的异常类，以及一系列的实现检测文件，都包含在psr/log文件包中。
Psr\Log\LoggerInterface
?phpnamespacePsr\Log;/***日志记录实例**日志信息变量——message，**必须**是一个字符串或是实现了__toString()方法的对象。**日志信息变量中**可以**包含格式如“{foo}”(代表foo)的占位符，*它将会由上下文数组中键名为"foo"的键值替代。**上下文数组可以携带任意的数据，唯一的限制是，当它携带的是一个exception对象时，它的键名必须是"exception"。**详情可参阅：*/interfaceLoggerInterface{/***系统不可用**@paramstring$message*@paramarray$context*@returnnull*/publicfunctionemergency($message,array$context=array());/*****必须**立刻采取行动**例如：在整个网站都垮掉了、数据库不可用了或者其他的情况下，**应该**发送一条警报短信把你叫醒。**@paramstring$message*@paramarray$context*@returnnull*/publicfunctionalert($message,array$context=array());/***紧急情况**例如：程序组件不可用或者出现非预期的异常。**@paramstring$message*@paramarray$context*@returnnull*/publicfunctioncritical($message,array$context=array());/***运行时出现的错误，不需要立刻采取行动，但必须记录下来以备检测。**@paramstring$message*@paramarray$context*@returnnull*/publicfunctionerror($message,array$context=array());/***出现非错误性的异常。**例如：使用了被弃用的API、错误地使用了API或者非预想的不必要错误。**@paramstring$message*@paramarray$context*@returnnull*/publicfunctionwarning($message,array$context=array());/***一般性重要的事件。**@paramstring$message*@paramarray$context*@returnnull*/publicfunctionnotice($message,array$context=array());/***重要事件**例如：用户登录和SQL记录。**@paramstring$message*@paramarray$context*@returnnull*/publicfunctioninfo($message,array$context=array());/***debug详情**@paramstring$message*@paramarray$context*@returnnull*/publicfunctiondebug($message,array$context=array());/***任意等级的日志记录**@parammixed$level*@paramstring$message*@paramarray$context*@returnnull*/publicfunctionlog($level,$message,array$context=array());}
Psr\Log\LoggerAwareInterface
?phpnamespacePsr\Log;/***logger-aware定义实例*/interfaceLoggerAwareInterface{/***设置一个日志记录实例**@paramLoggerInterface$logger*@returnnull*/publicfunctionsetLogger(LoggerInterface$logger);}
Psr\Log\LogLevel
?phpnamespacePsr\Log;/***日志等级常量定义*/classLogLevel{constEMERGENCY='emergency';constALERT='alert';constCRITICAL='critical';constERROR='error';constWARNING='warning';constNOTICE='notice';constINFO='info';constDEBUG='debug';}
Autoloader1.概述本PSR是关于由文件路径自动载入对应类的相关规范，本规范是可互操作的，可以作为任一自动载入规范的补充，其中包括PSR-0，此外，本PSR还包括自动载入的类对应的文件存放路径规范。
此处的“类”泛指所有的class类、接口、traits可复用代码块以及其它类似结构。
一个完整的类名需具有以下结构:
\命名空间(\子命名空间)*\类名
完整的类名必须要有一个顶级命名空间，被称为"vornamespace"；
完整的类名可以有一个或多个子命名空间；
完整的类名必须有一个最终的类名；
完整的类名中任意一部分中的下划线都是没有特殊含义的；
完整的类名可以由任意大小写字母组成；
所有类名都必须是大小写敏感的。
当根据完整的类名载入相应的文件……
完整的类名中，去掉最前面的命名空间分隔符，前面连续的一个或多个命名空间和子命名空间，作为“命名空间前缀”，其必须与至少一个“文件基目录”相对应；
紧接命名空间前缀后的子命名空间必须与相应的”文件基目录“相匹配，其中的命名空间分隔符将作为目录分隔符。
末尾的类名必须与对应的以.php为后缀的文件同名。
自动加载器（autoloader）的实现一定不能抛出异常、一定不能触发任一级别的错误信息以及不应该有返回值。
下表展示了符合规范完整类名、命名空间前缀和文件基目录所对应的文件路径。
无法复制加载中的内容
关于本规范的实现，可参阅相关实例
注意：实例并不属于规范的一部分，且随时会有所变动。
参考：
PHP项目体检工具，根据你设定的标准（如单一文件代码体积，未使用的参数个数，未使用的方法数）检查PHP代码，超出警。
顾名思义，检查冗余代码的
看名字就知道了，检查从未被调用过的方法
老牌代码格式化工具，PHP写的，Pear包，可自己hack，可集成到命令行里。
你还可以用jenkins把上述工具以plugins形式整合起来，做持续集成：
你还可以用xinc+phing跟上述工具集成起来做持续集成后的自动化打包发布：
版权声明：本站所有作品（图文、音视频）均由用户自行上传分享，仅供网友学习交流，不声明或保证其内容的正确性，如发现本站有涉嫌抄袭侵权/违法违规的内容。请举报，一经查实，本站将立刻删除。