PHP PSR-1 基本代码规范(中文版)
2016-03-21 09:17
561 查看
原文传送门:PizzaLiu
本篇规范制定了代码基本元素的相关标准, 以确保共享的PHP代码间具有较高程度的技术互通性。
关键词 “必须”("MUST")、“一定不可/一定不能”("MUST NOT")、“需要”("REQUIRED")、 “将会”("SHALL")、“不会”("SHALL NOT")、“应该”("SHOULD")、“不该”("SHOULD NOT")、 “推荐”("RECOMMENDED")、“可以”("MAY")和”可选“("OPTIONAL")的详细描述可参见 RFC
2119 。
PHP代码文件必须以
PHP代码文件必须以
PHP代码中应该只定义类、函数、常量等声明,或其他会产生
命名空间以及类必须符合 PSR 的自动加载规范:PSR-0 或 PSR-4 中的一个;
类的命名必须遵循
类中的常量所有字母都必须大写,单词间用下划线分隔;
方法名称必须符合
PHP代码必须使用
PHP代码必须且只可使用
一份PHP文件中应该要不就只定义新的声明,如类、函数或常量等不产生从属效应的操作,要不就只有会产生从属效应的逻辑操作,但不该同时具有两者。
“从属效应”(side effects)一词的意思是,仅仅通过包含文件,不直接声明类、 函数和常量等,而执行的逻辑操作。
“从属效应”包含却不仅限于:生成输出、直接的
ini 配置、抛出错误或异常、修改全局或静态变量、读或写文件等。
以下是一个反例,一份包含声明以及产生从属效应的代码:
下面是一个范例,一份只包含声明不产生从属效应的代码:
命名空间以及类的命名必须遵循 PSR-0.
根据规范,每个类都独立为一个文件,且命名空间至少有一个层次:顶级的组织名称(vendor name)。
类的命名必须 遵循
PHP 5.3及以后版本的代码必须使用正式的命名空间。
例如:
5.2.x及之前的版本应该使用伪命名空间的写法,约定俗成使用顶级的组织名称(vendor name)如
此处的“类”指代所有的类、接口以及可复用代码块(traits)
类的常量中所有字母都必须大写,词间以下划线分隔。 参照以下代码:
类的属性命名可以遵循 大写开头的驼峰式 (
又或者是 下划线分隔式 (
方法名称必须符合
基本代码规范
本篇规范制定了代码基本元素的相关标准, 以确保共享的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.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() { // 函数主体部分 }
下面是一个范例,一份只包含声明不产生从属效应的代码:
<?php // 声明函数 function foo() { // 函数主体部分 } // 条件声明**不**属于从属效应 if (! function_exists('bar')) { function bar() { // 函数主体部分 } }
3.
命名空间和类
命名空间以及类的命名必须遵循 PSR-0.根据规范,每个类都独立为一个文件,且命名空间至少有一个层次:顶级的组织名称(vendor name)。
类的命名必须 遵循
StudlyCaps大写开头的驼峰命名规范。
PHP 5.3及以后版本的代码必须使用正式的命名空间。
例如:
<?php // PHP 5.3及以后版本的写法 namespace Vendor\Model; class Foo { }
5.2.x及之前的版本应该使用伪命名空间的写法,约定俗成使用顶级的组织名称(vendor name)如
Vendor_为类前缀。
<?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()式的小写开头驼峰命名规范。
相关文章推荐
- Laravel 调试利器 —— Laravel Debugbar 扩展包安装及使用教程(转)
- PHP常见数组函数用法小结
- PHP 数组
- PHP面向对象的程序设计
- thinkPHP的D方法和M方法用法和区别
- laravel的模块化是如何实现的
- PHP常见数组函数用法小结
- PHP函数checkdnsrr用法详解(Windows平台用法)
- Zend Framework教程之Zend_Db_Table用法详解
- Zend Framework教程之Zend_Db_Table_Row用法实例分析
- Zend Framework框架教程之Zend_Db_Table_Rowset用法实例分析
- Zend Framework教程之连接数据库并执行增删查的方法(附demo源码下载)
- Zend Framework入门之环境配置及第一个Hello World示例(附demo源码下载)
- Zend Framework实现多文件上传功能实例
- Zend Framework教程之Zend_Form组件实现表单提交并显示错误提示的方法
- Zend Framework框架之Zend_Mail实现发送Email邮件验证功能及解决标题乱码的方法
- PHP的Laravel框架中使用消息队列queue及异步队列的方法
- PHP编程中尝试程序并发的几种方式总结
- PHP程序中的文件锁、互斥锁、读写锁使用技巧解析
- 调用WordPress函数统计文章访问量及PHP原生计数器的实现