如果你的插件需要后台管理功能,可以定义管理界面的字段信息,前提是[插件基本信息](插件基本信息.md)中要设置`admin`参数为1,表示你的插件有后台管理功能。
>[info] 管理界面的字段信息变量名为$admin。
管理界面的字段参数有以下几种:
| 参数 | 含义 | 类型 | 必填 |
| --- | --- | --- | --- |
| title | 后台管理标题 | string | 否 |
| table_name | 数据库表名,不含前缀。 | string | 否 |
| order | 需要排序功能的字段,多个字段用逗号隔开 | string | 否 |
| filter | 需要筛选功能的字段,多个字段用逗号隔开 | string | 否 |
| search_title | 搜索框提示文字,一般不用填写 | string | 否 |
| search_field | 需要搜索的字段,如果需要搜索,则必填,否则不填 | array | 否 |
| columns | 后台列表字段 | array | 是 |
| right_buttons | 右侧按钮 | array | 否 |
| top_buttons | 顶部栏按钮 | array | 否 |
~~~
<?php
namespace plugins\HelloWorld;
use app\common\controller\Plugin;
/**
* 演示插件
*/
class HelloWorld extends Plugin
{
/**
* @var array 插件信息
*/
public $info = [
// 插件名[必填]
'name' => 'HelloWorld',
// 插件标题[必填]
'title' => '你好,世界',
// 插件唯一标识[必填],格式:插件名.开发者标识.plugin
'identifier' => 'helloworld.ming.plugin',
// 插件图标[选填]
'icon' => 'fa fa-fw fa-globe',
// 插件描述[选填]
'description' => '这是一个演示插件,会在每个页面生成一个提示“Hello World”。您可以查看源码,里面包含了绝大部分插件所用到的方法,以及能做的事情。',
// 插件作者[必填]
'author' => 'CaiWeiMing',
// 作者主页[选填]
'author_url' => 'http://www.dolphinphp.com',
// 插件版本[必填],格式采用三段式:主版本号.次版本号.修订版本号
'version' => '1.0.0',
// 是否有后台管理功能
'admin' => '1',
];
/**
* @var string 原数据库表前缀
*/
public $database_prefix = 'dolphin_';
/**
* @var array 管理界面字段信息
*/
public $admin = [
'title' => '', // 后台管理标题
'table_name' => 'plugin_hello', // 数据库表名,如果没有用到数据库,则留空
'order' => 'said,name', // 需要排序功能的字段,多个字段用逗号隔开
'filter' => '', // 需要筛选功能的字段,多个字段用逗号隔开
'search_title' => '', // 搜索框提示文字,一般不用填写
'search_field' => [ // 需要搜索的字段,如果需要搜索,则必填,否则不填
'said' => '名言',
'name' => '出处'
],
// 后台列表字段
'columns' => [],
// 右侧按钮
'right_buttons' => [],
// 顶部栏按钮
'top_buttons' => []
];
/**
* 安装方法必须实现
*/
public function install(){
return true;
}
/**
* 卸载方法必须实现
*/
public function uninstall(){
return true;
}
}
~~~
### title
后台管理标题,也可以不写,不写时默认显示”数据列表“
### table_name
数据库表名,不包含表前缀,如:admin_user。
### order
字段排序,用法请参考[添加表头排序](添加表头排序.md)
### filter
字段筛选,用法参考[添加表头筛选](添加表头筛选.md)
一般这样使用
~~~
'filter' => '字段名1,字段名2'
~~~
>[info]1.0.7版本支持设置选项列表
~~~
'filter' => [
'pay_type' => [
['alipay' => '支付宝', 'wxpay' => '微信', 'unionpay' => '银联']
],
'pay_status' => [
['未支付', '已支付']
]
]
~~~
### search_field
需要搜索的字段,如果需要搜索,则必填,否则不填。
格式:`'字段名' => '字段标题'`,比如
~~~
'search_field' => [
'user_name' => '用户名',
'email' => '邮箱'
],
~~~
### search_title
搜索框的提示,一般无需设置
### columns
定义后台列表字段,用法请参考[添加多列](添加多列.md)的`addColumns`方法。
比如:
~~~
// 后台列表字段
'columns' => [
['id', 'ID'],
['said', '名言'],
['name', '出处'],
['status', '状态', 'switch'],
['right_button', '操作', 'btn'],
],
~~~
### right_buttons
定义右侧按钮
添加系统自带的右侧按钮
~~~
'right_buttons' => [
'edit', // 使用系统自带的编辑按钮
'enable', // 使用系统自带的启用按钮
'disable', // 使用系统自带的禁用按钮
'delete', // 使用系统自带的删除按钮
]
~~~
用法和[添加多个右侧按钮](添加多个右侧按钮.md)的数组方式一致,可以修改按钮的属性。
~~~
'right_buttons' => [
'edit' => ['title' => '编辑'], // 使用系统自带的编辑按钮
'enable', // 使用系统自带的启用按钮
'disable', // 使用系统自带的禁用按钮
'delete', // 使用系统自带的删除按钮
]
~~~
添加自定义右侧按钮
~~~
'right_buttons' => [
'customs' => [
[
'title' => '自定义按钮1,新窗口打开',
'icon' => 'fa fa-list',
'href' => [
'url' => 'HelloWorld/Admin/testTable',
],
'target' => '_blank',
]
]
]
~~~
>[info] 按钮的url链接请填写”插件名/控制器/方法“。
添加自定义右侧按钮并带有参数
~~~
'right_buttons' => [
'customs' => [
[
'title' => '自定义按钮2,自定义参数',
'icon' => 'fa fa-list',
'href' => [
'url' => 'HelloWorld/Admin/testTable',
'params' => [
'id' => '__id__',
'table' => '__table__',
'name' => 'molly',
'age' => 12
]
'target' => '_blank',
]
]
]
~~~
>[danger] 注意,如果要在链接上添加自定义参数,请在params上添加。
也可以定义多个自定义按钮
~~~
'right_buttons' => [
'customs' => [
[
'title' => '自定义按钮1,新窗口打开',
'icon' => 'fa fa-list',
'href' => [
'url' => 'HelloWorld/Admin/testTable',
],
'target' => '_blank',
],
[
'title' => '自定义按钮2,自定义参数',
'icon' => 'fa fa-list',
'href' => [
'url' => 'HelloWorld/Admin/testTable',
'params' => [
'id' => '__id__',
'table' => '__table__',
'name' => 'molly',
'age' => 12
]
'target' => '_blank',
]
]
]
~~~
>[danger] 注意,添加多个自定义按钮,不能有多个customs,多个按钮也是一起写在customs内容,以下写法是错误的。
~~~
'right_buttons' => [
'customs' => [
[
'title' => '自定义按钮1,新窗口打开',
'icon' => 'fa fa-list',
'href' => [
'url' => 'HelloWorld/Admin/testTable',
],
'target' => '_blank',
]
],
'customs' => [
[
'title' => '自定义按钮2,自定义参数',
'icon' => 'fa fa-list',
'href' => [
'url' => 'HelloWorld/Admin/testTable',
'params' => [
'id' => '__id__',
'table' => '__table__',
'name' => 'molly',
'age' => 12
]
'target' => '_blank',
]
]
]
~~~
### top_buttons
定义顶部按钮,用法和上面的基本相同。
添加系统自带的按钮
~~~
// 顶部栏按钮
'top_buttons' => [
'add', // 使用系统自带的添加按钮
'enable', // 使用系统自带的启用按钮
'disable',// 使用系统自带的禁用按钮
'delete', // 使用系统自带的删除按钮
'back', // 使用系统自带的返回按钮
// 自定义按钮,可定义多个
'customs' => [
[
'title' => '<i class="fa fa-list"></i> 自定义按钮1',
'href' => [
'url' => 'HelloWorld/Admin/testTable',
],
'target' => '_blank',
],
// 自定义按钮并带有参数
[
'title' => '<i class="fa fa-user"></i> 自定义按钮2',
'href' => [
'url' => 'HelloWorld/Admin/testForm',
'params' => [
'name' => 'molly',
'age' => 12
]
],
]
],
],
~~~
- 序言
- 环境搭建
- 下载及安装
- 目录结构
- 快速构建器(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文件
- 控制器
- 模型
- 验证器
- 视图
- 方法参考
- 实践教程
- 变量参考
- 函数参考
- 安全相关
- 常见问题
- 其他杂项
- 更新日志
- 升级指导
- 贡献名单
- 关于文档