PSR-1 基础编码规范

最新推荐文章于 2024-11-08 12:34:34 发布

金九亿joey

最新推荐文章于 2024-11-08 12:34:34 发布

阅读量201

点赞数

分类专栏： PSR标准规范文章标签： php

原文链接：https://learnku.com/docs/psr/basic-coding-standard/1605

版权

PSR标准规范专栏收录该内容

2 篇文章 0 订阅

订阅专栏

基本代码规范

本篇规范制定了代码基本元素的相关标准，以确保共享的 PHP 代码间具有较高程度的技术互通性。
本文件中的 必须，不得，需要，应，不应，应该，不应该，推荐，可能和可选等能愿动词按照 RFC 2119 中的描述进行解释。

1. 概览

PHP 代码文件必须以 <?php 或 <?= 标签开始；
PHP 代码文件必须以不带 BOM 的 UTF-8 编码；
PHP 代码中应该只定义类、函数、常量等声明，或其他会产生副作用的操作（如：生成文件输出以及修改 .ini 配置文件等），二者只能选其一；
命名空间以及类必须符合 PSR 的自动加载规范： [PSR-0（已废弃）或 PSR-4] 中的一个。
类的命名必须遵循 StudlyCaps 大写开头的驼峰命名规范；
类中的常量所有字母都必须大写，单词间用下划线分隔；
方法名称必须符合 camelCase 式的小写开头驼峰命名规范。

2. 文件

2.1. PHP 标签

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

2.2. 字符集编码

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

2.3. 副作用

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

「副作用」(side effects) 一词的意思是，仅仅通过包含文件，不直接声明类、函数和常量等，而执行的逻辑操作。

「副作用」包含却不仅限于：生成输出，明确使用 require 或 include，连接到外部服务，修改 ini 设置，发出错误或异常，修改全局或静态变量，读取或写入一个文件，等等。

以下是一个反例，一份包含「函数声明」以及产生「副作用」的代码：

<?php
// 「副作用」：修改 ini 配置
ini_set('error_reporting', E_ALL);

// 「副作用」：引入文件
include "file.php";

// 「副作用」：生成输出
echo "<html>\n";

// 声明函数
function foo()
{
    // function body
}

下面是一个范例，一份只包含声明不产生「副作用」的代码：

<?php
// 声明函数
function foo()
{
    // 函数主体部分
}

// 条件声明 **不** 属于「副作用」
if (! function_exists('bar')) {
    function bar()
    {
        // 函数主体部分
    }
}

3. 命名空间和类名

命名空间和类名必须遵循『自动加载』规范： [PSR-0， PSR-4]。

这意味着每个类都独立为一个文件，并且至少在一个层次的命名空间内，那就是：顶级组织名（vendor name）。

类名必须以类似 StudlyCaps 形式的大写开头的驼峰命名方式声明。

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

举个例子：

<?php
// PHP 5.3 及更高版本：
namespace Vendor\Model;

class Foo
{
}

PHP 5.2 及更低版本应该使用伪命名空间，约定俗成，以顶级组织名称 Vendor_ 为类名前缀：

<?php
// PHP 5.2.x 及更低版本：
class Vendor_Model_Foo
{
}

4. 类的常量、属性和方法

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

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() 式的小写开头驼峰命名规范。

————————————————
原文作者：PHP 技术论坛文档：《PHP PSR 标准规范（）》
转自链接：https://learnku.com/docs/psr/basic-coding-standard/1605
版权声明：翻译文档著作权归译者和 LearnKu 社区所有。转载请保留原文链接