開發(fā)規(guī)范
EyouCms是基于TP5.0框架為核心開發(fā)的企業(yè)內(nèi)容管理系統(tǒng),其底層的開發(fā)原理和tp一致,所以除了數(shù)據(jù)字典、目錄結構、插件開發(fā)以外,其他可以直接借鑒tp的開發(fā)邏輯,下面為引用TP的開發(fā)規(guī)范...供大家參考
命名規(guī)范
ThinkPHP
遵循PSR-2
命名規(guī)范和PSR-4
自動加載規(guī)范,并且注意如下規(guī)范:
目錄和文件
- 目錄使用小寫+下劃線;
-
類庫、函數(shù)文件統(tǒng)一以
.php
為后綴; - 類的文件名均以命名空間定義,并且命名空間的路徑和類庫文件所在路徑一致;
- 類文件采用駝峰法命名(首字母大寫),其它文件采用小寫+下劃線命名;
- 類名和類文件名保持一致,統(tǒng)一采用駝峰法命名(首字母大寫);
函數(shù)和類、屬性命名
-
類的命名采用駝峰法(首字母大寫),例如
User
、UserType
,默認不需要添加后綴,例如UserController
應該直接命名為User
; -
函數(shù)的命名使用小寫字母和下劃線(小寫字母開頭)的方式,例如
get_client_ip
; -
方法的命名使用駝峰法(首字母小寫),例如
getUserName
; -
屬性的命名使用駝峰法(首字母小寫),例如
tableName
、instance
; -
以雙下劃線“__”打頭的函數(shù)或方法作為魔術方法,例如
__call
和__autoload
;
常量和配置
-
常量以大寫字母和下劃線命名,例如
APP_PATH
和THINK_PATH
; -
配置參數(shù)以小寫字母和下劃線命名,例如
url_route_on
和url_convert
;
數(shù)據(jù)表和字段
-
數(shù)據(jù)表和字段采用小寫加下劃線方式命名,并注意字段名不要以下劃線開頭,例如
think_user
表和user_name
字段,不建議使用駝峰和中文作為數(shù)據(jù)表字段命名。
應用類庫命名空間規(guī)范
應用類庫的根命名空間統(tǒng)一為app(不建議更改,可以設置app_namespace
配置參數(shù)更改,V5.0.8
版本開始使用APP_NAMESPACE
常量定義);
例如:app\index\controller\Index
和app\index\model\User
。
請避免使用PHP保留字(保留字列表參見 http://php.net/manual/zh/reserved.keywords.php )作為常量、類名和方法名,以及命名空間的命名,否則會造成系統(tǒng)錯誤。
文檔最后更新時間:2023-10-25 16:44:14
目錄結構 →
未解決你的問題?請到「問答社區(qū)」反饋你遇到的問題