cmf公共函數解析-common.php · thinkphp與thinkcmf點滴學習

路徑：thinkcmf\simplewind\cmf\common.php 方法： | 方法 | 作用 |返回值| | --- | --- |---| | cmf_get_current_admin_id | 獲取當前登錄的管理員ID |@return int| | cmf_is_user_login | 判斷前臺用戶是否登錄 |@return boolean| | cmf_get_current_user | 獲取當前登錄的前臺用戶的信息，未登錄時，返回false |@return array|boolean| | cmf_update_current_user |更新當前登錄前臺用戶的信息 |@param array $user 前臺用戶的信息| | cmf_get_domain | 返回帶協議的域名 |返回帶協議的域名| | cmf_get_root | 獲取網站根目錄 |@return string 網站根目錄| | cmf_get_current_theme | 獲取當前主題名 |@return string| | cmf_get_theme_path | 獲取前臺模板根目錄 |@param string $theme @return string 前臺模板根目錄| | cmf_get_current_user_id | 獲取當前登錄前臺用戶id |@param string $theme @return string 前臺模板根目錄| | cmf_get_current_user_id | 獲取當前登錄前臺用戶id |@return int| | cmf_get_current_user_id | 獲取當前登錄前臺用戶id |@return int| | cmf_get_user_avatar_url | 獲取用戶頭像地址 |@param $avatar 用戶頭像文件路徑,相對于 upload 目錄 @return string| | cmf_password | CMF密碼加密方法 |@param string $pw 要加密的原始密碼 @param string $authCode 加密字符串 @return string| | cmf_password_old | CMF密碼加密方法 (X2.0.0以前的方法) | @param string $pw 要加密的原始密碼 @return string| | cmf_compare_password | CMF密碼比較方法,所有涉及密碼比較的地方都用這個方法 |@param string $password 要比較的密碼 @param string $passwordInDb 數據庫保存的已經加密過的密碼 @return boolean 密碼相同，返回true| | cmf_log | 文件日志 |@param $content 要寫入的內容 @param string $file 日志文件,在web 入口目錄| | cmf_random_string | 隨機字符串生成 |@param int $len 生成的字符串長度 @return string| | cmf_clear_cache | 清空系統緩存 |無| | cmf_save_var | 保存數組變量到php文件 |@param string $path 保存路徑 @param mixed $var 要保存的變量 @return boolean 保存成功返回true,否則false| | cmf_set_dynamic_config | 設置動態配置 |@param array $data 如：["cmf_default_theme"=>'simpleboot3']; @return boolean| | cmf_param_lable | 轉化格式化的字符串為數組 | @param string $tag 要轉化的字符串,格式如:"id:2;cid:1;order:post_date desc;" @return array 轉化后字符串<pre> array( 'id'=>'2', 'cid'=>'1', 'order'=>'post_date desc' )| | cmf_get_site_info | 獲取后臺管理設置的網站信息，此類信息一般用于前臺 |@return int| | cmf_get_cmf_setting | 獲取CMF系統的設置，此類設置用于全局 | @return array| | cmf_set_cmf_setting($data) | 更新CMF系統的設置，此類設置用于全局 |@param array $data @return boolean| | cmf_set_option | 設置系統配置，通用 |@param string $key 配置鍵值,都小寫 @param array $data 配置值，數組 @param bool $replace 是否完全替換 @return bool 是否成功| | cmf_get_option | 獲取系統配置，通用 |@param string $key 配置鍵值,都小寫 @return array| | cmf_get_upload_setting | 獲取CMF上傳配置 | return $uploadSetting;| | cmf_get_content_images | 獲取html文本里的img |@param string $content html 內容 @return array 圖片列表數組item格式<pre> [ "src"=>'圖片鏈接', "title"=>'圖片標簽的 title 屬性', "alt"=>'圖片標簽的 alt 屬性' ] </pre>| | cmf_strip_chars | 去除字符串中的指定字符 |@@param string $str 待處理字符串 @param string $chars 需去掉的特殊字符 @return string| | cmf_send_email | 發送郵件 |@param string $address 收件人郵箱 @param string $subject 郵件標題 @param string $message 郵件內容 @return array 返回格式： array( "error"=>0|1,//0代表出錯 "message"=> "出錯信息" );| | cmf_get_asset_url | 轉化數據庫保存的文件路徑，為可以訪問的url |@param string $file @param mixed $style 圖片樣式,支持各大云存儲 @return string| | cmf_get_image_url | 轉化數據庫保存圖片的文件路徑，為可以訪問的url |@param string $file 文件路徑，數據存儲的文件相對路徑 @param string $style 圖片樣式,支持各大云存儲 @return string 圖片鏈接| | cmf_get_image_preview_url | 獲取圖片預覽鏈接 |@param string $file 文件路徑，相對于upload @param string $style 圖片樣式,支持各大云存儲 @return string| | cmf_get_file_download_url | 獲取文件下載鏈接 |@param string $file 文件路徑，數據庫里保存的相對路徑 @param int $expires 過期時間，單位 s @return string 文件鏈接| | cmf_str_encode | 加密字符串 |@param $string 要加密的字符串 @param string $key salt @param int $expiry 多少秒后過期 @return bool|string| | cmf_str_decode | 解密用cmf_str_encode加密的字符串 |@param $string 要解密的字符串 @param string $key 加密時salt @param int $expiry 多少秒后過期 @param string $operation 操作,默認為DECODE @return bool|string| | cmf_asset_relative_url | 獲取文件相對路徑 |@param string $assetUrl 文件的URL @return string| | cmf_check_user_action | 檢查用戶對某個url內容的可訪問性，用于記錄如是否贊過，是否訪問過等等;開發者可以自由控制，對于沒有必要做的檢查可以不做，以減少服務器壓力 |@param string $object 訪問對象的id,格式：不帶前綴的表名+id;如post1表示xx_post表里id為1的記錄;如果object為空，表示只檢查對某個url訪問的合法性 @param int $countLimit 訪問次數限制,如1，表示只能訪問一次 @param boolean $ipLimit ip限制,false為不限制，true為限制 @param int $expire 距離上次訪問的最小時間單位s，0表示不限制，大于0表示最后訪問$expire秒后才可以訪問 @return true 可訪問，false不可訪問| | cmf_is_mobile | 判斷是否為手機訪問 |@return boolean| | cmf_is_wechat | 判斷是否為微信訪問 |@return boolean| | hook | 添加鉤子 |@param string $hook 鉤子名稱 @param mixed $params 傳入參數 @param mixed $extra 額外參數 @return void| | hook_one | 添加鉤子,只執行一個 |@param string $hook 鉤子名稱 @param mixed $params 傳入參數 @param mixed $extra 額外參數 @return mixed| | cmf_get_plugin_class | 獲取插件類的類名 |@param string $name 插件名 @return string| | cmf_get_plugin_config | 獲取插件類的配置 |@param string $name 插件名 @return array| | cmf_scan_dir | 替代scan_dir的方法 |@param string $pattern 檢索模式搜索模式 *.txt,*.doc; (同glog方法) @param int $flags @param $pattern @return array| | cmf_sub_dirs | 獲取某個目錄下所有子目錄 |@param $dir @return array| | cmf_plugin_url | 生成訪問插件的url |@param string $url url格式：插件名://控制器名/方法 @param array $param 參數 @param bool $domain 是否顯示域名或者直接傳入域名 @return string| | cmf_auth_check | 檢查權限 |@param $userId int 要檢查權限的用戶 ID @param $name string|array 需要驗證的規則列表,支持逗號分隔的權限規則或索引數組 @param $relation string 如果為 'or' 表示滿足任一條規則即通過驗證;如果為 'and'則表示需滿足所有規則才能通過驗證 @return boolean 通過驗證返回true;失敗返回false| | cmf_alpha_id | 創造短ID |無| | cmf_captcha_check | 驗證碼檢查，驗證完后銷毀驗證碼 |@param string $value @param string $id @return bool| | cmf_split_sql | 切分SQL文件成多個可以單獨執行的sql語句 |@param $file sql文件路徑 @param $tablePre 表前綴 @param string $charset 字符集 @param string $defaultTablePre 默認表前綴 @param string $defaultCharset 默認字符集 @return array| | cmf_current_lang | 判斷當前的語言包，并返回語言包名 |@return string 語言包名| | cmf_get_order_sn | 獲取惟一訂單號 |@return string| | cmf_get_file_extension | 獲取文件擴展名 |@param string $filename 文件名 @return string 文件擴展名| | cmf_get_verification_code | 檢查手機或郵箱是否還可以發送驗證碼,并返回生成的驗證碼 |@param string $account 手機或郵箱 @param integer $length 驗證碼位數,支持4,6,8 @return string 數字驗證碼| | cmf_verification_code_log | 更新手機或郵箱驗證碼發送日志 |@param string $account 手機或郵箱 @param string $code 驗證碼 @param int $expireTime 過期時間 @return boolean| | cmf_check_verification_code | 手機或郵箱驗證碼檢查，驗證完后銷毀驗證碼增加安全性,返回true驗證碼正確，false驗證碼錯誤 |@param string $account 手機或郵箱 @param string $code 驗證碼 @param boolean $clear 是否驗證后銷毀驗證碼 @return string 錯誤消息,空字符串代碼驗證碼正確| | cmf_clear_verification_code | 清除某個手機或郵箱的數字驗證碼,一般在驗證碼驗證正確完成后 |@param string $account 手機或郵箱 @return boolean true：手機驗證碼正確，false：手機驗證碼錯誤| | file_exists_case | 區分大小寫的文件存在判斷 |@param string $filename 文件地址 @return boolean| | cmf_generate_user_token | 生成用戶 token |@param $userId @param $deviceType @return string 用戶 token| | cmf_parse_name | 字符串命名風格轉換 type 0 將Java風格轉換為C的風格 1 將C風格轉換為Java的風格 |@param string $name 字符串 @param integer $type 轉換類型 @param bool $ucfirst 首字母是否大寫（駝峰規則） @return string| | cmf_is_serialized | 判斷字符串是否為已經序列化過 |@param $str @return bool| | cmf_is_ssl | 判斷是否SSL協議 |@return int| | cmf_get_cmf_settings | 獲取CMF系統的設置，此類設置用于全局 |@param string $key 設置key，為空時返回所有配置信息 @return mixed| | cmf_is_sae | 判讀是否sae環境 |@return bool| | get_client_ip | 獲取客戶端IP地址 |@param integer $type 返回類型 0 返回IP地址 1 返回IPV4地址數字 @param boolean $adv 是否進行高級模式獲取（有可能被偽裝） @return string| | cmf_url_encode | 生成base64的url,用于數據庫存放 url |@param $url 路由地址，如控制器/方法名，應用/控制器/方法名 @param $params url參數 @return string| | cmf_url | CMF Url生成 |@return int| | cmf_is_installed | 判斷 cmf 核心是否安裝 |@param string $url 路由地址 @param string|array $vars 變量 @param bool|string $suffix 生成的URL后綴 @param bool|string $domain 域名 @return string| | cmf_replace_content_file_url | 替換編輯器內容中的文件地址 |@param string $content 編輯器內容 @param boolean $isForDbSave true:表示把絕對地址換成相對地址,用于數據庫保存,false:表示把相對地址換成絕對地址用于界面顯示 @return string| | cmf_get_admin_style | 獲取后臺風格名稱 |@return string| | cmf_curl_get | curl get 請求 |@param $url @return mixed| | cmf_user_action | 用戶操作記錄 |@param string $action 用戶操作| | cmf_api_request | 使用CURL發送POST請求 |@return json| | cmf_is_open_registration | 判斷是否允許開放注冊 |@return bool|