登录
目录
当前位置： 首页 > 文档资料 > FastAdmin 框架文档 >

控制器

优质
小牛编辑
135浏览
2023-12-01

基类控制器

FastAdmin中定义了三个基类控制器，分别位于

  1. application/common/controller/Api.php //API接口基类控制器
  2. application/common/controller/Backend.php //后台基类控制器
  3. application/common/controller/Frontend.php //前台基类控制器

这里我们主要对Backend.php这个控制器基类做详细解读，因为我们后台管理的所有控制器都继承于它，而Frontend.php功能和Backend.php功能类似，而Api.php控制器主要用于API接口开发，这里就不再进行过多介绍。

基础结构

在后台中我们的控制器都必须继承自\app\common\controller\Backend这个基类，其中控制器的index/add/edit/del/multi/recyclebin/destroy/restore/import/selectpage全都是可选的方法，基类的这些方法使用traits进行引入，具体位置在application/admin/library/traits/Backend.php中，CRUD生成的标准控制器如下：

  1. <?php
  3. namespace app\admin\controller;
  5. /**
  6.  * 文章管理
  7.  *
  8.  * @icon fa fa-list
  9.  * @remark 用于统一管理网站的所有文章
  10.  */
  11. class Article extends Backend
  12. {
  14.     protected $model = null;
  15.     protected $noNeedLogin = [];
  16.     protected $noNeedRight = ['selectpage'];
  18.     public function _initialize()
  19.     {
  20.         parent::_initialize();
  21.     }
  23.     /**
  24.      * 默认生成的控制器所继承的父类中有index/add/edit/del/multi/destroy/restore/recyclebin八个方法
  25.      * 因此在当前控制器中可不用编写增删改查的代码,如果需要自己控制这部分逻辑
  26.      * 需要将application/admin/library/traits/Backend.php中对应的方法复制到当前控制器,然后进行修改
  27.      */
  29. }

基类中所定义的方法如下，以下方法都是通过application/admin/library/traits/Backend.php引入的

  1. class Backend extends Controller{
  2.     /**
  3.      * 查看
  4.      */
  5.     public function index(){}
  7.     /**
  8.      * 添加
  9.      */
  10.     public function add($ids = ""){}
  12.     /**
  13.      * 编辑
  14.      */
  15.     public function edit($ids = ""){}
  17.     /**
  18.      * 删除
  19.      */
  20.     public function del($ids = ""){}
  22.     /**
  23.      * 批量更新
  24.      */
  25.     public function multi($ids = ""){}
  27.     /**
  28.      * 回收站
  29.      */
  30.     public function recyclebin(){}
  32.     /**
  33.      * 真实删除
  34.      */
  35.     public function destroy($ids = ""){}
  37.     /**
  38.      * 还原
  39.      */
  40.     public function restore($ids = ""){}
  42.       /**
  43.      * 导入
  44.      */
  45.     protected function import(){}
  47.     /**
  48.      * 下拉筛选
  49.      */
  50.     public function selectpage()
  51.     {
  52.         return parent::selectpage();
  53.     }
  54. }

我们在开发过程中最好注释好每一个控制器和控制器的方法，因为我们后期可以使用php think menu -c all-controller一键生成后台管理的菜单，注释支持@icon/@remark/@internal这三个属性，分别表示图标/备注/忽略，如果是protected或private的方法在后期一键生成时会自动忽略。

控制器支持目录层级，如果在使用目录层级的时候，请注意当前控制器的命名空间，比如当前控制器文件位置是application/admin/controller/member/Teacher.php，当Teacher.php的命名空间请务必是namespace app\admin\controller\member;，如果命名空间不对会报找不到控制器的错误。

属性和方法

当我们的控制器继承自app\common\controller\Backend以后，我们就可以使用以下属性

  1. /**
  2.  * 无需登录的方法,同时也就不需要鉴权了
  3.  * @var array
  4.  */
  5. protected $noNeedLogin = [];
  7. /**
  8.  * 无需鉴权的方法,但需要登录
  9.  * @var array
  10.  */
  11. protected $noNeedRight = [];
  13. /**
  14.  * 布局模板
  15.  * @var string
  16.  */
  17. protected $layout = 'default';
  19. /**
  20.  * 权限控制类
  21.  * @var Auth
  22.  */
  23. protected $auth = null;
  25. /**
  26.  * 快速搜索时执行查找的字段
  27.  */
  28. protected $searchFields = 'id';
  30. /**
  31.  * 是否是关联查询
  32.  */
  33. protected $relationSearch = false;
  35. /**
  36.  * 是否开启数据限制
  37.  * 支持auth/personal
  38.  * 表示按权限判断/仅限个人 
  39.  * 默认为禁用,若启用请务必保证表中存在admin_id字段
  40.  */
  41. protected $dataLimit = false;
  43. /**
  44.  * 数据限制字段
  45.  */
  46. protected $dataLimitField = 'admin_id';
  48. /**
  49.  * 是否开启Validate验证
  50.  */
  51. protected $modelValidate = false;
  53. /**
  54.  * 是否开启模型场景验证
  55.  */
  56. protected $modelSceneValidate = false;
  58. /**
  59.  * Multi方法可批量修改的字段
  60.  */
  61. protected $multiFields = 'status';

我们可以直接在当前控制器使用$this->属性名来调用所支持的属性，也支持直接在当前控制器定义相关属性来覆盖父类的属性，同时TP5中\think\Controller所支持的属性也全部支持。

基类app\common\controller\Backend中所支持的方法如下

  1. /**
  2.  * 加载语言文件
  3.  * @param string $name
  4.  */
  5. protected function loadlang($name)
  6. {
  7. }
  9. /**
  10.  * 渲染配置信息
  11.  * @param mixed $name 键名或数组
  12.  * @param mixed $value 值 
  13.  */
  14. protected function assignconfig($name, $value = '')
  15. {    
  16. }
  18. /**
  19.  * 生成查询所需要的条件,排序方式
  20.  * @param mixed $searchfields 快速查询的字段
  21.  * @param boolean $relationSearch 是否关联查询
  22.  * @return array
  23.  */
  24. protected function buildparams($searchfields = null, $relationSearch = null)
  25. {    
  26. }
  28. /**
  29.  * 获取数据限制的管理员ID
  30.  * 禁用数据限制时返回的是null
  31.  * @return mixed
  32.  */
  33. protected function getDataLimitAdminIds()
  34. {    
  35. }
  37. /**
  38.  * Selectpage的实现方法
  39.  * 
  40.  * 当前方法只是一个比较通用的搜索匹配,请按需重载此方法来编写自己的搜索逻辑,$where按自己的需求写即可
  41.  * 这里示例了所有的参数，所以比较复杂，实现上自己实现只需简单的几行即可
  42.  * 
  43.  */
  44. protected function selectpage()
  45. {
  46. }

我们可以直接在当前控制器使用$this->方法名()来调用所支持的方法，同时TP5中\think\Controller所支持的方法也全部支持。

数据限制

在后台开发的过程中经常会有这样的一个需求，每个管理员单独管理自己添加的数据或单独管理自己下级管理员添加的数据，管理员之间的数据是不相通的，每个管理员看到的数据是不同的。在FastAdmin中可以很方便的实现此功能。

首先我们需要在当前控制器添加以下两个属性

  1. protected $dataLimit = 'auth'; //默认基类中为false，表示不启用，可额外使用auth和personal两个值
  2. protected $dataLimitField = 'admin_id'; //数据关联字段,当前控制器对应的模型表中必须存在该字段
  1. $dataLimit = false; //表示不启用，显示所有数据
  2. $dataLimit = 'auth'; //表示显示当前自己和所有子级管理员的所有数据
  3. $dataLimit = 'personal'; //表示仅显示当前自己的数据

$dataLimitField字段默认为admin_id，请注意添加该字段类型为int(10)。

通过以上配置后，在列表数据的时候将默认添加条件过滤不属性自己权限的数据，在添加时会自动维护admin_id的数据，在编辑、删除的时候会自动控制权限避免越权操作。

如果需要将原有的数据加入到FastAdmin后台管理权限控制当中，比如已有的数据已经有标识归属，但这个归属体系并非是FastAdmin的后台管理员体系。在这个时候我们就需要重写基类的getDataLimitAdminIds方法，将此方法返回数据标识的归属ID数组集合，这样即可使用FastAdmin的后台管理权限进行管理。

关联查询

目前FastAdmin后台index方法支持一对一关联查询，比如我们一篇文章有归属分类，我们在列出数据时需要同时列表文章分类名称。

首先我们需要在当前控制器中添加以下属性

  1. protected $relationSearch = true;

然后我们修改控制器的index方法，代码如下：

  1. public function index()
  2. {
  3.     if ($this->request->isAjax())
  4.     {
  5.         list($where, $sort, $order, $offset, $limit) = $this->buildparams();
  6.         $total = $this->model
  7.                 ->with("category")
  8.                 ->where($where)
  9.                 ->order($sort, $order)
  10.                 ->count();
  11.         $list = $this->model
  12.                 ->with("category")
  13.                 ->where($where)
  14.                 ->order($sort, $order)
  15.                 ->limit($offset, $limit)
  16.                 ->select();
  17.         $result = array("total" => $total, "rows" => $list);
  19.         return json($result);
  20.     }
  21.     return $this->view->fetch();
  22. }

然后在控制器对应的model(非关联model)中添加以下代码：

  1. public function category()
  2. {
  3.     return $this->belongsTo('Category', 'category_id')->setEagerlyType(0);
  4. }

更多的关联用户可以参考TP5关联模型的章节：关联模型

我们在控制器对应的JS中可以直接使用category.id、category.name等关联表的字段

  1. // 初始化表格
  2. table.bootstrapTable({
  3.     url: $.fn.bootstrapTable.defaults.extend.index_url,
  4.     columns: [
  5.         [
  6.             {field: 'state', checkbox: true, },
  7.             {field: 'id', title: 'ID', operate: '='},
  8.             {field: 'title', title: __('Title'), operate: 'LIKE %...%'},
  9.             {field: 'category.image', title: __('Image'), operate: false, formatter: Table.api.formatter.image},
  10.             {field: 'category.name', title: __('Name'), operate: '='},
  11.             {field: 'ip', title: __('IP'), operate: '='},
  12.             {field: 'createtime', title: __('Create time'), formatter: Table.api.formatter.datetime, operate: 'RANGE', addclass: 'datetimerange'},
  13.             {field: 'operate', title: __('Operate'), table: table, events: Table.api.events.operate, formatter: Table.api.formatter.operate}
  14.         ]
  15.     ],
  16. });

数据校验

在FastAdmin中默认的add/edit方法可以使用模型验证，验证器位于application/admin/validate/模型名.php中，模型验证默认是关闭的状态，如果需要启用，我们需要在当前控制器定义以下属性

  1. protected $modelValidate = true; //是否开启Validate验证，默认是false关闭状态
  2. protected $modelSceneValidate = true; //是否开启模型场景验证，默认是false关闭状态

当开启模型验证后，我们的添加和修改操作都会首先进行模型验证，验证不通过将会抛出错误信息，具体的模型验证规则可以参考TP5官方文档的模型验证规则：https://www.kancloud.cn/manual/thinkphp5/129355

场景验证可以参考TP5场景验证章节：https://www.kancloud.cn/manual/thinkphp5/129322

权限控制

在基类中我们有定义以下两个属性

  1. protected $noNeedLogin = []; //无需登录的方法,同时也就不需要鉴权了
  2. protected $noNeedRight = []; //无需鉴权的方法,但需要登录

比如我们有定义一个方法mywork，而这个方法是不需要登录即可访问的，则我们需要在当前的控制器定义

  1. protected $noNeedLogin = ['mywork'];

比如我们有定义一个方法mytest，而这个方法是需要登录后仍何管理员都可以访问，则我们需要在当前的控制器定义

  1. prtected $noNeedRight = ['mytest'];

如果如我们需要动态定义，请务必放在调用父类的_initialize方法之前，否则是不会生效的。

视图渲染

基类app\common\controller\Backend会默认渲染以下几个对象到视图中

  1. //渲染站点配置
  2. $this->assign('site', $site);
  3. //渲染配置信息
  4. $this->assign('config', $config);
  5. //渲染权限对象
  6. $this->assign('auth', $this->auth);
  7. //渲染管理员对象
  8. $this->assign('admin', Session::get('admin'));

我们可以在视图中使用{$site.name}、{$config.modulename}、{$auth.id}、{$admin.username}来获取我们所需要的数据

  1. $site所支持的数据对应为application/extra/site.php
  1. $config所支持的数据为
  2. 'site'           => $site中的'name', 'cdnurl', 'version', 'timezone', 'languages'字段,
  3. 'upload'         => application/extra/upload.php中数据,
  4. 'modulename'     => 'admin',
  5. 'controllername' => 控制器名,
  6. 'actionname'     => 方法名,
  7. 'jsname'         => 控制器JS所加载的路径,
  8. 'moduleurl'      => 后台module的链接,
  9. 'language'       => 当前语言,
  10. 'fastadmin'      => application/config.php中fastadmin的配置
  1. $auth是一个对象，所对应的类是application/admin/library/Auth.php
  1. $admin是一个当前管理员登录的session数据，存储有管理员的用户名、昵称、ID、头像等信息

如果我们需要在JS中使用以上数据，则使用

  1. Config.site.name
  2. Config.modulename

来获取相关的配置信息

如果我们需要自己在控制器中透传数据到JS中去，则可以使用控制器的assignconfig方法来透传，使用如下

  1. $this->assignconfig('demo', ['name'=>'名称']);

然后我们就可以在JS中使用

  1. Config.demo.name

来获取对应的数据

模板布局

控制器默认全部采用模板布局，因此我们的页面都会自动加上头部和尾部，如果我们有特殊的页面不需要采用模板布局，我们可以使用$this->view->engine->layout(false);来关闭当前方法的模板布局

如果我们需要使用自己的模板布局，在当前控制器定义protected $layout = '布局模板';即可。

请注意如果采用了自己的模板布局或禁用了模板布局，将无法使用FastAdmin的JS按需加载和Config变量访问。

免责声明： 以上内容版权归原作者所有，如有侵犯您的原创版权请告知，我们将尽快删除相关内容。感谢每一位辛勤著写的作者，感谢每一位的分享。
@小牛知识库 xnip.cn