addFilter("字段名" [, "选项", "默认选项", "筛选方式"])
表头筛选是属于精确筛选。
版本 | 改进 |
---|---|
1.0.4 | 新增“筛选方式”参数,支持单选 |
1.0.6 | 新增addFilterList()方法,支持自定义筛选列表,非读取数据库 |
// 读取用户数据
$data_list = Db::name("admin_user")->select();
// 使用ZBuilder构建数据表格
return ZBuilder::make("table")
->addOrder("id,username") // 添加排序
->addFilter("id,username") // 添加筛选
->addColumn("id", "ID")
->addColumn("username", "用户名")
->addColumn("nickname", "昵称")
->addColumn("email", "邮箱")
->addColumn("mobile", "手机号")
->addColumn("create_time", "创建时间")
->setRowList($data_list) // 设置表格数据
->fetch();
添加好筛选字段后,还需要在查询数据之前获取筛选的数据,使用$this->getMap()
即可。
// 获取排序
$order = $this->getOrder();
// 获取筛选
$map = $this->getMap();
// 读取用户数据
$data_list = Db::name("admin_user")->where($map)->order($order)->select();
// 使用ZBuilder构建数据表格
return ZBuilder::make("table")
->addOrder("id,username") // 添加排序
->addFilter("id,username") // 添加筛选
->addColumn("id", "ID")
->addColumn("username", "用户名")
->addColumn("nickname", "昵称")
->addColumn("email", "邮箱")
->addColumn("mobile", "手机号")
->addColumn("create_time", "创建时间")
->setRowList($data_list) // 设置表格数据
->fetch();
点击字段筛选,弹出对话框,可以选择要显示的数据,也可以动态搜索。
注意,点击筛选后,会默认在当前表查询结果,如果当前表没有数据,则查询结果为空。
使用数组方式
除了可以以字符串的形式填写要筛选的字段外,还可以用数组的形式。
// 使用ZBuilder构建数据表格
return ZBuilder::make("table")
->addFilter(["id","username"]) // 添加筛选
->fetch();
指定其他表的字段
同样的,如果要筛选的字段不在当前表,需指定表名,比如数据是用视图查询获得的。
// 使用ZBuilder构建数据表格
return ZBuilder::make("table")
->addFilter("admin_action.username,nickname") // 添加筛选
->fetch();
也可以用数组的方式写,格式为"字段名" => "表名"
// 使用ZBuilder构建数据表格
return ZBuilder::make("table")
->addFilter(["title" => "admin_action", "username"]) // 添加筛选
->fetch();
或者
// 使用ZBuilder构建数据表格
return ZBuilder::make("table")
->addFilter(["admin_action.title", "username"]) // 添加筛选
->fetch();
如果设置的字段别名,也可以指定其他表,并且指定其他字段名,格式为:字段别名 => "表名.字段名"
// 使用ZBuilder构建数据表格
return ZBuilder::make("table")
->addFilter(["module_title" => "admin_module.title"]) // 添加筛选
->fetch();
其中module_title
是字段别名。
具体使用请参考系统的“日志管理”源码。
还有一种情况,比如某个字段只是代号,真正需要显示的数据在另外一张表或自己构造的数据。
比如系统的“配置管理”页面,假设列是这么定义的.
// 使用ZBuilder构建数据表格
return ZBuilder::make("table")
->addColumns([ // 批量添加数据列
["name", "名称", "text.edit"],
["title", "标题", "text.edit"],
["type", "类型"],
["status", "状态", "switch"],
["sort", "排序", "text.edit"],
["right_button", "操作", "btn"]
])
->fetch();
显示的出来的数据大致是这样的
我们希望用中文来代替这些值,这里我们设置type类型为select(下拉编辑),并设置下拉选项数据config("form_item_type")
// 使用ZBuilder构建数据表格
return ZBuilder::make("table")
->addColumns([ // 批量添加数据列
["name", "名称", "text.edit"],
["title", "标题", "text.edit"],
["type", "类型", "select", config("form_item_type")],
["status", "状态", "switch"],
["sort", "排序", "text.edit"],
["right_button", "操作", "btn"]
])
->fetch();
config("form_item_type")是一个一维数组,取出来的数据是这样的
array( "text" => "单行文本" "textarea" => "多行文本" "static" => "静态文本" "password" => "密码" "checkbox" => "复选框" "radio" => "单选按钮" "date" => "日期" "datetime" => "日期+时间" "hidden" => "隐藏" "switch" => "开关" "array" => "数组" "select" => "下拉框" "linkage" => "普通联动下拉框" "linkages" => "快速联动下拉框" "image" => "单张图片" "images" => "多张图片" "file" => "单个文件" "files" => "多个文件" "ueditor" => "UEditor 编辑器" "wangeditor" => "wangEditor 编辑器" "editormd" => "markdown 编辑器" "icon" => "字体图标" "tags" => "标签" "number" => "数字" )
这样设置之后的最终结果是
我们对type字段添加筛选功能
// 使用ZBuilder构建数据表格
return ZBuilder::make("table")
->addColumns([ // 批量添加数据列
["name", "名称", "text.edit"],
["title", "标题", "text.edit"],
["type", "类型", "select", config("form_item_type")],
["status", "状态", "switch"],
["sort", "排序", "text.edit"],
["right_button", "操作", "btn"]
])
->addFilter("type") // 添加标题字段筛选
->fetch();
点击筛选图标之后,会发现结果是这样
因为数据表里面存储的就是这样的数据,如果我们希望这些数据也能转换显示,那该怎么办呢?
只要将对应的数据,也就是上面config("form_item_type")
的一维数组放在第二个参数即可,系统会对应显示。
// 使用ZBuilder构建数据表格
return ZBuilder::make("table")
->addColumns([ // 批量添加数据列
["name", "名称", "text.edit"],
["title", "标题", "text.edit"],
["type", "类型", "select", config("form_item_type")],
["status", "状态", "switch"],
["sort", "排序", "text.edit"],
["right_button", "操作", "btn"]
])
->addFilter("type", config("form_item_type")) // 添加标题字段筛选
->fetch();
最终显示结果
注意,这种写法只能一个一个写,下面的写法是错误的
->addFilter("type,title", config("form_item_type")) // 错误写法
默认选项
如果需要默认设置筛选,可以使用第三个参数。
// 使用ZBuilder构建数据表格
return ZBuilder::make("table")
->addColumns([ // 批量添加数据列
["name", "名称", "text.edit"],
["title", "标题", "text.edit"],
["type", "类型", "select", config("form_item_type")],
["status", "状态", "switch"],
["sort", "排序", "text.edit"],
["right_button", "操作", "btn"]
])
->addFilter("name", [], ["name" => "web_site_icp,web_site_keyword"]) // 添加标题字段筛选
->fetch();
上面表示初始状态下,字段筛选默认点亮字段名为name的字段,并且选中值为web_site_icp和web_site_keyword的选项。
也可以指定多个字段
// 使用ZBuilder构建数据表格
return ZBuilder::make("table")
->addColumns([ // 批量添加数据列
["name", "名称", "text.edit"],
["title", "标题", "text.edit"],
["type", "类型", "select", config("form_item_type")],
["status", "状态", "switch"],
["sort", "排序", "text.edit"],
["right_button", "操作", "btn"]
])
->addFilter("title", [], ["name" => "web_site_icp,web_site_keyword", "title" => ["备案信息"]]) // 添加标题字段筛选
->fetch();
指定当前表的其他字段名
// 使用ZBuilder构建数据表格
return ZBuilder::make("table")
->addColumns([ // 批量添加数据列
["name", "名称", "text.edit"],
["title", "标题", "text.edit"],
["type", "类型", "select", config("form_item_type")],
["status", "状态", "switch"],
["sort", "排序", "text.edit"],
["right_button", "操作", "btn"]
])
->addFilter("type", config("form_item_type"), ["title|title2" => ["备案信息"]]) // 添加标题字段筛选
->fetch();
以上表示点亮字段为title的列,但是查询数据实际查询的不是title字段,而是title2字段。
指定其他表的其他字段名
// 使用ZBuilder构建数据表格
return ZBuilder::make("table")
->addColumns([ // 批量添加数据列
["name", "名称", "text.edit"],
["title", "标题", "text.edit"],
["type", "类型", "select", config("form_item_type")],
["status", "状态", "switch"],
["sort", "排序", "text.edit"],
["right_button", "操作", "btn"]
])
->addFilter("type", config("form_item_type"), ["title|admin_article.title" => ["备案信息"]]) // 添加标题字段筛选
->fetch();
以上表示点亮字段为title的列,但是查询数据实际查询的是admin_article表的title字段。
注意,设置默认选项只是页面上点亮指定的字段列,并选中指定的字段值,实际查询的时候,需要自己添加查询条件。比如默认选择name字段的web_site_icp和web_site_keyword,那么在查询时需将条件先设定好。
// 设置查询条件
$map = $this->getMap();
if (empty($map)) {
// 默认情况下,查询name字段的值为web_site_icp和web_site_keyword
$map["name"] = ["in", "web_site_icp,web_site_keyword"];
}
// 查询数据
$data_list = ConfigModel::where($map)->paginate();
// 使用ZBuilder构建数据表格
return ZBuilder::make("table")
->addColumns([ // 批量添加数据列
["name", "名称", "text.edit"],
["title", "标题", "text.edit"],
["type", "类型", "select", config("form_item_type")],
["status", "状态", "switch"],
["sort", "排序", "text.edit"],
["right_button", "操作", "btn"]
])
->addFilter("type", config("form_item_type"), ["name" => "web_site_icp,web_site_keyword"]) // 添加标题字段筛选
->fetch();
筛选方式
从1.0.4版本开始,字段筛选支持单选方式,只要添加第四个参数为“radio
”即可
// 使用ZBuilder构建数据表格
return ZBuilder::make("table")
->addColumns([ // 批量添加数据列
["name", "名称", "text.edit"],
["title", "标题", "text.edit"],
["type", "类型", "select", config("form_item_type")],
["status", "状态", "switch"],
["sort", "排序", "text.edit"],
["right_button", "操作", "btn"]
])
->addFilter("type", [], [], "radio") // 添加标题字段筛选
->fetch();
addFilterList("字段名", "需要显示的列表" [, "默认选项", "筛选方式"])
此方法1.0.6版本开始支持。
用法和addFilter类似,第二个参数填写一个一维数组即可,数组的key为要查询的内容,value为显示的内容。
// 使用ZBuilder构建数据表格
return ZBuilder::make("table")
->addColumns([ // 批量添加数据列
["name", "名称", "text.edit"],
["title", "标题", "text.edit"],
["type", "类型", "select", config("form_item_type")],
["status", "状态", "switch"],
["sort", "排序", "text.edit"],
["right_button", "操作", "btn"]
])
->addFilterList("status", ["关闭", "开启"])
->fetch();
默认值
// 使用ZBuilder构建数据表格
return ZBuilder::make("table")
->addColumns([ // 批量添加数据列
["name", "名称", "text.edit"],
["title", "标题", "text.edit"],
["type", "类型", "select", config("form_item_type")],
["status", "状态", "switch"],
["sort", "排序", "text.edit"],
["right_button", "操作", "btn"]
])
->addFilterList("status", ["关闭", "开启"], "0")
->fetch();
如果多个默认值,可以使用逗号隔开,或者使用数组形式。
->addFilterList("status", ["关闭", "开启"], "0,1")
或者
->addFilterList("status", ["关闭", "开启"], [0,1])
筛选方式
默认为多选,可以改为单选。
// 使用ZBuilder构建数据表格
return ZBuilder::make("table")
->addColumns([ // 批量添加数据列
["name", "名称", "text.edit"],
["title", "标题", "text.edit"],
["type", "类型", "select", config("form_item_type")],
["status", "状态", "switch"],
["sort", "排序", "text.edit"],
["right_button", "操作", "btn"]
])
->addFilterList("status", ["关闭", "开启"], "", "radio")
->fetch();