SentCMS Common函數(shù)庫

文件

因函數(shù)比較多在這不全部列舉只列舉比較常用的函數(shù) Common函數(shù)位于/Application/Common/Common/function.php中不懂的可以進去參考

is_login()
說明: 檢測用戶是否已登陸
返回值: integer 0-未登錄，大于0-當(dāng)前登錄用戶ID

is_administrator($uid = null)
說明：檢測用戶是否是超級管理員
返回值 boolean true-管理員，false-非管理員

str2arr($str, $glue = ',')
說明：字符串轉(zhuǎn)換為數(shù)組，與explode功能相同，只是參數(shù)順序不同
參數(shù) string $str 要分割的字符串
參數(shù) string $glue 分割符
返回值 array

arr2str($arr, $glue = ',')
說明：數(shù)組轉(zhuǎn)換為字符串，與implode功能相同，只是參數(shù)順序不同
參數(shù) array $arr 要連接的數(shù)組
參數(shù) string $glue 分割符
返回值 strink

think_encrypt($data, $key = '', $expire = 0)
說明：數(shù)據(jù)加密方法，將需要加密的數(shù)據(jù)串加密為字符串。
參數(shù) string $data 要加密的字符串
參數(shù) string $key 加密密鑰
參數(shù) int $expire 過期時間 單位 秒
返回值 string

think_decrypt($data, $key = '')
說明：數(shù)據(jù)解密方法，將think_encrypt加密過的數(shù)據(jù)還原。

list_sort_by($list,$field, $sortby='asc')
說明： 對查詢結(jié)果集進行排序
參數(shù) array $list 查詢結(jié)果
參數(shù) string $field 排序的字段名（單個）
參數(shù) array $sortby 排序類型 asc正向排序 desc逆向排序 nat自然排序
返回值 array

data_auth_sign($data)
說明：數(shù)據(jù)簽名認證，用于驗證提供的數(shù)據(jù)與存儲的數(shù)據(jù)是否一致。
參數(shù) array $data 被認證的數(shù)據(jù)
返回值 string 簽名

list_to_tree($list, $pk='id', $pid = 'pid', $child = '_child', $root = 0)
說明：把返回的查詢數(shù)據(jù)集轉(zhuǎn)換成多維數(shù)組的樹狀結(jié)構(gòu)數(shù)據(jù)
參數(shù) array $list 要轉(zhuǎn)換的數(shù)據(jù)集
參數(shù) string $pk 數(shù)據(jù)集的主鍵
參數(shù) string $pid 父id數(shù)據(jù)字段
參數(shù) string $child 用來保存子數(shù)據(jù)的鍵名
參數(shù) int $root 根元素的父id
返回值 array

tree_to_list($tree, $child = '_child', $order='id', &$list = array())
說明： 將list_to_tree生成的多維數(shù)組樹狀結(jié)構(gòu)數(shù)據(jù)還原成普通的查詢列表
參數(shù) array $tree list_to_tree生成的多維數(shù)組樹狀結(jié)構(gòu)數(shù)據(jù)
參數(shù) string $child 保存子數(shù)據(jù)的鍵名
參數(shù) string $order 排序顯示的鍵，一般是主鍵 升序排列
參數(shù) array $list 過渡用的中間數(shù)組
返回值 array 返回排過序的列表數(shù)組

format_bytes($size, $delimiter = '')
說明：字節(jié)格式化 參數(shù) number $size 字節(jié)數(shù) 參數(shù) string $delimiter 數(shù)字和單位分隔符 返回值 string 格式化后的帶單位的大小，例如：2KB

get_addon_class($name)
說明：根據(jù)插件簡單類名返回插件類的命名空間類名
參數(shù) strng $name 插件名
返回值 string

get_addon_config($name)
說明：獲取插件類的配置數(shù)組
參數(shù) string $name 插件名

addons_url($url, $param = array())
說明：生成用于訪問插件控制器的url
參數(shù) string $url url 例如：'Attachment://Attachment/download'
參數(shù) array $param 參數(shù),例如'id=2'
返回值 string

time_format($time = NULL,$format='Y-m-d H:i')
說明：時間戳格式化,與date函數(shù)功能相同，只是參數(shù)順序不同
參數(shù) int $time

get_username($uid = 0)
說明：根據(jù)用戶ID獲取用戶名。首先會嘗試從session獲取，其次嘗試從緩存獲取，如果沒有獲取到，從數(shù)據(jù)庫獲取并緩存。
參數(shù) integer $uid 用戶ID 返回值 string 用戶名

get_nickname($uid = 0)
說明：根據(jù)用戶ID獲取用戶昵稱。首先會嘗試從session獲取，其次嘗試從緩存獲取，如果沒有獲取到，從數(shù)據(jù)庫獲取并緩存。
根據(jù)用戶ID獲取用戶昵稱
參數(shù) integer $uid 用戶ID
返回值 string 用戶昵稱

get_category($id, $field = null)
說明：獲取某個分類的某個字段的值并緩存
參數(shù) integer $id 分類ID
參數(shù) string $field 要獲取的字段名
返回值 string 字段的值

get_category_name($id)
說明：根據(jù)ID獲取分類標識

get_category_title($id)
說明：根據(jù)ID獲取分類名稱

get_document_model($model_id = null, $field = null)
說明：根據(jù)模型id獲取文檔模型的某個字段的值并緩存
參數(shù) integer $model_id 模型ID
參數(shù) string $field 模型字段
返回值 array

action_log($action = null, $model = null, $record_id = null, $user_id = null)
說明：執(zhí)行該行為的規(guī)則，并記錄行為日志
參數(shù) string $action 行為標識
參數(shù) string $model 觸發(fā)行為的模型名，例如：'document'
參數(shù) int $record_id 觸發(fā)行為的記錄id
參數(shù) int $user_id 執(zhí)行行為的用戶id
返回值 boolean

parse_action($action = null, $self)
說明： 將一條行為定義文本解析為行為規(guī)則數(shù)組。
規(guī)則定義 table:$table|field:$field|condition:$condition|rule:$rule[|cycle:$cycle|max:$max][;......] 規(guī)則字段解釋：table->要操作的數(shù)據(jù)表，不需要加表前綴； field->要操作的字段； condition->操作的條件，目前支持字符串，默認變量{$self}為執(zhí)行行為的用戶 rule->對字段進行的具體操作，目前支持四則混合運算，如：1+score*2/2-3 cycle->執(zhí)行周期，單位（小時），表示$cycle小時內(nèi)最多執(zhí)行$max次 max->單個周期內(nèi)的最大執(zhí)行次數(shù)（$cycle和$max必須同時定義，否則無效） 單個行為后可加 ； 連接其他規(guī)則
參數(shù) string $action 行為id或者name
參數(shù) int $self 替換規(guī)則里的變量為執(zhí)行用戶的id
返回值 boolean|array: false解析出錯 ， 成功返回規(guī)則數(shù)組

execute_action($rules = false, $action_id = null, $user_id = null)
說明：執(zhí)行行為
參數(shù) array $rules parse_action解析后的行為規(guī)則數(shù)組
參數(shù) int $action_id 行為id
參數(shù) array $user_id 執(zhí)行的用戶id
返回值 boolean false 失敗 ， true 成功

create_dir_or_files($files)
說明：基于數(shù)組創(chuàng)建目錄和文件，每個目錄或文件作為數(shù)組的一個元素

array_column(array $input, $columnKey, $indexKey = null)
說明：PHP5.5的自帶函數(shù)兼容實現(xiàn)，來自PHP手冊

get_table_name($model_id = null)
說明：獲取表名（不含表前綴）
參數(shù) string $model_id
返回值 string 表名

get_model_attribute($model_id, $group = true)
說明：獲取模型屬性信息并緩存
參數(shù) integer $id 屬性ID
參數(shù) string $field 要獲取的字段名
返回值 string 屬性信息

api($name,$vars=array())
說明：調(diào)用系統(tǒng)的API接口的靜態(tài)方法，例如：api('User/getName','id=5');// 調(diào)用公共模塊的User接口的getName方法
參數(shù) string $name 格式 [模塊名]/接口名/靜態(tài)方法名
參數(shù) array|string $vars 參數(shù)

get_link($link_id = null, $field = 'url')
說明: 根據(jù)外鏈id(onethink_url表)，返回外鏈的其他字段值，默認返回url字段值
參數(shù)　int $link_id　主鍵值 參數(shù) string $field　字段值

get_cover($cover_id, $field = null)
說明：根據(jù)圖片id(onethink_picture)返回圖片的其他字段值，默認返回所有整行記錄
參數(shù)　int $cover_id　主鍵值 參數(shù) string $field　字段名 返回值： 完整的數(shù)據(jù) 或者 指定的$field字段值

check_document_position($pos = 0, $contain = 0)
說明：　文檔推薦位檢測．檢測文檔推薦位是否含有含有某個推薦位設(shè)置．例如，文檔推薦位的值為5，則 check_document_position(5, 1)和｀check_document_position(5, 4)｀都返回true，而check_document_position(5, 8)返回false．實際上，該函數(shù)做的是位檢測，所以也可以用于檢測其通過位相加保存數(shù)據(jù)的情況．
參數(shù) number $pos 推薦位的值（數(shù)據(jù)庫保存的字段值） 參數(shù) number $contain 推薦位值(推薦位定義) 返回　true 包含 ， false 不包含