这一部分标准包括,哪些应该被认为是标准的编码元素,以确保共享的PHP代码间具有较高程度的技术互通性。
关键词“必须”(“MUST”)、“一定不可/一定不能”(“MUST NOT”)、“需要”(“REQUIRED”)、
“将会”(“SHALL”)、“不会”(“SHALL NOT”)、“应该”(“SHOULD”)、“不该”(“SHOULD NOT”)、
“推荐”(“RECOMMENDED”)、“可以”(“MAY”)和”可选“(“OPTIONAL”)的详细描述可参见 RFC 2119
1.概览
- PHP文件必须只使用
<?php
和<?
这两种标签。 - PHP文件必须以不带BOM的UTF-8编码。
- PHP文件中应该只定义类、函数、常量等声明,或其他会产生从属效应 的操作(如:生成文件输出以及修改.ini配置文件等),但是不应该同时做着两件事情。
- 命名空间以及类必须符合 PSR 的自动加载规范:PSR-0 或 PSR-4 中的一个;
- 类的命名必须遵循以大写开头的驼峰命名规则(
StudlyCaps
)。 - 类中的常量所有字母都必须大写,单词间用下划线分隔。
- 方法名必须符合以小写开头的驼峰命名法(
camelCase
)。
2.文件
2.1PHP标签
PHP代码必须使用<?php ?>
长标签或<?= ?>
短标签输出。一定不能使用其他标签。
2.2字符编码
PHP代码必须只可使用不带BOM的UFT-8编码
2.3从属效应(副作用)
一个文件应该要不就只定义声明(类,函数,常亮等),要不就只有产生从属效应的逻辑操作,但不应该两者都有。
短语“副作用”(side effects)意味着执行的逻辑仅仅从包含文件,而没有直接关系到声明类,函数,常量等。
“从属效应”包含却不仅限于:生成输出、直接的 require 或 include、连接外部服务、修改 ini 配置、抛出错误或异常、修改全局或静态变量、读或写文件等。
下面是一个同时拥有声明和从属效应的例子,应该避免:
<?php
// side effect: change ini settings
ini_set(‘error_reporting‘, E_ALL);
// side effect: loads a file
include "file.php";
// side effect: generates output
echo "<html>\n";
// declaration
function foo()
{
// function body
}
下面是一个只包含声明而没有包含side effects
的例子,应该被模仿:
<?php
// declaration
function foo()
{
// function body
}
// conditional declaration is *not* a side effect
if (! function_exists(‘bar‘)) {
function bar()
{
// function body
}
}
3.命名空间和类
命名空间Namespace
和类class
必须 遵循”autoloading
” PSR标准: [PSR-0, PSR-4].
这就意味着每一个类必须独立为一个属于他自己的文件,且命名空间至少有一个层次:顶级的组织名称(vendor name)。
类的命名必须遵循以大写开头的驼峰命名规则(StudlyCaps
)。
PHP5.3及以后的必须用正式的命名空间。
例如:
<?php
// PHP 5.3 and later:
namespace Vendor\Model;
class Foo
{
}
5.2.x及之前的版本应该使用以Vendor_
为类名前缀的 伪命名空间的写法
<?php
// PHP 5.2.x and earlier:
class Vendor_Model_Foo
{
}
4.类的常量、属性和方法
此处的“类”指代所有的类、接口以及可复用代码块(traits)
译者注:trait在PHP5.4中泛指所有能被重复使用的函式。 http://php.net/manual/en/language.oop5.traits.php
4.1常量
类的常量必须所有字母全部大写,用下划线分隔。
例如:
<?php
namespace Vendor\Model;
class Foo
{
const VERSION = ‘1.0‘;
const DATE_APPROVED = ‘2012-06-01‘;
}
4.2属性
类的属性命名可以遵循 大写开头的驼峰式 ($StudlyCaps
)、小写开头的驼峰式 ($camelCase
) 又或者是 下划线分隔式 ($under_score
),本规范不做强制要求,但无论遵循哪种命名方式,都应该在一定的范围内保持一致。这个范围可以是整个团队、整个包、整个类或整个方法。
4.3方法
方法名必须符合以小写开头的驼峰命名法(camelCase()
)。