ThinkPHP6.0快速开发手册(案例版) / ThinkPHP6中的命名规范

ThinkPHP6中的命名规范

ThinkPHP6中的命名规范



正确的命名规范

为了实现PSR-2命名规范和PSR-4自动加载规范,命名时需要注意以下规则:

目录和文件

1.目录使用小写+下划线: admin_manage

2.类库、函数文件统一以.php为后缀: common.php

3.类的文件名均以命名空间定义,并且命名空间的路径和类库文件所在路径一致, 这是自动加载的机制要求

4.类(包含接口和Trait)文件采用驼峰法命名(首字母大写),其它文件采用小写+下划线命名: user_email

5.类名(包含接口和Trait)和类文件名保持一致,统一采用驼峰法命名: StaffController.php

函数和类、属性命名

1.类的命名采用驼峰法(首字母大写),默认不需要添加后缀,例如:User、UserType

2.函数的命名使用小写字母和下划线(小写字母开头)的方式,例如:get_client_ip

3.方法的命名使用驼峰法(首字母小写),例如:getUserName

4.属性的命名使用驼峰法(首字母小写),例如:tableName、instance

5.特例:以双下划线__打头的函数或方法作为魔术方法,例如:__call和__autoload

常量和配置

1.常量以大写字母和下划线命名,例如:APP_PATH

2.配置参数以小写字母和下划线命名,例如:url_route_on 和 url_convert

3.环境变量定义使用大写字母和下划线命名,例如:APP_DEBUG

数据表和字段
数据表和字段采用小写加下划线方式命名,并注意字段名不要以下划线开头,例如think_user表和user_name字段,不建议使用驼峰和中文作为数据表及字段命名

请理解并尽量遵循以上命名规范,可以减少在开发过程中出现不必要的错误

请避免使用PHP保留字(保留字列表参见 http://php.net/manual/zh/reserved.keywords.php )作为常量、类名和方法名,以及命名空间的命名,否则会造成系统错误。