§ 通用规范
要求所有的文件名,函数名,类名,模型名,插件名,均小写,并以下划线分隔两个单词。
命名一般为该实现功能的英文单词,严禁使用拼音或拼音英文混合命名。
如:添加,则命名为 add,批量添加,命名为:batch_add
§ 函数命名规范
使用小写字母和下划线的方式,例如 get_client_ip
§ 类库命名规范
要求文件以类名做为文件名,并以.php做为文件扩展名。如:压缩解压类,类名为 zip ,文件名则为 zip.php
§ 控制器命名规范
每个应用首先应该有一个基类,文件名为:abstract.php,类名为 <APP应用名称>_controller_abstract
所有应用的控制器必须继承自该应用的基类,前台控制器命名为:controller_<控制器名称>,后台控制器命名为:controller_admin_<控制器名称>。文件名就是控制器的名称,以.php为后缀。
如:新建一个应用,名称为:test,则该应用控制器目录下首先新建一个基类,文件名为 abstract.php
abstract class test_controller_abstract extends controller{ }
有一个默认前台控制器,文件名为 index.php
class controller_index extends test_controller_abstract { }
有一个默认后台控制器,文件名为 admin/index.php
class controller_admin_index extends test_controller_abstract { }
§ 方法命名规范
使用小写字母、数字、下划线命名,开头不能为数字,私有方法以 下划线“_” 开头
§ 模型命名规范
模型的类命名规则为model_<dirname>_数据表名,后台模型的命名规则为:model_admin_数据表名。 如:存储留言内容的数据表名为:cmstop_guestbook,cmstop_为表前缀,则相应的模型命名为:
前台应用模型,文件名为 guestbook.php
class model_guestbook extends model { }
后台应用模型,文件名为 admin/guestbook.php
class model_admin_guestbook extends model { }
注:如果表名中间有下线划,不做转义,同样命名。如,表名为:guestbook_type,模型命名为:
前台应用模型,文件名为 guestbook_type.php
class model_guestbook_type extends model { }
后台应用模型,文件名为 admin/guestbook_type.php
class model_admin_guestbook_type extends model { }