这一规范其实也适用于绝大多数的PHP项目
1、类文件都是以.class.php
为后缀(这里是指的ThinkPHP内部使用的类库文件,不代表外部加载的类库文件),使用驼峰法命名,并且首字母大写,例如 DbMysql.class.php
;
2、类的命名空间地址和所在的路径地址一致,例如Home\Controller\UserController
类所在的路径应该是Application/Home/Controller/UserController.class.php
;
3、确保文件的命名和调用大小写一致,是由于在类Unix系统上面,对大小写是敏感的(而ThinkPHP在调试模式下面,即使在Windows平台也会严格检查大小写);
4、类名和文件名一致(包括上面说的大小写一致),例如UserController类的文件命名是UserController.class.php
, InfoModel类的文件名是InfoModel.class.php
, 并且不同的类库的类命名有一定的规范;
5、函数、配置文件等其他类库文件之外的一般是以.php为后缀(第三方引入的不做要求);
6、函数的命名使用小写字母和下划线的方式,例如:get_client_ip
;
7、方法的命名使用驼峰法,并且首字母小写或者使用下划线“_”,例如:getUserName
,_parseType
,通常下划线开头的方法属于私有方法;
8、属性的命名使用驼峰法,并且首字母小写或者使用下划线“_”,例如:tableName
、_instance
,通常下划线开头的属性属于私有属性;
9、以双下划线“__”打头的函数或方法作为魔法方法,例如:__call
和__autoload
;
10、常量以大写字母和下划线命名,例如:HAS_ONE
和MANY_TO_MANY
;
11、配置参数以大写字母和下划线命名,例如:HTML_CACHE_ON
;
12、语言变量以大写字母和下划线命名,例如:MY_LANG
,以下划线打头的语言变量通常用于系统语言变量,例如:_CLASS_NOT_EXIST_
;
13、对变量的命名没有强制的规范,可以根据团队规范来进行;
14、ThinkPHP的模板文件默认是以.html 为后缀(可以通过配置修改);
15、数据表和字段采用小写加下划线方式命名,并注意字段名不要以下划线开头,例如 think_user 表和user_name
字段是正确写法,类似_username
这样的数据表字段可能会被过滤。