首页 / PHP / FIG-PHPPSR规范系列1-基础编码规范

FIG-PHPPSR规范系列1-基础编码规范

内容导读

互联网集市收集整理的这篇技术教程文章主要介绍了FIG-PHPPSR规范系列1-基础编码规范，小编现在分享给大家，供广大互联网技能从业者学习和参考。文章包含4796字，纯文字阅读大概需要7分钟。

内容图文

1. FIG-PHP与PSR简介

FIG-PHP制定了一系列PHP开发规范，简称PSR，这里FIG是框架互操作工作组（Framework Interoperability Group）的简称，PSR是PHP标准推荐（PHP Standard Recommendation）的缩写。FIG-PHP工作组最初是源于项目代表讨论两个项目之间的共性时，找出可以共事的方式。主要的受众是双方项目组，但PHP界的其他人也在观望。如果其他人愿意采用这里的规范，那么欢迎，但这并非工作组的目标。工作组中没人会告诉你如何来建造应用。

截止到2015.07, PSR共有五个规范文档发布，分别是：

PSR-0 自动加载（2014.10.21被废弃，替代规范为PSR-4）

PSR-1 基础编码规范

PSR-2 编码风格

PSR-3 日志接口

PSR-4 改进的自动加载

PSR-7 HTTP消息接口

下面将分多个系列来学习这些规范, 本文档是系列1。

2. PSR-1: 基础编码规范

本规范讨论一些基础的代码规范，以便将来代码共享时不同代码之间能有更高程度的技术互操作。

本规范中的必须(MUST)，不可(MUST NOT)，应当(SHOULD)，不应当(SHOULD NOT)，可以/可能(MAY)等关键词的含义可参见RFC 2119。

2.1 概述

源文件必须（MUST）只使用

源文件中php代码的编码格式必须（MUST）只使用不带字节顺序标记(BOM)的UTF-8。备注：更多BOM资料可参见参考资料[BOM]。

一个源文件建议只用来做声明（类(class)，函数(function)，常量(constant)等）或者只用来做一些辅助作用的操作（例如：输出信息，修改.ini配置等）,但不应当（SHOULD NOT）同时做这两件事。

命名空间(namespace)和类(class) 必须遵循一种PSR自动加载规范: PSR-0或PSR-4。（译者注：由于PSR-0已经被废弃，因此这里事实上等同于必须遵循PSR-4规范。）

类名(class name) 必须使用StudlyCaps写法。

（译者注：参见参考资料[StudlyCaps]， StudlyCaps是一种大小写字母可任意变化，其中一些字母可被忽略的一种写法。例如消息可能隐藏在大写字母与小写字母中，例如"ShoEboX"大写字母可拼出"SEX", 小写祖母可拼出"hobo", webmail服务商Hotmail最初被写为HoTMaiL, 大写字母可拼出HTML。）

类(class)中的常量必须只由大写字母和下划线(_)组成。

方法名(method name) 必须使用camelCase（驼峰式)写法。

2.2 文件

2.2.1 PHP标签

PHP代码必须只使用长标签()或者短输出式标签()；而不可使用其他标签。

2.2.2 字符编码

PHP代码的编码格式必须只使用不带字节顺序标记(BOM)的UTF-8。

2.2.3 辅助作用

一个源文件建议只用来做声明（类(class)，函数(function)，常量(constant)等）或者只用来做一些辅助作用的操作（例如：输出信息，修改.ini配置等）,但不建议同时做这两件事。

短语辅助作用(side effects)的意思是与声明（类(class)，函数(function)，常量(constant)等）没有直接关系的一些执行逻辑。

（译者注：[PSR-1-翻译1]中将side effects翻译为副作用，[PSR-1-翻译2]中翻译为从属效应 , 都感觉不知所云，这里翻译为辅助作用应当更好）。

（译者注：原文中的merely from including the file没有弄清楚是什么意思，留待以后确认）。

辅助作用包含但不局限于：产生输出，显式地使用require或include，连接外部服务，修改ini配置，触发错误或异常，修改全局或者静态变量，读取或修改文件等等。

下面是一个既包含声明又有辅助作用的示例文件；即应避免的例子：

<?php// 副作用：修改了ini配置ini_set('error_reporting', E_ALL);// 副作用：载入了文件include "file.php";// 副作用：产生了

输出echo "\n";// 声明function foo(){ // 函数体}

下面是一个仅包含声明的示例文件；即应提倡的例子：

<?php// 声明function foo(){    // 函数体}// 条件式声明不算做是辅助作用if (! function_exists('bar')) {    function bar()    {        // 函数体    }}

2.3 空间名(namespace)和类名(class name)

命名空间(namespace)和类(class)必须遵循一种自动加载规范PSR-0或PSR-4.

这意味着一个源文件中只能有一个类(class)，并且在命名空间中至少要有一级：即一个顶级的组织名(vendor name)。

类名(class name) 必须使用StudlyCaps写法。

PHP5.3之后的代码必须使用正式的命名空间(namespace)

例子：

<?php// PHP 5.3 及之后:namespace Vendor\Model;class Foo{}

PHP5.2.x之前的代码建议用伪命名空间Vendor_作为类名(class name)的前缀

<?php// PHP 5.2.x 及之前:class Vendor_Model_Foo{}

2.4 类的常量、属性和方法

术语类(class)指所有的类(class)，接口(interface)和trait。

2.4.1 常量

类常量必须（MUST）只由大写字母和下划线(_)组成。例子：

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

2.4.2 属性

类的属性命名可以遵循$StulyCaps，$camelCase或者$under_score中的某一种风格，本规范不做强制要求，但无论遵循哪种命名方式，都应当（SHOULD）在一定的范围内保持一致。这个范围可以是整个团队、整个包、整个类或整个方法。

2.4.3 方法

方法名必须（MUST）使用camelCase风格来声明。

3. 参考资料

[BOM] 一个bom头引发的血案,

[PHP-FIG] php-fig, http://www.php-fig.org/

[PSR-1-翻译1] PSR-1基本代码规范, https://github.com/hfcorriez/fig-standards/blob/zh_CN/%E6%8E%A5%E5%8F%97/PSR-1-basic-coding-standard.md

[PSR-1-翻译2] PHP PSR-1 基本代码规范(中文版), http://segmentfault.com/a/1190000002521577

[PSR-4] FIG-PHP PSR规范系列4-自动加载,

[RFC2119] Key words for use in RFCs to Indicate Requirement Levels, March 1997, http://www.ietf.org/rfc/rfc2119.txt

[RFC2119-阮一峰] RFC2119：表示要求的动词, http://www.ruanyifeng.com/blog/2007/03/rfc2119.html

[StudlyCaps] Studly caps, https://en.wikipedia.org/wiki/Studly_caps

内容总结

以上是互联网集市为您收集整理的FIG-PHPPSR规范系列1-基础编码规范全部内容，希望文章能够帮你解决FIG-PHPPSR规范系列1-基础编码规范所遇到的程序开发问题。如果觉得互联网集市技术教程内容还不错，欢迎将互联网集市网站推荐给程序员好友。

内容备注

版权声明：本文内容由互联网用户自发贡献，该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容，请发送邮件至 gblab@vip.qq.com 举报，一经查实，本站将立刻删除。

内容手机端

扫描二维码推送至手机访问。

本文链接：https://qyyshop.com/info/203550.html

来源：【匿名】

【上一篇】PHP生成的session，可以在jsp页面获取吗？【下一篇】PHP 5 数据对象 (PDO) 抽象层与 Oracle

更多 ►

【FIG-PHPPSR规范系列1-基础编码规范】教程文章相关的互联网学习教程文章

PHP编码规范

1.文件格式所有php文件使用完整的php标签，如<?php ？>纯php代码文件，末尾不需要写 ?>2.文件和目录命名程序文件名和目录名均采用有意义的英文命名类统一采用：DemoTest.class.php接口统一采用：DemoTest.interface.php其他按照各自的方式：demoTest.{style}.php其他一些文件按照：demoTest.inc.php zend/demo.lib.php3.文件目录结构app　　独立的应用class 单个的类文件，...

php设计模式一之命名空间、自动加载类、PSR-0编码规范

本篇文章介绍的内容是php设计模式一之命名空间、自动加载类、PSR-0编码规范，现在分享给大家，有需要的朋友可以参考一下一、命名空间：解决在生产环境中多人协同开发时出现类名或函数名冲突的问题；test1.php<?php namespace Test1; function test(){echo "Test1命名空间下的test()方法"; } ?>test2.php<?php namespace Test2; function test(){echo "Test2命名空间下的test()方法"; } ?>test.php<?php require_once(test1.php); ...

PHP编码规范之注释和文件结构说明

php编码规范有哪些？【图】

为什么需要编码规范？为了提高工作效率，保证开发的有效性和合理性。为了提高代码可读性和可重复利用性，从而节约沟通成本。php编码规范1、文件格式　●　所有php文件使用完整的php标签，如<?php ？>　●　纯php代码文件，末尾不需要写 ?>2、文件和目录命名　●　程序文件名和目录名均采用有意义的英文命名　●　类统一采用：DemoTest.class.php　●　接口统一采用：DemoTest.interface.php　●　其他按照各自的方式：demoTest.{st...

http://67.220.92.14/forum/inde讲的非常不错的PHP编码规范第1/3页

注：这是从PHPCMS开发文档里看到编码规范，虽名为PHPCMS的开发规范，但我觉得所有的PHP编程都该如此。写了那么多PHP，很多编码对照这规范都感觉欠缺很多，今后一定要对照纠正。 Phpcms 编码规范 1. 引言…. 2 2. 适用范围…. 2 3. 标准化的重要性和好处…. 3 4. PHP编码规范与原则…. 3 4.1. 代码标记… 3 4.2. 注释… 3 4.3. 书写规则… 4 4.3.1. 缩进… 4 4.3.2. 大括号{}、if和switch. 4 4.3.3. 运算符、小括号、空格、关键词和...

PHP的编码规范

本篇文章给大家分享了关于PHP的编码规，很实用，有需要的朋友可以用来参考一下文件名：类：DemoTest.class.php接口：DemoTest.interface.php其他：demoTest.{style}.php命名规范：整体采用驼峰命名法，同时命名要有意义。全局变量：两边使用"_"，中间采用驼峰命名法常量：全大写普通变量/类属性：驼峰命名法，可以在前面加上表示变量类型的缩写,要采用准确有意义的英文单词：字符串： $sMyName数组： $arrMyArray接口及类的命名：驼...

新手PHP编码规范及建议

想要当一名出色的程序员，一手好的代码规范是很重要的，那么如何才能写出一手好代码呢？本文我们就给大家一些PHP 编码规范及建议。编码规范PHP代码文件必须以 <?php 标签开始。<?php //开头// 不结尾 PHP代码文件必须以不带BOM的UTF-8编码。例sublime, setting增加，"show_encoding" : true 每行的字符数不超过 80 个字符例，sublime "word_wrap": "true", "wrap_width": 80, tap键4个空格例，sublime "tab_size": 4, PHP代码中应该...

php关于编码规范的文档（收藏）

为了提高工作效率，保证开发的有效性和合理性，并最大程度提高程序代码的可读性和可重复利用性，提高沟通效率，需要一份代码编写规范。让大家养成良好的代码编写习惯，同时减少代码中的bug。 CleverCode整理了一些规范。本规范包含PHP开发时程序编码中命名规范、代码缩进规则、控制结构、函数调用、函数定义、注释、包含代码、PHP标记、常最命名等方面的规则。1 文件格式1.1 文件标记所有PHP文件，其代码标记均使用完整PHP标签...

PHP推荐标准PSRphp程序编码规范标准php标准差php网络编程标准教

PSR是PHP Standards Recommendation的简称。PSR-1：基本的代码风格PHP标签必须把PHP代码放在或标签中。不得使用其他PHP标签语法。编码所有PHP文件都必须使用UTF-8字符集编码，而且不能有字节顺序标记目的一个PHP文件可以定义符号（类、性状、函数和常量等），或者执行有副作用的操作（例如生成结果或处理数据），但不能同时做这两件事。自动加载PHP命名空间和类必须遵守PSR-4自动加载器标准。类的名称PHP类的名称必须一直使...

PHP编码规范-phpcodingstandard_PHP教程【代码】

目录介绍标准化的重要性解释认同观点项目的四个阶段命名规则合适的命名缩写词不要全部使用大写字母类命名类库命名方法命名类属性命名方法中参数命名变量命名引用变量和函数返回引用全局变量定义命名 / 全局常量静态变量函数命名 php文件扩展名文档规则评价注释 Comments Should Tell a Story Document Decisions 使用标头说明 Make Gotchas Explicit Interface and Implementation Do...

讲的非常不错的PHP编码规范第1/3页_PHP教程

PHP编码规范之注释和文件结构说明_PHP教程

PHP编码规范的深入探讨_PHP教程

缩进与空白字符（Indenting and Whitespace）使用 2 个空格而不使用 tab 键进行代码缩进（notepad++, Eclipse 等编辑器均支持此项配置）;行尾不应该有空白字符应使用 \n （Unix换行符），而不是 \r\n （Windows 换行符）所有文件均应以一个空行结尾运算符（Operators）所有二元运算符（二个值之间的运算符），如 +, -, =, !=, ==, > 等等，在运算符两端均需留有一个空格，如应该使用 $foo = $bar 而不是 $foo=$bar。所有一元运算符...

php编码规范个人小结_PHP教程

1.原生态代码或者类的头上，注明作者，关键算法计算过程例如 /** *@author zengmoumou *功能：根据列表ip，取得ip对应的运营商，省，市，县 */ 2.变量尽量用英文单词的组合，第一个小写，后面大写例如： $confTreeModel = D("ConfTree"); 3.函数名尽量用英文单词的组合，第一个小写，后面大写例如： function searchRealServer($keyword) 4.函数之上最好写名该函数的作者，变量，算法例如:/*** @author zengmoumou* 获得搜索到...

关于PHP开发编码规范_PHP教程

这是一个之前的一篇文章，感觉很好重新整理又发出来。希望能让大家有所收获。1. 介绍 1.1. 标准化的重要** 标准化问题在某些方面上让每个人头痛，让人人都觉得大家处于同样的境地。这有助于让这些建议在许多的项目中不断演进，许多公司花费了许多星期逐子字逐句的进行争论。标准化不是特殊的个人风格，它对本地改良是完全开放的。 1.2. 优点当一个项目尝试着遵守公用的标准时，会有以下好处：程序员可以了解任何代码，弄清程...

PHP - 技术教程分类

PHP 教程 PHP 简介 PHP 安装 PHP 语法 PHP 变量 PHP echo/print PHP EOF(heredoc) PHP 数据类型 PHP 类型比较 PHP 常量 PHP 字符串 PHP 运算符 PHP If...Else PHP Switch PHP 数组 PHP 数组排序 PHP 超级全局变量 PHP While 循环 PHP For 循环 PHP 函数 PHP 魔术常量 PHP 命名空间 PHP 面向对象 PHP 测验 PHP 表单 PHP 表单验证 PHP 表单 - 必需字段 PHP 完整表单实例 PHP $_GET 变量 PHP $_POST 变量 PHP 多维数组 PHP 日期 PHP 包含 PHP 文件 PHP 文件上传 PHP Cookie PHP Session PHP E-mail PHP Error PHP Exception PHP 过滤器 PHP 7 新特性 PHP MySQL 简介 PHP MySQL 连接 PHP MySQL 创建数据库 PHP MySQL 创建数据表 PHP MySQL 插入数据 PHP MySQL 插入多条数据 PHP MySQL 预处理语句 PHP MySQL 读取数据 PHP MySQL Where PHP MySQL Order By PHP MySQL Update PHP MySQL Delete PHP ODBC AJAX 简介 AJAX PHP AJAX 数据库 AJAX 实时搜索 AJAX 投票 PHP Array PHP Calendar PHP cURL PHP Date PHP Directory PHP Error PHP Filesystem PHP Filter PHP FTP PHP HTTP PHP Mail PHP Math PHP Misc PHP MySQLi PHP PDO PHP String PHP Zip PHP Timezones PHP 图像处理 PHP RESTful PHP PCRE PHP 可用的函数 PHP Composer php 全部

PHP - 最热教程

php如何取出数组的前几个元素 PHP变量什么时候释放 PHP如何实现在数据库随机获取几条记录如何解决php base64解码乱码 php主要用于哪些领域 Laravel 批量插入(insert)数据六款国内优秀免费wordpress主题推荐 React如何从后端获取数据并渲染到前端？纯PHP实现定时器任务（Timer），php实现...php该如何安装pdo_mysql扩展

首页 / PHP / FIG-PHPPSR规范系列1-基础编码规范

FIG-PHPPSR规范系列1-基础编码规范

内容导读

内容图文

2.1 概述

2.2 文件

2.2.1 PHP标签

2.2.2 字符编码

2.2.3 辅助作用

2.3 空间名(namespace)和类名(class name)

2.4 类的常量、属性和方法

2.4.1 常量

2.4.2 属性

2.4.3 方法

内容总结

内容备注

内容手机端

【FIG-PHPPSR规范系列1-基础编码规范】教程文章相关的互联网学习教程文章

PHP编码规范

php设计模式一之命名空间、自动加载类、PSR-0编码规范

PHP编码规范之注释和文件结构说明

php编码规范有哪些？【图】

http://67.220.92.14/forum/inde讲的非常不错的PHP编码规范第1/3页

PHP的编码规范

新手PHP编码规范及建议

php关于编码规范的文档（收藏）

PHP推荐标准PSRphp程序编码规范标准php标准差php网络编程标准教

PHP编码规范-phpcodingstandard_PHP教程【代码】

讲的非常不错的PHP编码规范第1/3页_PHP教程

PHP编码规范之注释和文件结构说明_PHP教程

PHP编码规范的深入探讨_PHP教程

php编码规范个人小结_PHP教程

关于PHP开发编码规范_PHP教程

PHP - 相关标签

PHP - 技术教程分类

PHP - 最新教程

PHP - 最热教程