Programmer's Reference Guide

PHP File 文件格式

命名约定

Zend Framework 的类命名总是对应于其所属文件的目录结构的,Zend Framework 的根目录是 “Zend/”,所有的类在其下按等级存放。

类名只允许有字母数字字符,但不鼓励使用数字。下划线只允许做路径分隔符,例如 Zend/Db/Table.php 文件里对应的类名称是 Zend_Db_Table。

如果类名包含多个单词,每个单词的第一个字母必须大写,连续的大写是不允许的,例如 “Zend_PDF” 是不允许的,而 "Zend_Pdf" 是可接受的。

由 Zend 或其参与 Zend Framework 项目的伙伴公司发行的类必须以 "Zend_" 开头并且必须按等级放在 "Zend/"目录下。

可接受的类名的例子:

Zend_Db

Zend_View

Zend_View_Helper
                
重要: 最终用户写的代码,不要以 "Zend_" 开头。

接口

接口类也必须遵循同样的约定(如上所述),但必须以 "Interface" 结尾,比如这些例子:

Zend_Log_Adapter_Interface
Zend_Controller_Dispatcher_Interface
                

文件名

对于其它文件,只有字母数字字符、下划线和短横线("-")可用,空格是不允许的。

包含任何 PHP 代码的任何文件必须以 ".php" 扩展名结尾。这些例子给出可接受的文件名,它们包含的类名都在上述章节的例子中:

Zend/Db.php

Zend/Controller/Front.php

Zend/View/Helper/FormRadio.php
                
文件名必须遵循上述的对应类名的规则。

函数和方法

函数名只包含字母数字字符,但不鼓励使用数字,下划线是不允许的。

函数名总是以小写开头,当函数名包含多个单词,每个子的首字母必须大写,这就是所谓的 “驼峰” 格式。

我们鼓励使用冗长的名字,这样容易理解代码。

这些是可接受的函数名的例子:

filterInput()

getElementById()

widgetFactory()
                

对于面向对象编程,对象的访问器总是以 "get" 或 "set" 为前缀。当使用设计模式如 单态模式(singleton)或工厂模式(factory),方法的名字应当包含模式的名字,这样容易从名字识别设计模式。

在对象中的方法,声明为 "private" 或 "protected" 的, 名称的首字符必须是一个单个的下划线,这是唯一的下划线在方法名字中的用法。声明为 "public" 的从不以下划线开头。

全局函数 ("floating functions") 允许但不鼓励,建议把这类函数封装到静态类里。

变量

变量只包含数字字母字符,不鼓励使用数字,下划线不接受。

声明为 "private" 或 "protected" 的类成员变量名必须以一个单个下划线开头,这是唯一的下划线在变量名中的用法,声明为 "public" 的从不以下划线开头。

象函数名(见上面 3.3 节)一样,变量名总以小写字母开头并遵循“驼峰式”命名约定。

我们鼓励使用冗长的名字,这样容易理解代码。除非在小循环里,不鼓励使用简洁的名字如 "$i" 和 "$n" 。如果一个循环超过 20 行代码,索引的变量名必须有个具有描述意义的名字。

常量

常量包含数字字母字符和下划线,数字允许作为常量名。

常量名的所有字母必须大写。

为加强可读性,常量中的单词必须以下划线分隔,例如可以这样 EMBED_SUPPRESS_EMBED_EXCEPTION 但不许这样 EMBED_SUPPRESSEMBEDEXCEPTION

常量必须通过 "const" 定义为类的成员,不鼓励使用 "define" 定义的全局常量。


PHP File 文件格式
blog comments powered by Disqus

Select a Version

Languages Available

Components

Search the Manual