php項目命名規範

命名規範

ThinkPHP5遵循PSR-2命名規範和PSR-4自動加載規範，而且注意以下規範：

目錄和文件

• 目錄使用小寫+下劃線；
• 類庫、函數文件統一以.php爲後綴；
• 類的文件名均以命名空間定義，而且命名空間的路徑和類庫文件所在路徑一致；
• 類文件採用駝峯法命名（首字母大寫），其它文件採用小寫+下劃線命名；
• 類名和類文件名保持一致，統一採用駝峯法命名（首字母大寫）；

 

函數和類、屬性命名

• 類的命名採用駝峯法（首字母大寫），例如 User、UserType，默認不須要添加後綴，例如UserController應該直接命名爲User；
• 函數的命名使用小寫字母和下劃線（小寫字母開頭）的方式，例如 get_client_ip；
• 方法的命名使用駝峯法（首字母小寫），例如 getUserName；
• 屬性的命名使用駝峯法（首字母小寫），例如 tableName、instance；
• 以雙下劃線「__」打頭的函數或方法做爲魔術方法，例如 __call 和 __autoload；

 

常量和配置

• 常量以大寫字母和下劃線命名，例如 APP_PATH和 THINK_PATH；
• 配置參數以小寫字母和下劃線命名，例如 url_route_on 和url_convert；

 

數據表和字段

數據表和字段採用小寫加下劃線方式命名，並注意字段名不要如下劃線開頭，例如 think_user 表和 user_name字段，不建議使用駝峯和中文做爲數據表字段命名。

 

應用類庫命名空間規範

應用類庫的根命名空間統一爲app（不建議更改，能夠設置app_namespace配置參數更改，V5.0.8版本開始使用APP_NAMESPACE常量定義）；
例如：app\index\controller\Index和app\index\model\User。