函數參考 · DolphinPHP1.6.0完全開發手冊-基于ThinkPHP5.1.42LTS的快速開發框架

本框架的公共函數在：`application\common.php` 如果是自定義公共函數，請寫在：`application\function.php` 以下列舉部分函數，具體用法及其他函數請參考源碼。 ## is_signin >[info] 含義：判斷是否登錄返回：0或用戶id ## get_file_path($id) >[info] 含義：獲取附件路徑返回：附件路徑，如果無附件，則返回一張空圖片路徑 | 參數 | 類型 | 含義 | | --- | --- | --- | | $id | int | 附件id | ## get_files_path($ids) >[info] 含義：批量獲取附件路徑返回：附件路徑 | 參數 | 類型 | 含義 | | --- | --- | --- | | $id | array | 附件id | ## get_file_name >[info] 含義：獲取附件名稱返回：附件名稱 | 參數 | 類型 | 含義 | | --- | --- | --- | | $id | int | 附件id | ## get_thumb >[info] 含義：獲取附件縮略圖路徑返回：縮略圖路徑，如果無縮略圖，則返回原圖路徑 | 參數 | 類型 | 含義 | | --- | --- | --- | | $id | int | 附件id | ## get_avatar >[info] 含義：獲取用戶頭像路徑返回：頭像路徑，如果無頭像，則返回默認頭像路徑 | 參數 | 類型 | 含義 | | --- | --- | --- | | $uid | int | 用戶id，不傳該參數則獲取當前用戶id | ## parse_attr >[info] 含義：解析配置，按每行為一個數組元素組合成數組返回：數組 | 參數 | 類型 | 含義 | | --- | --- | --- | | $value | string | 配置值 | ## parse_array >[info] 含義：將一維數組解析成鍵值相同的數組返回：數組 | 參數 | 類型 | 含義 | | --- | --- | --- | | $arr | array | 一維數組 | ## hook >[info] 含義：監聽鉤子返回：無 | 參數 | 類型 | 含義 | | --- | --- | --- | | $name | string | 鉤子名稱 | | $params | string | 傳入參數 | | $extra | string | 額外參數 | | $once | string | 只獲取一個有效返回值 | ## module_config >[info] 含義：顯示模塊配置頁面，或獲取或設置插件配置返回：mixed 具體用法，請參考模塊開發中的[方法參考](方法參考.md) ## plugin_menage >[info] 含義：顯示插件的管理頁面返回：mixed 具體用法請參考[方法參考](插件-方法參考.md) ## plugin_config >[info] 含義：獲取或設置某個插件配置參數返回：mixed 具體用法請參考[方法參考](插件-方法參考.md) ## plugin_action >[info] 含義：執行插件動作返回：mixed 具體用法請參考[方法參考](插件-方法參考.md) ## plugin_action_exists >[info] 含義：檢查插件控制器是否存在某操作返回：bool | 參數 | 類型 | 含義 | | --- | --- | --- | | $name | string | 插件名 | | $controller | string | 控制器 | | $action | string | 動作 | ## plugin_model_exists >[info] 含義：檢查插件模型是否存在返回：bool | 參數 | 類型 | 含義 | | --- | --- | --- | | $name | string | 插件名 | ## plugin_validate_exists >[info] 含義：檢查插件驗證器是否存在返回：bool | 參數 | 類型 | 含義 | | --- | --- | --- | | $name | string | 插件名 | ## get_plugin_validate >[info] 含義：獲取插件驗證類實例返回：object | 參數 | 類型 | 含義 | | --- | --- | --- | | $name | string | 插件名 | ## get_plugin_model >[info] 含義：獲取插件模型實例返回：object | 參數 | 類型 | 含義 | | --- | --- | --- | | $name | string | 插件名 | ## get_plugin_class >[info] 含義：獲取插件類名返回：string ## plugin_url >[info] 含義：生成插件操作鏈接返回：string | 參數 | 類型 | 含義 | | --- | --- | --- | | $url | string | 鏈接：插件名稱/控制器/操作 | | $param | array | 參數 | | $module | string | admin需要登錄驗證，index不需要登錄驗證 | ## public_url >[info] 含義：生成插件操作鏈接(不需要登陸驗證) 返回：string | 參數 | 類型 | 含義 | | --- | --- | --- | | $url | string | 鏈接：插件名稱/控制器/操作 | | $param | array | 參數 | ## get_client_ip >[info] 含義：獲取客戶端IP地址返回：mixed | 參數 | 類型 | 含義 | | --- | --- | --- | | $type | int | 返回類型 0 返回IP地址 1 返回IPV4地址數字 | | $adv | bool | 是否進行高級模式獲取 | ## format_bytes >[info] 含義：格式化字節大小返回：string | 參數 | 類型 | 含義 | | --- | --- | --- | | $size | int | 字節數 | | $delimiter | string | 數字和單位分隔符 | ## format_time >[info] 含義：時間戳格式化返回：string | 參數 | 類型 | 含義 | | --- | --- | --- | | $time | int | 時間戳 | | $format | string | 輸出格式，默認為Y-m-d H:i | ## format_linkage >[info] 含義：格式化聯動數據，array('a', 'b')將格式化為array(array('key' => 0, 'value' => 'a'), array('key' => 1, 'value' => 'b')) 返回：string | 參數 | 類型 | 含義 | | --- | --- | --- | | $data | array | 要格式化的數據 | ## get_auth_node >[info] 含義：獲取用戶的數據授權節點返回：array|bool | 參數 | 類型 | 含義 | | --- | --- | --- | | $uid | int | 用戶id | | $group | string | 權限分組，可以以點分開模型名稱和分組名稱，如user.group | ## check_auth_node >[info] 含義：檢查用戶的某個節點是否授權返回：bool | 參數 | 類型 | 含義 | | --- | --- | --- | | $uid | int | 用戶id | | $group | string | 權限分組，可以以點分開模型名稱和分組名稱，如user.group | | $node | int | 需要檢查的節點id | ## get_nickname >[info] 含義：獲取用戶昵稱返回：string | 參數 | 類型 | 含義 | | --- | --- | --- | | $uid | int | 用戶id | ## action_log >[info] 含義：記錄行為日志，并執行該行為的規則返回：bool|string | 參數 | 類型 | 含義 | | --- | --- | --- | | $action | string | 行為標識 | | $model | string | 觸發行為的模型名 | | $record_id | int | 觸發行為的記錄id | | $user_id | int | 執行行為的用戶id | | $details | string | 詳情 | ## get_location >[info] 含義：獲取當前位置返回：array ## packet_exists >[info] 含義：查詢數據包是否存在，即是否已經安裝返回：array | 參數 | 類型 | 含義 | | --- | --- | --- | | $name | string | 數據包名 | ## load_assets >[info] 含義：返回靜態資源路徑代碼，可用于模板返回：string | 參數 | 類型 | 含義 | | --- | --- | --- | | $assets | string | 資源名稱 | | $type | string | 資源類型：css或js | ## parse_name >[info] 含義：字符串命名風格轉換返回：string | 參數 | 類型 | 含義 | | --- | --- | --- | | $name | string | 字符串 | | $type | string | 轉換類型，0 將Java風格轉換為C的風格 1 將C風格轉換為Java的風格 | ## index_url（1.0.4+） >[info] 含義：生成前臺入口url 返回：string 用法和ThinkPHP自帶的url方法一致，參數也一致。 >[danger] 注意：1.0.5以后，請使用home_url()代替index_url() ## admin_url（1.0.4+） >[info] 含義：生成后臺入口url 返回：string 用法和ThinkPHP自帶的url方法一致，參數也一致。 ## htmlpurifier（1.0.5+） >[info] 含義：html安全過濾返回：string | 參數 | 類型 | 含義 | | --- | --- | --- | | $html | string | 要過濾的內容 | ## dp_send_message（1.2.0+） >[info] 含義：發送消息給用戶返回：bool | 參數 | 類型 | 含義 | | --- | --- | --- | | $type | string | 消息類型 | | $content | string | 消息內容 | | $uids | string | 用戶id，可以是數組，也可以是逗號隔開的字符串 |