本框架的公共函数在:applicationcommon.php
如果是自定义公共函数,请写在:applicationfunction.php
以下列举部分函数,具体用法及其他函数请参考源码。
is_signin
含义:判断是否登录
返回:0或用户id
get_file_path($id)
含义:获取附件路径
返回:附件路径,如果无附件,则返回一张空图片路径
参数 | 类型 | 含义 |
---|---|---|
$id | int | 附件id |
get_files_path($ids)
含义:批量获取附件路径
返回:附件路径
参数 | 类型 | 含义 |
---|---|---|
$id | array | 附件id |
get_file_name
含义:获取附件名称
返回:附件名称
参数 | 类型 | 含义 |
---|---|---|
$id | int | 附件id |
get_thumb
含义:获取附件缩略图路径
返回:缩略图路径,如果无缩略图,则返回原图路径
参数 | 类型 | 含义 |
---|---|---|
$id | int | 附件id |
get_avatar
含义:获取用户头像路径
返回:头像路径,如果无头像,则返回默认头像路径
参数 | 类型 | 含义 |
---|---|---|
$uid | int | 用户id,不传该参数则获取当前用户id |
parse_attr
含义:解析配置,按每行为一个数组元素组合成数组
返回:数组
参数 | 类型 | 含义 |
---|---|---|
$value | string | 配置值 |
parse_array
含义:将一维数组解析成键值相同的数组
返回:数组
参数 | 类型 | 含义 |
---|---|---|
$arr | array | 一维数组 |
hook
含义:监听钩子
返回:无
参数 | 类型 | 含义 |
---|---|---|
$name | string | 钩子名称 |
$params | string | 传入参数 |
$extra | string | 额外参数 |
$once | string | 只获取一个有效返回值 |
module_config
含义:显示模块配置页面,或获取或设置插件配置
返回:mixed
具体用法,请参考模块开发中的方法参考
plugin_menage
含义:显示插件的管理页面
返回:mixed
具体用法请参考方法参考
plugin_config
含义:获取或设置某个插件配置参数
返回:mixed
具体用法请参考方法参考
plugin_action
含义:执行插件动作
返回:mixed
具体用法请参考方法参考
plugin_action_exists
含义:检查插件控制器是否存在某操作
返回:bool
参数 | 类型 | 含义 |
---|---|---|
$name | string | 插件名 |
$controller | string | 控制器 |
$action | string | 动作 |
plugin_model_exists
含义:检查插件模型是否存在
返回:bool
参数 | 类型 | 含义 |
---|---|---|
$name | string | 插件名 |
plugin_validate_exists
含义:检查插件验证器是否存在
返回:bool
参数 | 类型 | 含义 |
---|---|---|
$name | string | 插件名 |
get_plugin_validate
含义:获取插件验证类实例
返回:object
参数 | 类型 | 含义 |
---|---|---|
$name | string | 插件名 |
get_plugin_model
含义:获取插件模型实例
返回:object
参数 | 类型 | 含义 |
---|---|---|
$name | string | 插件名 |
get_plugin_class
含义:获取插件类名
返回:string
plugin_url
含义:生成插件操作链接
返回:string
参数 | 类型 | 含义 |
---|---|---|
$url | string | 链接:插件名称/控制器/操作 |
$param | array | 参数 |
$module | string | admin需要登录验证,index不需要登录验证 |
public_url
含义:生成插件操作链接(不需要登陆验证)
返回:string
参数 | 类型 | 含义 |
---|---|---|
$url | string | 链接:插件名称/控制器/操作 |
$param | array | 参数 |
get_client_ip
含义:获取客户端IP地址
返回:mixed
参数 | 类型 | 含义 |
---|---|---|
$type | int | 返回类型 0 返回IP地址 1 返回IPV4地址数字 |
$adv | bool | 是否进行高级模式获取 |
format_bytes
含义:格式化字节大小
返回:string
参数 | 类型 | 含义 |
---|---|---|
$size | int | 字节数 |
$delimiter | string | 数字和单位分隔符 |
format_time
含义:时间戳格式化
返回:string
参数 | 类型 | 含义 |
---|---|---|
$time | int | 时间戳 |
$format | string | 输出格式,默认为Y-m-d H:i |
format_linkage
含义:格式化联动数据,array("a", "b")将格式化为array(array("key" => 0, "value" => "a"), array("key" => 1, "value" => "b"))
返回:string
参数 | 类型 | 含义 |
---|---|---|
$data | array | 要格式化的数据 |
get_auth_node
含义:获取用户的数据授权节点
返回:array|bool
参数 | 类型 | 含义 |
---|---|---|
$uid | int | 用户id |
$group | string | 权限分组,可以以点分开模型名称和分组名称,如user.group |
check_auth_node
含义:检查用户的某个节点是否授权
返回:bool
参数 | 类型 | 含义 |
---|---|---|
$uid | int | 用户id |
$group | string | 权限分组,可以以点分开模型名称和分组名称,如user.group |
$node | int | 需要检查的节点id |
get_nickname
含义:获取用户昵称
返回:string
参数 | 类型 | 含义 |
---|---|---|
$uid | int | 用户id |
action_log
含义:记录行为日志,并执行该行为的规则
返回:bool|string
参数 | 类型 | 含义 |
---|---|---|
$action | string | 行为标识 |
$model | string | 触发行为的模型名 |
$record_id | int | 触发行为的记录id |
$user_id | int | 执行行为的用户id |
$details | string | 详情 |
get_location
含义:获取当前位置
返回:array
packet_exists
含义:查询数据包是否存在,即是否已经安装
返回:array
参数 | 类型 | 含义 |
---|---|---|
$name | string | 数据包名 |
load_assets
含义:返回静态资源路径代码,可用于模板
返回:string
参数 | 类型 | 含义 |
---|---|---|
$assets | string | 资源名称 |
$type | string | 资源类型:css或js |
parse_name
含义:字符串命名风格转换
返回:string
参数 | 类型 | 含义 |
---|---|---|
$name | string | 字符串 |
$type | string | 转换类型,0 将Java风格转换为C的风格 1 将C风格转换为Java的风格 |
index_url(1.0.4+)
含义:生成前台入口url
返回:string
用法和ThinkPHP自带的url方法一致,参数也一致。
admin_url(1.0.4+)
含义:生成后台入口url
返回:string
用法和ThinkPHP自带的url方法一致,参数也一致。
htmlpurifier(1.0.5+)
含义:html安全过滤
返回:string
参数 | 类型 | 含义 |
---|---|---|
$html | string | 要过滤的内容 |