本框架的公共函数在:`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,可以是数组,也可以是逗号隔开的字符串 |
- 序言
- 环境搭建
- 下载及安装
- 目录结构
- 快速构建器(ZBuilder)
- 表单(form)
- 设置页面标题
- 设置页提示信息
- 设置表单提交地址
- 隐藏按钮
- 添加按钮
- 设置按钮标题
- 添加表单项
- 复选
- 单选
- 日期
- 时间
- 开关
- 标签
- 数组
- 分组
- 范围
- 按钮
- 数字框
- 密码框
- 取色器
- 下拉菜单
- 普通联动
- 快速联动
- 拖拽排序
- 静态文本
- 格式文本
- 日期时间
- 日期范围
- 图片裁剪
- 百度地图
- 单文件上传
- 多文件上传
- 单图片上传
- 多图片上传
- 隐藏表单项
- 图标选择器
- 单行文本框
- 多行文本框
- 百度编辑器
- CKEditor编辑器
- wang编辑器
- markdown编辑器
- summernote编辑器
- 图片展示(1.1.0+)
- 单文件展示(1.1.0+)
- 多文件展示(1.1.0+)
- 下拉菜单Ajax(1.3.3+)
- 复杂表格(1.4.3+)
- 数据表格(1.4.3+)
- 分组下拉菜单(1.4.3+)
- 表格选取(1.4.3+)
- 穿梭框(1.4.3+)
- 添加表单项通用方法
- 直接设置表单项
- 表单布局
- 设置Tab按钮列表
- 设置表单数据
- 引入js文件
- 引入css文件
- 设置额外JS代码
- 设置额外CSS样式
- 设置额外HTML代码
- 是否ajax方式提交
- 设置模版路径
- 设置触发器
- 设置表单提交确认框
- 自定义表单项(1.0.6+)
- 设置表单提交方式(1.0.6+)
- 模板变量赋值(1.0.7+)
- 设置页面空表单项提示(1.0.7+)
- 自定义扩展表单图标(1.2.0+)
- 设置表单令牌(1.3.1+)
- 新窗口打开返回的url(1.4.4+)
- 表格(table)
- 设置页面标题
- 设置页面提示信息
- 添加一列
- 字段类型
- switch
- status
- yesno
- text.edit
- textarea.edit
- password
- url
- tel
- number
- icon
- byte
- date
- time
- datetime
- date.edit
- time.edit
- datetime.edit
- picture
- pictures
- select
- callback
- link
- text
- img_url
- files(1.1.1+)
- popover(1.4.4+)
- 添加多列
- 添加数量索引
- 添加快捷编辑的验证器
- 设置表格数据
- 隐藏第一列多选框
- 添加表头排序
- 添加表头筛选
- 添加表头筛选条件
- 添加时间段筛选
- 添加一个右侧按钮
- 添加多个右侧按钮
- 添加一个顶部按钮
- 添加多个顶部按钮
- 自动添加按钮
- 自动编辑按钮
- 替换右侧按钮
- 设置搜索参数
- 设置数据库表名
- 设置插件名称
- 设置表格主键
- 设置Tab按钮列表
- 设置分页
- 去除分页
- 引入js文件
- 引入css文件
- 设置额外JS代码
- 设置额外CSS样式
- 设置额外HTML代码
- 设置额外HTML代码-模板文件(1.4.0+)
- 设置模版路径
- 添加行class名
- 添加顶部下拉筛选
- 设置页面空数据提示(1.0.7+)
- 模板变量赋值(1.0.7+)
- 设置使用原始数据字段(1.0.8+)
- 设置搜索区域(1.1.0+)
- 设置表格高度(1.3.0+)
- 固定左列(1.3.0+)
- 固定右列(1.3.0+)
- 设置列宽(1.3.0+)
- 设置隐藏列(1.3.0+)
- 侧栏(aside)
- 添加区块
- 设置Tab按钮列表
- 追加Tab按钮列表
- 设置当前tab
- 设置单个tab内容
- 设置多个tab内容
- 追加tab内容
- 覆盖侧栏
- 模块开发
- 创建模块信息文件
- 安装模块
- 模块配置
- 控制器
- 创建菜单节点
- 第一个控制器
- 模块参数配置页面
- 方法参考
- 数据授权(1.3.2+)
- 插件开发
- 插件入口文件
- 插件基本信息
- 管理界面的字段信息
- 新增或编辑的字段信息
- 插件钩子
- 触发器
- 原数据库表前缀
- 插件配置信息
- 安装和卸载Sql文件
- 控制器
- 模型
- 验证器
- 视图
- 方法参考
- 实践教程
- 变量参考
- 函数参考
- 安全相关
- 常见问题
- 其他杂项
- 更新日志
- 升级指导
- 贡献名单
- 关于文档