PHP PSR-1 规范
来源:互联网 发布:平价时尚欧美女装知乎 编辑:程序博客网 时间:2024/05/21 04:22
1.概览
- Files MUST use only
<?php and <?= tags.
PHP代码文件必须以<?php 或 <?=
标签开始; - Files MUST use only UTF-8 without BOM for PHP code.
PHP代码文件必须以 不带BOM的 UTF-8 编码; - Files SHOULD either declare symbols (classes, functions, constants, etc.) or cause side-effects (e.g. generate output, change .ini settings, etc.) but SHOULD NOT do both.
PHP代码中应该只定义类、函数、常量等声明,或其他会产生 从属效应 的操作(如:生成文件输出以及修改.ini配置文件等),二者只能选其一; - Namespaces and classes MUST follow an “autoloading” PSR: [PSR-0, PSR-4].
命名空间以及类必须符合 PSR 的自动加载规范:PSR-0 或 PSR-4 中的一个; - Class names MUST be declared in StudlyCaps.
类的命名必须遵循 StudlyCaps 大写开头的驼峰命名规范; - Class constants MUST be declared in all upper case with underscore separators.
类中的常量所有字母都必须大写,单词间用下划线分隔; - Method names MUST be declared in camelCase.
方法名称必须符合 camelCase 式的小写开头驼峰命名规范。
2.文件
2.1 PHP标签
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() { // 函数主体部分 }}#3. 命名空间和类- 命名空间以及类的命名必须遵循”自动加载”PSR:[PSR-0, PSR-4].- 根据规范,每个类都独立为一个文件,且命名空间至少有一个层次:顶级的组织名称(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{}剩下的一个类没什么好说的,大致为类常量必须大写以下划线分割。属性可以由大驼峰或小驼峰或下划线分割($under_score),但无论遵循哪种命名方式,都应该在一定的范围内保持一致。这个范围可以是整个团队、整个包、整个类或整个方法。
原文:http://www.php-fig.org/psr/psr-1/
阅读全文
0 0
- PHP PSR-1 规范
- PHP编码规范/PSR-1
- PHP编码规范之PSR-1
- PHP PSR-1 基本代码规范(中文版)
- PHP PSR-1 基本代码规范
- PHP PSR-1 基本代码规范(中文版)
- PHP PSR-1 基本代码规范(中文版)
- PHP PSR-1 基本代码规范(中文版)
- PHP PSR-1 基本代码规范
- PHP PSR 1-4 编码规范
- PHP开发规范PSR
- php开发规范 psr
- PHP-PSR(规范)
- 【PHP】PSR简要规范
- PSR规范--php编码规范
- PHP PSR-4与PSR-0规范
- [PSR规范]PSR-1基础编码规范
- 关于php规范psr-4
- Win32时间类型FILETIME/SYSTEMTIME/WINDOWSTIME(FILETIME这个名字很奇怪,其实他跟FILE并没有直接关系,只是很多File的API中,都以这个为时间的类型)
- linux\windows上mongodb的安装与配置,以及开启php扩展
- 获取iOS任意线程调用堆栈(二)符号化理论:Mach-o文件结构
- Android中Canvas绘图之PorterDuffXfermode使用及工作原理详解
- 蚂蚁金服成立科学智囊团,机器学习之父Michael I.Jordan担任主席
- PHP PSR-1 规范
- 156. Binary Tree Upside Down
- Android Fragment 与 Fragment管理器
- 获取iOS任意线程调用堆栈(三)符号化理论:从Mach-o结构分析类名方法名
- 查找成绩排名第二的学生
- Windows中的时间(SYSTEMTIME和FILETIME)
- 面试题26复杂连标的复制
- Android应用自定义View绘制方法手册
- python入门(@property,@*.setter)