Zend Framework 规范.docx

1、Zend Framework 规范Zend Framework的开发规范一、 Zend Framework 中的 Php 编码标准 (一) - 文件格式1. 对于只含有 php 代码的文件，我们将在文件结尾处忽略掉 ? 。这是为了防止多余的空格或者其它字符影响到代码。实际上这个问题只有当你不开启压缩或缓存输出时才会出现 : / php.ini - 禁止压缩输出及缓存输出zlib.output_compression = offoutput_buffering = off/ foo.php - 注意这个时候有一些空格或换行符掉在了 ? 之后，当然这在页面上是看不到的/ index.php - 在

2、包含 foo.php 的同时，实际上我们已经输出了一些空格或换行了这时我们将看到一个警告 (warning) 说 . Cannot send session cache limiter - headers already sent . 这是因为我们在 session_start() 之前输出了一些看不到的字符。2. 由 _halt_compiler() 允许的任意的二进制代码的内容，被 Zend Framework 中的 PHP 文件或由它们产生的文件所禁止。实际上这个规定是为了防止一些极个别的情况发生，例如上例中 :/ foo.php - 我们已经禁用了 ?_testObj; public

3、function setTestObj($testObj) $this-_testObj = $testObj; 12. 当我们使用了某些设计模式的时候，我们的方法中应该含有该模式名。例如 ：abstract class Zend_Cache / . public static function factory($frontend, $backend, $frontendOptions = array(), $backendOptions = array(), $customFrontendNaming = false, $customBackendNaming = false, $autol

4、oad = false) / . 13. 当类成员函数被声明为 private 或者 protected 时，函数必须以下划线 _ 为开头，一般情况下的函数不含下划线。例如 ：class Zend_Foo protected function _fooBar() / . 14. 如果我们需要把一些经常使用的函数或方法定义为全局函数，那么应该把它们以静态 (static) 的形式定义在类中。例如 ：class Zend_Debug / . public static function dump($var, $label = null, $echo = true) / . 15. 在类中被声明为

5、static 的函数或变量不应该再被声明为 private 私有，而应该为 protected 或者public ，如果只是不想被子类继承，则应该用 final 声明它们。例如 ：class Foo final public static function fooFinally() class Bar extends Foo/ This is wrongBar:fooFinally();/ Use Foo:fooFinally() insteadFoo:fooFinally();16. 函数或方法的初始中括号应该在函数声明的下一行顶格。例如 ：function Myfunction($para

6、meter1)17. 当函数参数不一定需要被赋值的时候，用 null 来代替 false 作为函数参数的默认值，除非该参数是 boolean 值。例如，考虑如下代码 ：public function foo($required, $optional = null) if (isset($optional) echo Echo something only when $optional is set and != null; public function foo($required, $optional = false) if (isset($optional) echo Always ech

7、o something; 18. 变量只允许由字母组成，数字或下划线都是不允许的。例如 ：$foo / 是正确的$foo_foo / 是错误的$foo2 / 也是错误的19. 被声明为 private 或者 protected 的类成员属性必须由下划线 _ 作为开头，这也是唯一一种允许变量中出现下划线的情况，而声明为 public 的成员属性则在任何时候都不允许含有下划线。例如 ：class Zend_Foo private $_barPrivate; protected $_barProtected; public $barPublic;20. 变量名必须像函数名那样，即首字母要小写，其后每

8、个单词首字母要大写，即所谓的 “camelCaps” 规则。例如 ：$compatibilityMode$registryClassName21. 建议用描述性的变量的命名，变量名越详细越好，以至于像 $i 或 $n 等等都是不鼓励使用的，特别是在超过20行的循环里面。例如 Zend_Search_Lucene 中的一段代码 ：/ read segmentInfosfor ($count = 0; $count readString(); .22. 常量 constant 必须仅包括字母，数字和下划线，而且必须全部大写，各个单词之间用下划线分割。例如 ：MY_CONSTANT_ONE / 是允

9、许的MYCONSTANTTWO / 是不允许的my_constant_two / 也是不允许的23. 常量应该在类中由 const 声明并定义，全局范围内的 define 是不鼓励使用的。例如 ：class Zend_Acl const TYPE_ALLOW = TYPE_ALLOW; const TYPE_DENY= TYPE_DENY; .24. 和 php 文档说明不一样的是，Zend Framework 中的 boolean 值和 null 值都是用小写的。例如 Zend_Mail 中的一段代码 ：public function setMessageId($id = true) if

10、($id = null | $id = false) return $this; elseif ($id = true) $id = $this-createMessageId(); .三、 Zend Framework 中的 Php 编码标准 (三) - 编码风格1. PHP 代码必须以完整的形式来定界，短定界符只能用在视图。例如 ： / index.phtml2. 当一个字符串是纯文字组成的时候（即不含有变量），则必须总是以单引号（）或者撇号（）作为定界符。例如 ： $a = Example String;$b = Excute Something;3. 当一个字符串含有撇号（）的时候，我

11、们允许使用双引号（）来定界字符串，特别是在些 SQL 语句的时候。例如 ：$sql = SELECT id, name from people WHERE name=Fred OR name=Susan;4. 变量替换中的变量只允许用 $+变量名 的形式。例如 ：$greeting = Hello $name, welcome back!; / 允许$greeting = Hello $name, welcome back!; / 允许$greeting = Hello $name, welcome back!; / 不允许5. 多个字符串必须用点号 . 来连接，且字符串与点号间必须用一个空格

12、隔开。例如 ：$company = Zend . Technologies;6. 当用点号 . 连接各字符串的时候，我们允许把它分割成多行以增强可读性。在这种情况下，点号 . 必须与等于号 = 对齐。例如 ：$sql = SELECT id, name FROM people . WHERE name = Susan . ORDER BY name ASC ;7. 任何负数都不允许作为数组的索引，数组索引必须以任何非负数作为开头，而且强烈建议以0作为默认开头。例如 ：$sampleArray = array(-1 = -1, 0 = 0); / 错误$sampleArray = array(0

13、 = -1, 1 = 0);/ 正确$sampleArray = array(1 = -1, 2 = 0);/ 正确8. 当用 array 类型符号来构造数组的时候，必须在每个逗号之后加上一个空格来增强可读性。例如 ：$sampleArray = array(1, 2, 3, Zend, Studio);9. 多行的索引数组同样允许用 array 类型符号来构造，只是我们需要为每行的每个值加上必要的空格来保持其整齐美观。例如 ：$sampleArray = array(1, 2,3,Zend, Studio, $a, $b, $c, 56.44, $d, 500);10. 当使用 array

14、类型符声明关联数组的时候，我们鼓励把它分成多个行，只是我们必须同时保证每行的键与值的对齐，以保持美观。例如 ：$sampleArray = array(firstKey= firstValue, secondKey = secondValue);11. 中括号的开始必须在类名的下一行顶格。例如 ：class foo / 正确 写法class foo / 错误 写法12. 类定义必须拥有符合 phpDocumentor 标准的注释块。例如 ：/* 类定义注释*/class Zend_Class13. 类中的所有代码都必须用4个空格来进行缩进。例如 ：class Zend_Class $space

15、s = 4 spaces; if ($spaces = 4 spaces) echo is permitted !; class Zend_Class$spaces = less then 4 spaces;if ($spaces != 4 spaces) echo is not permitted !;14. 每个 php 文件只允许声明一个类。在类文件里面写其它代码是允许的，但并不鼓励这样做。假如真要附加代码的话，必须用空行来分隔。例如 ：?php/ 允许但并不鼓励这样做class Zend_Class static $foo = foo;echo Zend_Class:$foo;15. 任何类变量的声明都必须放在类顶部，先于任何函数的声明。例如 ：/ 正确class right public $foo = 先于函数定义; public function fun()