ThinkPHP 作为 PHP 的开发框架,有自身的一套命名规范。在基于 ThinkPHP 的开发中,应该尽可能的遵照如下命名规范:
- 类文件名:ThinkPHP 使用的类库文件都是以 .class.php 为后缀,使用驼峰法命名,并且首字母大写。例如 DbMysql.class.php 。外部加载的类库文件除外。
- 配置文件名:以 .php 为后缀,如 config.php ,第三方引入的不做要求。
- 函数文件名:以 .php 为后缀,如 common.php ,第三方引入的不做要求。
- 类名:和文件名一致(包括大小写一致),例如 UserAction 类对应的文件是 UserAction.class.php 。
- 函数名:使用小写字母和下划线的方式,例如 get_client_ip 。
- 模型类名:以 Model 为后缀,例如 UserModel 。
- 方法名:使用驼峰法,并且首字母小写,例如 getUserName 。
- 属性:使用驼峰法,并且首字母小写,例如 tableName 。
- 魔法方法:以双下划线 __ 打头的函数或方法,例如 __call 和 __autoload 。
- 配置参数:以大写字母和下划线命名,例如 HAS_ONE 和 MANY_TO_MANY 。
- 语言变量:以大写字母和下划线命名,例如 MY_LANG ,以下划线打头的语言变量通常用于系统语言变量,例如 _CLASS_NOT_EXIST_ 。
- 快捷方法:以单字母大写来命名的函数,这类函数通常是某些操作的快捷定义,详见《ThinkPHP 快捷方法》 。