如果你的插件需要后臺管理功能,可以定義管理界面的字段信息,前提是[插件基本信息](插件基本信息.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文件
- 控制器
- 模型
- 驗證器
- 視圖
- 方法參考
- 實踐教程
- 變量參考
- 函數參考
- 安全相關
- 常見問題
- 其他雜項
- 更新日志
- 升級指導
- 貢獻名單
- 關于文檔