资讯专栏INFORMATION COLUMN

PHP规范之PSR-1

stormjun / 764人阅读

摘要:命名空间需要遵循自动加载规范。和之后的版本必须使用规范的命名空间。这三种类型都要遵守以下规范常量类常量必须由大写字母组成,单词间由下划线组成。一旦使用了其中的某一项命名凡是,应该在一定的代码内保持一致库,包,类,或者方法范围内。

基本编码规范

此PHP标准包含了如何去编写高通用性代码中那些标准元素(class,function ,ect.)的正确姿势!
在RFC 2119文档中描述了关键字 “MUST”,“MUST NOT”,“SHALL”,“SHALL”,“SHALL NOT”,“SHOULD”,“SHOULD NOT”,“RECOMMENDED”,“MAY”,“OPTIONAL”。

1.总览

文件必须使用标签打头。

文件编码必须使用UTF-8 无BOM头的格式。

文件可声明类,方法,常量,或者引发“副作用”(输出语句,改变PHP.ini的代码,etc.),但是不应该同时包含着两项。

命名空间需要遵循自动加载规范:PSR-0,PSR-4。

类名必须为StudlyCaps格式(首字母大写的驼峰式)。

常量必须要由大写字母组成,单词间使用下划线(_)连接。

方法必须要使用camelCase格式(首字母小的的驼峰式)

文件 2.1 PHP标签

PHP代码必须写在或者简短声明(php.ini中short_open_tag为On的情况下,不推荐),不能使用其他标签。

2.2编码格式

PHP代码必须使用UTF-8无BOM头的格式保存。

2.3 副作用

一个文件可以声明类,方法,常量等,也可以执行那些"副作用"逻辑,但是不能同时做着两件事!
“副作用”这个词代表这个文件执行了跟此文件中声明的类,方法,常量没有直接联系的逻辑。
“副作用”包含:产生输出,直接使用requireinclude包含文件,连接外部服务,修改php.ini中的设置,引发错误或异常,修改全局或静态变量,读写文件等等。
下面这个例子就是一个文件同时包含声明和“副作用”


";

// declaration
function foo()
{
    // function body
}

下面这个例子只包括声明,没有“副作用”


命名空间和类名

命名空间和类命名必须遵循一项自动加载规范:PSR-0或PSR-4。
这表示一个文件只能有一个类,并且这个类只有有一层命名空间:顶层空间为开发商名
类名必须声明为StudlyCaps(首字母大写的驼峰式)。
PHP5.3和之后的版本必须使用规范的命名空间。
例子:


PHP5.2.x 和之前的版本应该使用由Vendor_+类名的形式声明类,作为虚拟命名空间。


4 类常量,属性,方法

这里的类指 Classes,interfaces,traits。这三种类型都要遵守以下规范

4.1 常量

类常量必须由大写字母组成,单词间由下划线组成。例:


4.2 属性

属性名可以使用$StudlyCaps(大写字母开头的驼峰式), $camelCase(小写字母开头的驼峰式), $under_score(下线线作为分隔符的命名)。一旦使用了其中的某一项命名凡是,应该在一定的代码内保持一致(库,包,类,或者方法范围内)。

4.3 方法

方法必须被声明为camelCase(小写字母打头的驼峰似)。

其他

原文PSR-1-basic-coding-standard.md

PHP之道

注:本文非标准翻译

文章版权归作者所有,未经允许请勿转载,若此文章存在违规行为,您可以联系管理员删除。

转载请注明本文地址:https://www.ucloud.cn/yun/21507.html

相关文章

  • PHP 规范PSR规范

    摘要:参考自动加载已废弃基本代码规范代码样式日志接口如何指定文件路径从而自动加载类定义基本代码规范本篇规范制定了代码基本元素的相关标准,以确保共享的代码间具有较高程度的技术互通性。 概述 PSR 不是PHP官方标准,而是从如Zend、Symfony2等知名PHP项目中提炼出来的一系列标准,目前有越来越多的社区项目加入并遵循该标准。 参考:http://psr.phphub.org/ PSR-...

    BothEyes1993 评论0 收藏0
  • PHP-PSR 现代PHPer的开发规范

    摘要:的使命是实现框架之间的互操作性。个人和官方都认为开发者应该遵循更为严格的代码标准,在现代的生态系统中,风格统一,可以更好的让其他开发者理解代码。记录的消息用于诊断检查和排除应用中的操作稳定性和性能方面的问题。 原文是在我自己博客中,小伙伴也可以点阅读原文进行跳转查看,还有好听的背景音乐噢~     PSR是PHP Standards Recommendation的简称,意为PHP推荐标...

    zebrayoung 评论0 收藏0
  • PHP最佳实践系列标准

    摘要:框架之间通过接口自动加载和标准的编码风格进行合作。该规范的精髓是把命名空间的前缀和系统中的目录对应起来。 PHP-FIG 1).即PHP Framework Interop Group。这个组织发布推荐的规范,而不是强制规范。2).PHP-FIG的使命是实现框架的互操作性。框架的互操作性指的是通过自动加载机制、接口和标准的风格,让框架互相合作。3).框架之间通过接口、自动加载和标准的编...

    DoINsiSt 评论0 收藏0
  • 途牛原创|大话权限中心的PHP架构

    摘要:权限中心的依赖声明声明依赖关系检查代码规范声明开发依赖命名空间检查代码规范,执行单元测试。单元测试持续交付一切都如此的完美,没有测试,又如何可以证明这件事情的完美,又如何可以保障交付的质量。 序 权限管理是无线运营系统中的核心模块,通过访问控制策略的配置,来约定人与资源的访问关系。 本文着重讲解如何通过PHP来构建一个灵活、通用、安全的权限管理系统。 关于权限 首先我们来聊聊权限。 权...

    miracledan 评论0 收藏0
  • PHP 标准规范

    摘要:标准规范简介是的简写,由组织制定的规范,是开发的实践标准。具体标准有有了统一编码风格规范,更有利于查看和学习各个框架或类库,不不需要每次都适应新的编码风格。同时在开发团队内部使用统一的编码规范更有利于代码审查版本控制团队内部交流。 PHP 标准规范 PSR PSR 简介 PSR 是 PHP Standard Recommendations 的简写,由 PHP FIG 组织制定的 PHP...

    FuisonDesign 评论0 收藏0

发表评论

0条评论

最新活动
阅读需要支付1元查看
<