介紹
做這個開源系統,一直沒有做開發文檔,有點對不住大家,今天我把技術規格寫一下。
目錄結構
訪問方式
http://localhost/index.php?r=模組名稱_控制器名稱_方法或http://localhost/index.php?module=模組名稱&c/module=模組名稱&c/module p>
預設值是:模組名稱:Default,控制器名稱:Page,方法名稱:index
命名規範
1)類別檔案都是以.class.php為後綴,使用駝峰法命名,且首字母大寫。
2)類別名稱要體現文件路徑
3)核心文件要放置在lib/Core/目錄下面,這時候你不需要require裡面的文件,直接使用就可以。
4)函數的命名使用小寫字母和底線的方式
5)方法的命名使用駝峰法如validClientIp,私有方法使用下劃線'_',如_insertIP()。
6)常數以大寫字母加上底線命名,如DB_HOST。
7)對內部變數的命名沒有強制規範,可以依照個人喜好來命名。但個人建議方法參數變數我們使用駝峰法,內部參數使用小寫字母和底線命名。
如:
<ol> <li><span><span>public</span><span> </span><span>function</span><span> validAcount(</span><span>$userName</span><span>){ </span></span></li> <li><span> </span></li> <li> <span>$user_name</span><span> = </span><span>$userName</span><span>; </span> </li> <li><span>} </span></li> </ol>
8)範本檔案以.tpl為後綴。
9)資料表和欄位以小寫加下劃線方式命名。如hh_ip的欄位create_date
開發要求
1)MySQL最好使用PDO操作,因為安全性、效能比較高。
2)每次的資料庫讀取操作希望都使用explain進行校驗,以便確認命中索引。
開啟日誌
查看日誌
查看是否為命中索引
查看是否使用個表
超過2個,建議使用多個短select語句。
4)盡量用英文寫註釋,一是培養大家的英文能力;二是提升大家的命名能力。
總結
歡迎大家一起過來開發,開發這個專案除了創作好的產品外,主要是為了技術交流,看看大家的好的技術。如果大家有更好的規範或方法,不妨告知一、二。
QQ群:152448006
地址:
原文連結:http://www.cnblogs.com/baochuan/archive/2012/09/09/www.cnblogs.com/baochuan/archive/2012/09/09/2677214.
以上就介紹了PHP 開源軟體《個人管理系統》——技術規範,包括了開源軟體,管理系統方面的內容,希望對PHP教程有興趣的朋友有所幫助。