cmf php,cmf公共函数解析-common.php

路径：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 转化后字符串

 
 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格式

 
 [ 
  "src"=>'图片链接', 
  "title"=>'图片标签的 title 属性', 
  "alt"=>'图片标签的 alt 属性' 
 ] 

| 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|