PHP PSR-1 基本代码规范 -php教程-PHP中文网

首页

后端开发

php教程

PHP PSR-1 基本代码规范

WBOYWBOYWBOYWBOYWBOYWBOYWBOYWBOYWBOYWBOYWBOYWBOYWB

Jul 23, 2016 am 08:54 AM

基本代码规范

本篇规范制定了代码基本元素的相关标准，
以确保共享的php代码间具有较高程度的技术互通性。

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

概览

PHP代码文件必须以

PHP代码文件必须以不带BOM的 UTF-8 编码；

PHP代码中应该只定义类、函数、常量等声明，或其他会产生从属效应的操作（如：生成文件输出以及修改.ini配置文件等），二者只能选其一；

命名空间以及类必须符合 PSR 的自动加载规范：PSR-0[] 中的一个；

类的命名必须遵循 StudlyCaps 大写开头的驼峰命名规范；

类中的常量所有字母都必须大写，单词间用下划线分隔；

方法名称必须符合 camelCase 式的小写开头驼峰命名规范。

文件

2.1. PHP标签

PHP代码必须使用长标签或 = ?> 短输出标签；
一定不可使用其它自定义标签。

2.2. 字符编码

PHP代码必须且只可使用不带BOM的UTF-8编码。

2.3. 从属效应（副作用）

一份PHP文件中应该要不就只定义新的声明，如类、函数或常量等不产生从属效应的操作，要不就只有会产生从属效应的逻辑操作，但不该同时具有两者。

“从属效应”(side effects)一词的意思是，仅仅通过包含文件，不直接声明类、
函数和常量等，而执行的逻辑操作。

“从属效应”包含却不仅限于：生成输出、直接的 require 或 include、连接外部服务、修改 ini 配置、抛出错误或异常、修改全局或静态变量、读或写文件等。

以下是一个反例，一份包含声明以及产生从属效应的代码：

// 从属效应：修改 ini 配置
ini_set('error_reporting', E_ALL);
// 从属效应：引入文件
include "file.php";
// 从属效应：生成输出
echo "\n";
// 声明函数
function foo()
{
// 函数主体部分
}

复制代码

下面是一个范例，一份只包含声明不产生从属效应的代码：

// 声明函数
function foo()
{
// 函数主体部分
}
// 条件声明**不**属于从属效应
if (! function_exists('bar')) {
function bar()
{
// 函数主体部分
}
}

复制代码

命名空间和类

命名空间以及类的命名必须遵循 [PSR-0][].

根据规范，每个类都独立为一个文件，且命名空间至少有一个层次：顶级的组织名称（vendor name）。

类的命名必须遵循 StudlyCaps 大写开头的驼峰命名规范。

PHP 5.3及以后版本的代码必须使用正式的命名空间。

例如：

// PHP 5.3及以后版本的写法
namespace Vendor\Model;
class Foo
{
}

复制代码

5.2.x及之前的版本应该使用伪命名空间的写法，约定俗成使用顶级的组织名称（vendor name）如 Vendor_ 为类前缀。

// 5.2.x及之前版本的写法
class Vendor_Model_Foo
{
}

复制代码

类的常量、属性和方法

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

4.1. 常量

类的常量中所有字母都必须大写，词间以下划线分隔。
参照以下代码：

namespace Vendor\Model;
class Foo
{
const VERSION = '1.0';
const DATE_APPROVED = '2012-06-01';
}

复制代码

4.2. 属性

类的属性命名可以遵循大写开头的驼峰式 ($StudlyCaps)、小写开头的驼峰式 ($camelCase) 又或者是下划线分隔式 ($under_score)，本规范不做强制要求，但无论遵循哪种命名方式，都应该在一定的范围内保持一致。这个范围可以是整个团队、整个包、整个类或整个方法。

4.3. 方法

方法名称必须符合 camelCase() 式的小写开头驼峰命名规范。

转自Github(PizzaLiu)

PHP, PSR

本站声明

本文内容由网友自发贡献，版权归原作者所有，本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容，请联系admin@php.cn

热AI工具

热工具

热门话题

gmail邮箱登陆入口在哪里

7355

Java教程

1628

CakePHP 教程

1353

Laravel 教程

1265

PHP教程

1214

显示更多

Related knowledge

11个最佳PHP URL缩短脚本（免费和高级） Mar 03, 2025 am 10:49 AM

长URL（通常用关键字和跟踪参数都混乱）可以阻止访问者。 URL缩短脚本提供了解决方案，创建了简洁的链接，非常适合社交媒体和其他平台。这些脚本对于单个网站很有价值

在Laravel中使用Flash会话数据 Mar 12, 2025 pm 05:08 PM

Laravel使用其直观的闪存方法简化了处理临时会话数据。这非常适合在您的应用程序中显示简短的消息，警报或通知。默认情况下，数据仅针对后续请求： $请求 -

构建具有Laravel后端的React应用程序：第2部分，React Mar 04, 2025 am 09:33 AM

这是有关用Laravel后端构建React应用程序的系列的第二个也是最后一部分。在该系列的第一部分中，我们使用Laravel为基本的产品上市应用程序创建了一个RESTFUL API。在本教程中，我们将成为开发人员

简化的HTTP响应在Laravel测试中模拟了 Mar 12, 2025 pm 05:09 PM

Laravel 提供简洁的 HTTP 响应模拟语法，简化了 HTTP 交互测试。这种方法显着减少了代码冗余，同时使您的测试模拟更直观。基本实现提供了多种响应类型快捷方式： use Illuminate\Support\Facades\Http; Http::fake([ 'google.com' => 'Hello World', 'github.com' => ['foo' => 'bar'], 'forge.laravel.com' =>