PHP编码规范

PHP编码规范

请把规范变成习惯

一、 文件结构

文件结构和分类包括文件层次、命名含义等方面的约束，清晰的结构有助于源码的维护和理解。有意义的命名也是清晰结构的一个要素。比如config，一般就放系统配置文件。 注意：有些细节要求是结合当前使用的conan框架来要求的（下同）。

二、 命名规范

1． 文件夹命名

文件夹命名一般采用小写英文字母，一般不超过20个字符，尽量言简意赅。常用的有images, inc, config, log, database, cache, upload等

2． 文件命名

与文件夹类似，一般都采用小写英文字母。

一般来说，controller里的文件名与其对应的model都保持一致，如果对应的view是一个文件，那么文件名也保持一致，如果对应的是一组页面，那么与文件夹名称保持一致。

3． 类名

类文件是比较特殊的一类文件，类名是一个名词，可以反映出类的功能，一般采用小写英文字符（首字母大写），要尽量使你的类名简洁而又描述清楚，但避免使用不常见的缩写词。

注意：类名一般与其文件名保持一致，类名包含文件目录（自动加载）的除外，如： class Controller_Plan{} //controller目录下的plan.php文件 class Model_Plan{} //model目录下的plan.php文件

4． 函数命名

函数、方法名是个动词，采用大小写英文字母结合方式命名，首字母小写，其余单词首字母大写。通常每个方法都是执行一个动作的，所以对它的命名应该说清楚是干什么的，比如function setName(), checkForms(), exportData(), getContent()等。

注意：

（1） controller里的action方法（会在url上出现的）一律以小写字母命名，比如

aciton_index(), action_ajaxlist()等

（2） model里的方法定义如下命名规则：

类本身的方法用get来取，比如getStatus();

数据库查询采用find（查询）、add（添加）、update（更新）、delete（删除）、count（计数）等开头，以下是常用的命名方式：

find()：根据主键查询一条记录

findAll()：根据主键查询所有记录

findField()：根据主键查询某字段