功能描述
请根据图片上的数字索引查看对应功能说明。
1.时间筛选器
如果想在搜索栏使用时间区间进行搜索,则可以在JS中修改修改字段属性,如
{field: 'createtime', title: __('Create Time'), formatter: Table.api.formatter.datetime, operate: 'BETWEEN', type: 'datetime', addclass: 'datetimepicker', data: 'data-date-format="YYYY-MM-DD"'},
其中type
为类型,使用datetime
将会把结果转换成时间戳进行搜索,如果你的数据库存储的是日期时间型数据,则移除该type
属性,data
指附件到input文本框上的属性
最新版FastAdmin已经支持用户体验更好的datetimerange
插件,使用方式是:
{field:'createtime', title: __('Create Time'), formatter: Table.api.formatter.datetime, operate: 'RANGE', addclass:'datetimerange'}
2.状态列表
默认我们的搜索都是一个文本框,如果需要改成下拉列表框,则需要使用如下代码
{field: 'status', title: __('Status'), formatter: Table.api.formatter.status, searchList: {'normal': __('Normal'), 'hidden': __('Hidden')}, style: 'min-100px;'},
其中searchList
使用的是一个JSON数据,同时searchList
仍然支持数据、JSON对象、Ajax对象、Function函数。
普通搜索栏的搜索荐默认都是全部启用的,如果想禁用字段在普通搜索栏的显示,可以在字段属性中添加operate: false
来禁用,如下方代码
{field: 'status', title: __('Status'), operate:false, formatter: Table.api.formatter.status}
3.添加、编辑、删除、导入、批量操作按钮
FastAdmin的添加、编辑、删除按钮默认是由{:build_toolbar()}
生成的,默认是全部生成。如果我们只需要其中的部分按钮,则可以传入参数来实现,如{:build_toolbar('refresh,add')}
,这样将只会生成刷新和添加按钮。同时也支持调整参数的位置来调整最后生成的位置,另外请注意{:build_toolbar()}
还会根据当前管理员的权限判断按钮是否显示,例如你使用{:build_toolbar('refresh,add')}
,如果当前管理员没有添加的权限,添加按钮仍然不会显示 。
目前build_toolbar
支持的按钮有:
refresh: 刷新按钮
add: 添加
edit: 编辑
del: 删除
import: 导入
批量操作按钮是直接在视图页面上添加的HTML代码,直接修改即可。
启用导入请参考:https://forum.fastadmin.net/d/540
4.自定义搜索
FastAdmin中的Bootstrap-table
表格的自定义搜索功能是非常强大的,我们可以按需要修改来实现自己的搜索功能,这里实现的功能是点击自定义搜索
则发起搜索分类ID为1的数据,代码如下:
$(document).on("click", ".btn-singlesearch", function () {
var options = table.bootstrapTable('getOptions');
options.pageNumber = 1;
options.queryParams = function (params) {
return {
search: params.search,
sort: params.sort,
order: params.order,
filter: JSON.stringify({category_id: 1}),
op: JSON.stringify({category_id: '='}),
offset: params.offset,
limit: params.limit,
};
};
table.bootstrapTable('refresh', {});
Toastr.info("当前执行的是自定义搜索");
return false;
});
首先我们为自定义搜索这个按钮绑定上点击事件,这样当我们点击按钮时则发起搜索请求。其次注意我们获取了Bootstra-table表格的属性配置,并修改了其中的pageNumber
和queryParams
,pageNumber
指页码置为第一页,queryParams
是这里的重点,我们修改了其中的filter
和op
,filter
是我们的过滤条件,op
是我们的条件操作符,操作符支持=、!=、LIKE、NOT LIKE、>、>=、<、<=、IN(...)、NOT IN(...)、BETWEEN、NOT BETWEEN、LIKE %...%、IS NULL、IS NOT NULL
,这里的filter
和op
支持同时搜索多个条件。
5.快速搜索
快速搜索在键入关键词时将实时从服务端搜索数据,如果你的数据表数据较大,建议关闭此功能,关闭的方法是使用search:false
,其次快速搜索默认只会搜索主键id
这个字段,如果你需要搜索其它字段,则需要在服务端你的控制器中定义$searchFields
这个值,如下
protected $searchFields = 'id,name,title';
这样在快速搜索时将会搜索id,name,title
这三个字段。
如果需要修改默认文本框的placeholder
,可以在表格初始化前定义
$.fn.bootstrapTable.locales[Table.defaults.locale]['formatSearch'] = function(){return "自定义placeholder文本";};
6.浏览模式、显示隐藏列、导出、通用搜索
浏览模式可以切换卡片视图和表格视图两种模式,如果不需要此功能,可以设置showToggle: false
显示隐藏列可以快速切换字段列的显示和隐藏,如果不需要此功能,可以设置showColumns: false
,如果想要表格中的字段列默认隐藏可以设置字段属性visible: false
即可默认隐藏
导出按钮默认将导出整个表的所有行,如果需要仅导出当前分页的数据,需要设置exportDataType: 'basic'
,如果想导出选中的行,则可以设置为exportDataType: 'selected'
,如果不需要此功能,可以设置showExport: false
通用搜索指表格上方的搜索,通用搜索的表单默认是隐藏的,如果需要默认显示,需要设置searchFormVisible: true
,如果不需要通用搜索功能,可以设置commonSearch: false
。如果想要控制字段列不参考搜索则可以设置字段列属性为operate: false
即可。
7. 分类名称(关联搜索出分类表的名称)
这里显示的分类名称是根据分类表关联查询出来的结果,如果我们启用关联查询,我们必须在当前控制器中设置属性protected $relationSearch = true;
,同时我们的index
方法也需要重写,请参考下方的完整代码中PHP部分。如果我们启用了关联查询,当两个表中的字段有冲突时,我们必须在字段中加上别名。请参考下方的完整代码中JS部分。
8.标志和图片
FastAdmin封装了许多常用的方法,我们可以快速的调用即可。
Table.api.formatter.icon
快速将字段渲染成一个按钮,仅支持Fontawesome按钮Table.api.formatter.image
快速将字段渲染成图片展示的形式Table.api.formatter.images
快速将字段渲染成多图片展示的形式,字段数据请以,
进行分隔Table.api.formatter.status
快速将字段渲染成状态,默认normal/hidden/deleted/locked
这四个状态Table.api.formatter.url
快速将字段渲染成URL框Table.api.formatter.search
快速将字段渲染成可搜索的链接,点击后将执行搜索Table.api.formatter.addtabs
快速将字段渲染成可添加到选项卡的链接,点击后将把链接添加到选项卡Table.api.formatter.flag
快速将字段渲染成标志,仅支持index/hot/recommend/new
这四种标志Table.api.formatter.label
快速将字段渲染Label标签Table.api.formatter.datetime
快速时间戳数据渲染成日期时间数据Table.api.formatter.operate
操作栏固定按钮Table.api.formatter.buttons
快速生成多个按钮Table.api.formatter.toggle
快速生成切换按钮
9.状态
此处的状态是根据第8项中的Table.api.formatter.status
进行生成的。如果需要传入其它状态,请使用custom
参数,参数配置为{状态1: 'success', 状态2: 'grey'}
10.按钮组
按钮组的功能是根据第8项中的Table.api.formatter.buttons
进行生成的,代码如下
{field: 'id', title: __('按钮'), table: table, buttons: [
{name: 'name1', text: '弹窗', title: '弹窗标题', icon: 'fa fa-list', classname: 'btn btn-xs btn-primary btn-dialog', url: 'page/detail', callback:function(data){}},
{name: 'name2', text: 'Ajax', title: 'Ajax标题', icon: 'fa fa-flash', classname: 'btn btn-xs btn-success btn-ajax', url: 'page/detail', success:function(data, ret){}, error:function(){}},
{name: 'name3', text: '选项卡', title: '选项卡标题', icon: 'fa fa-flash', classname: 'btn btn-xs btn-info btn-addtabs', url: 'page/detail'}
], operate:false, formatter: Table.api.formatter.buttons}
按钮配置支持的参数有:
name
按钮唯一标识,其中add/edit/del/dragsort
已经被占用,请勿使用。我们可以在HTML视图文件的table
使用data-buttons-标识
来控制显示text
按钮的文本内容,如果不需要显示文本可忽略title
鼠标移上去的标题或弹窗/选项
显示的标题icon
按钮的图标,请使用font-awesome
图标库classname
按钮的class
, 其中classname
中的btn-dialog、btn-ajax、btn-addtabs
,FastAdmin已经为这几个固定的Class注册了事件,所以可以直接使用,如果想要实现其它功能,需要自己手动编写代码绑定事件才可使用。url
按钮的链接/Ajax事件请求的URL/弹窗链接/选项卡链接,直接function
和string
类型,此链接会自动在链接后添加ids/{ids}
,{ids}
为当行主键ID,如果需要传递其它字段值,请在URL中使用{字段名}
占位即可refresh
自动刷新,只针对btn-ajax
事件confirm
确认框提示文字,配置后会在确认操作再执行对应的事件,只针对btn-ajax/btn-dialog/btn-addtabs
事件success
事件成功的回调,只针对btn-ajax
事件error
事件失败的回调,只针对btn-ajax
事件callback
弹窗回传的回调,只针对btn-dialog
事件hidden
是否隐藏按钮,按钮默认显示,支持function
和bool
类型visible
是否显示按钮,按钮默认显示,支持function
和bool
类型extend
按钮扩展信息,可以任意定制按钮的参数,比如我们想在新窗口中打开链接,则配置extend:' target="_blank"'
即可
11.操作
操作区域默认是排序、编辑、删除
这三个按钮,此功能也是根据第8项中Table.api.formatter.operate
来实现的。排序按钮只在表中存在weigh
字段时才会出现,编辑按钮和删除按钮会根据管理员所拥有的权限进行按需显示。其次Table.api.formatter.operate
也支持buttons
属性来配置多个其它按钮,如示例图中的详情
按钮。请参考下方完整代码中JS部分。
完整代码
PHP代码
<?php
namespace appadmincontroller;
use appcommoncontrollerBackend;
/**
* 单页管理
*
* @icon fa fa-circle-o
* @remark 用于管理普通的单页面,通常用于关于我们、联系我们、商务合作等单一页面
*/
class Page extends Backend
{
protected $model = null;
protected $relationSearch = true;
public function _initialize()
{
parent::_initialize();
$this->model = model('Page');
}
/**
* 查看
*/
public function index()
{
if ($this->request->isAjax())
{
list($where, $sort, $order, $offset, $limit) = $this->buildparams();
$total = $this->model
->with("category")
->where($where)
->order($sort, $order)
->count();
$list = $this->model
->with("category")
->where($where)
->order($sort, $order)
->limit($offset, $limit)
->select();
$result = array("total" => $total, "rows" => $list);
return json($result);
}
return $this->view->fetch();
}
}
JS代码:
define(['jquery', 'bootstrap', 'backend', 'table', 'form'], function ($, undefined, Backend, Table, Form) {
var Controller = {
index: function () {
// 初始化表格参数配置
Table.api.init({
extend: {
index_url: 'page/index',
add_url: 'page/add',
edit_url: 'page/edit',
del_url: 'page/del',
multi_url: 'page/multi',
table: 'page',
}
});
var table = $("#table");
// 初始化表格
table.bootstrapTable({
url: $.fn.bootstrapTable.defaults.extend.index_url,
sortName: 'weigh',
columns: [
[
{field: 'state', checkbox: true},
{field: 'id', title: __('Id'), operate: false},
{field: 'category_id', title: __('Category_id'), operate: '='},
{field: 'category.name', title: __('Category'), operate: '=', formatter: Table.api.formatter.search},
{field: 'title', title: __('Title'), operate: 'LIKE %...%', placeholder: '关键字,模糊搜索'},
{field: 'flag', title: __('Flag'), formatter: Table.api.formatter.flag, operate: false},
{field: 'image', title: __('Image'), formatter: Table.api.formatter.image, operate: false},
{field: 'views', title: __('Views'), operate: false},
{field: 'comments', title: __('Comments'), operate: false},
{field: 'weigh', title: __('Weigh'), operate: false},
{field: 'status', title: __('Status'), formatter: Table.api.formatter.status, searchList: {'normal': __('Normal'), 'hidden': __('Hidden')}, style: 'min-100px;'},
{field: 'createtime', title: __('Create Time'), formatter: Table.api.formatter.datetime, operate: 'BETWEEN', type: 'datetime', addclass: 'datetimepicker', data: 'data-date-format="YYYY-MM-DD"'},
{field: 'id', title: __('按钮'), table: table, buttons: [
{name: 'detail', text: '弹窗', title: '弹窗标题', icon: 'fa fa-list', classname: 'btn btn-xs btn-primary btn-dialog', url: 'page/detail'},
{name: 'detail', text: 'Ajax', title: 'Ajax标题', icon: 'fa fa-flash', classname: 'btn btn-xs btn-success btn-ajax', url: 'page/detail'},
{name: 'detail', text: '选项卡', title: '选项卡标题', icon: 'fa fa-flash', classname: 'btn btn-xs btn-info btn-addtabs', url: 'page/detail'}
], operate:false, formatter: Table.api.formatter.buttons},
{field: 'operate', title: __('Operate'), table: table, buttons: [
{name: 'detail', text: '详情', title: '详情', icon: 'fa fa-list', classname: 'btn btn-xs btn-primary btn-dialog', url: 'page/detail'}
], events: Table.api.events.operate, formatter: Table.api.formatter.operate}
]
],
//普通搜索
commonSearch: true,
titleForm: '', //为空则不显示标题,不定义默认显示:普通搜索
});
// 为表格绑定事件
Table.api.bindevent(table);
//指定搜索条件
$(document).on("click", ".btn-singlesearch", function () {
var options = table.bootstrapTable('getOptions');
options.pageNumber = 1;
options.queryParams = function (params) {
return {
search: params.search,
sort: params.sort,
order: params.order,
filter: JSON.stringify({category_id: 1}),
op: JSON.stringify({category_id: '='}),
offset: params.offset,
limit: params.limit,
};
};
table.bootstrapTable('refresh', {});
Toastr.info("当前执行的是自定义搜索");
return false;
});
//获取选中项
$(document).on("click", ".btn-selected", function () {
Layer.alert(JSON.stringify(table.bootstrapTable('getSelections')));
});
//启动和暂停按钮
$(document).on("click", ".btn-start,.btn-pause", function () {
//在table外不可以使用添加.btn-change的方法
//只能自己调用Table.api.multi实现
Table.api.multi("changestatus", 0, table, this);
});
},
add: