SentCMS 公共函數(shù)和庫函數(shù)使用規(guī)范

2021-09-14 17:55 更新

函數(shù)

函數(shù)名

函數(shù)命名,全部使用小寫,單詞直接使用 _ 連接,函數(shù)名的名稱應與函數(shù)功能相符,且函數(shù)名中使用的單詞,應該是全稱單詞.

函數(shù)文件

二次開發(fā)時增加的函數(shù),盡量使用獨立的新函數(shù)文件保存,通過配置載入,以方便未來的升級.

代碼質量

由于函數(shù)通常會被多次調(diào)用,因此應確保函數(shù)代碼質量,仔細檢測測試保證函數(shù)在執(zhí)行過程中不會拋出任何級別的PHP錯誤,否則部署后可能引起嚴重的性能問題.

其他

函數(shù)應該少而精干,數(shù)據(jù)的增刪改查,盡量通過模型方法實現(xiàn),以利于代碼管理維護.通常定義函數(shù)是為了在模板中查詢和轉換數(shù)據(jù),或者在不同模塊之間實現(xiàn)代碼重用.

類庫

模塊類庫

模塊的類庫,即Application目錄下的控制器,模型等類。文件和類名的命名規(guī)則不變,只是控制器命名默認使用Controller代替了Action,如果還想用Action,在Common/Config/config.php 中配置 DEFAULT_C_LAYER=>'Action'
模塊類庫的命名空間定義見: 控制器定義 和 模型定義

插件類庫

即Addons目錄下插件的類,文件模板如下:
文件名:Addons/插件名/插件名Addon.class.php

<?php
namespace Addons\插件名;
use Common\Controller\Addon;
class 插件名Addon extends Addon{
}

文件名:Addons/插件名/Controller/控制器名Controller.class.php

<?php
namespace Addons\插件名\Model;
use Think\Model;
class 模型名Model extends Model{
}

sentCMS框架類庫

sentCMS基于ThinkPHP3.2,類庫文件位于ThinkPHP/Library目錄,框架類庫全部使用命名空間載入,在控制器和模型中使用框架類庫時,只需代碼前面用 use 聲明要載入的類庫的命名空間即可.

關于命名空間,參考ThinkPHP3.2文檔

您可以在 ThinkPHP/Library目錄下創(chuàng)建新的目錄放置其他類庫文件,相應地這些類庫文件必須修改類庫的命名空間定義和訪問.

以上內(nèi)容是否對您有幫助:
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號
微信公眾號

編程獅公眾號