# 函數參考 # 函數參考 本框架的公共函數在：`application\common.php` 如果是自定義公共函數，請寫在：`application\function.php` 以下列舉部分函數，具體用法及其他函數請參考源碼。 ## is\_signin > 含義：判斷是否登錄 > 返回：0或用戶id ## get\_file\_path($id) > 含義：獲取附件路徑 > 返回：附件路徑，如果無附件，則返回一張空圖片路徑 參數類型含義$idint附件id## get\_files\_path($ids) > 含義：批量獲取附件路徑 > 返回：附件路徑 參數類型含義$idarray附件id## get\_file\_name > 含義：獲取附件名稱 > 返回：附件名稱 參數類型含義$idint附件id## get\_thumb > 含義：獲取附件縮略圖路徑 > 返回：縮略圖路徑，如果無縮略圖，則返回原圖路徑 參數類型含義$idint附件id## get\_avatar > 含義：獲取用戶頭像路徑 > 返回：頭像路徑，如果無頭像，則返回默認頭像路徑 參數類型含義$uidint用戶id，不傳該參數則獲取當前用戶id## parse\_attr > 含義：解析配置，按每行為一個數組元素組合成數組 > 返回：數組 參數類型含義$valuestring配置值## parse\_array > 含義：將一維數組解析成鍵值相同的數組 > 返回：數組 參數類型含義$arrarray一維數組## hook > 含義：監聽鉤子 > 返回：無 參數類型含義$namestring鉤子名稱$paramsstring傳入參數$extrastring額外參數$oncestring只獲取一個有效返回值## module\_config > 含義：顯示模塊配置頁面，或獲取或設置插件配置 > 返回：mixed 具體用法，請參考模塊開發中的[方法參考](http://www.hmoore.net/ming5112/dolphinphp/%E6%96%B9%E6%B3%95%E5%8F%82%E8%80%83.md) ## plugin\_menage > 含義：顯示插件的管理頁面 > 返回：mixed 具體用法請參考[方法參考](http://www.hmoore.net/ming5112/dolphinphp/%E6%8F%92%E4%BB%B6-%E6%96%B9%E6%B3%95%E5%8F%82%E8%80%83.md) ## plugin\_config > 含義：獲取或設置某個插件配置參數 > 返回：mixed 具體用法請參考[方法參考](http://www.hmoore.net/ming5112/dolphinphp/%E6%8F%92%E4%BB%B6-%E6%96%B9%E6%B3%95%E5%8F%82%E8%80%83.md) ## plugin\_action > 含義：執行插件動作 > 返回：mixed 具體用法請參考[方法參考](http://www.hmoore.net/ming5112/dolphinphp/%E6%8F%92%E4%BB%B6-%E6%96%B9%E6%B3%95%E5%8F%82%E8%80%83.md) ## plugin\_action\_exists > 含義：檢查插件控制器是否存在某操作 > 返回：bool 參數類型含義$namestring插件名$controllerstring控制器$actionstring動作## plugin\_model\_exists > 含義：檢查插件模型是否存在 > 返回：bool 參數類型含義$namestring插件名## plugin\_validate\_exists > 含義：檢查插件驗證器是否存在 > 返回：bool 參數類型含義$namestring插件名## get\_plugin\_validate > 含義：獲取插件驗證類實例 > 返回：object 參數類型含義$namestring插件名## get\_plugin\_model > 含義：獲取插件模型實例 > 返回：object 參數類型含義$namestring插件名## get\_plugin\_class > 含義：獲取插件類名 > 返回：string ## plugin\_url > 含義：生成插件操作鏈接 > 返回：string 參數類型含義$urlstring鏈接：插件名稱/控制器/操作$paramarray參數$modulestringadmin需要登錄驗證，index不需要登錄驗證## public\_url > 含義：生成插件操作鏈接(不需要登陸驗證) > 返回：string 參數類型含義$urlstring鏈接：插件名稱/控制器/操作$paramarray參數## get\_client\_ip > 含義：獲取客戶端IP地址 > 返回：mixed 參數類型含義$typeint返回類型 0 返回IP地址 1 返回IPV4地址數字$advbool是否進行高級模式獲取## format\_bytes > 含義：格式化字節大小 > 返回：string 參數類型含義$sizeint字節數$delimiterstring數字和單位分隔符## format\_time > 含義：時間戳格式化 > 返回：string 參數類型含義$timeint時間戳$formatstring輸出格式，默認為Y-m-d H:i## format\_linkage > 含義：格式化聯動數據，array('a', 'b')將格式化為array(array('key' => 0, 'value' => 'a'), array('key' => 1, 'value' => 'b')) > 返回：string 參數類型含義$dataarray要格式化的數據## get\_auth\_node > 含義：獲取用戶的數據授權節點 > 返回：array|bool 參數類型含義$uidint用戶id$groupstring權限分組，可以以點分開模型名稱和分組名稱，如user.group## check\_auth\_node > 含義：檢查用戶的某個節點是否授權 > 返回：bool 參數類型含義$uidint用戶id$groupstring權限分組，可以以點分開模型名稱和分組名稱，如user.group$nodeint需要檢查的節點id## get\_nickname > 含義：獲取用戶昵稱 > 返回：string 參數類型含義$uidint用戶id## action\_log > 含義：記錄行為日志，并執行該行為的規則 > 返回：bool|string 參數類型含義$actionstring行為標識$modelstring觸發行為的模型名$record\_idint觸發行為的記錄id$user\_idint執行行為的用戶id$detailsstring詳情## get\_location > 含義：獲取當前位置 > 返回：array ## packet\_exists > 含義：查詢數據包是否存在，即是否已經安裝 > 返回：array 參數類型含義$namestring數據包名## load\_assets > 含義：返回靜態資源路徑代碼，可用于模板 > 返回：string 參數類型含義$assetsstring資源名稱$typestring資源類型：css或js## parse\_name > 含義：字符串命名風格轉換 > 返回：string 參數類型含義$namestring字符串$typestring轉換類型，0 將Java風格轉換為C的風格 1 將C風格轉換為Java的風格## index\_url > 含義：生成前臺入口url > 返回：string 用法和ThinkPHP自帶的url方法一致，參數也一致。 > 注意：1.0.5以后，請使用home\_url()代替index\_url() ## admin\_url > 含義：生成后臺入口url > 返回：string 用法和ThinkPHP自帶的url方法一致，參數也一致。 ## htmlpurifier > 含義：html安全過濾 > 返回：string 參數類型含義$htmlstring要過濾的內容