控制器

为了方便项目的开发管理,我们将一些常用的、非业务逻辑代码抽离并整合到了一个公共的控制器基类(/app/common/controller/Admin.php),所有后台控制器都必须继承此基类控制器。
在此基类控制器中我们定义了一些必要的基础属性和通用方法,具体请往下看:

基础属性

  1. /**
  2. * 模型名(模型名、表名二选一)
  3. * 应用模型名为string的格式:model+模型名
  4. * 插件模型名为stirng的格式:pluginModel+模型名
  5. * @var string|model
  6. */
  7. protected $model = null;
  8. /**
  9. * 表名(模型名、表名二选一,表名不含表前缀)
  10. * @var string
  11. */
  12. protected $table = null;
  13. /**
  14. * 验证器类
  15. * 应用验证器名为string的格式:validate+模型名
  16. * 插件验证器名为stirng的格式:pluginValidate+模型名
  17. * @var string|validate
  18. */
  19. protected $validate = null;
  20. /**
  21. * 验证码添加场景名称(通用添加方法专用)
  22. * @var string
  23. */
  24. protected $addScene = '';
  25. /**
  26. * 验证器修改场景名称(通用修改方法专用)
  27. * @var string
  28. */
  29. protected $editScene = '';
  30. /**
  31. * 允许通过setField方法更新的字段
  32. * @var array
  33. */
  34. protected $setFields = [];
  35. /**
  36. * 限制通用修改方法可编辑的字段
  37. * @var array
  38. */
  39. protected $editFields = [];
  40. /**
  41. * 通用上传配置表(默认使用系统附件表)
  42. * @var array
  43. */
  44. protected $uploadConfigTable = [];
  45. /**
  46. * 表单数据(表单自动赋值)
  47. * @var array
  48. */
  49. protected $formData = [];
  50. /**
  51. * 无需鉴权的方法,但要登录
  52. * @var array
  53. */
  54. protected $noNeedAuth = [];
  55. /**
  56. * 无需登录的方法
  57. * @var array
  58. */
  59. protected $noNeedLogin = [];
  60. /**
  61. * 数据权限设置,可选值:own 个人,org 组织,false 不启用
  62. * @var string|bool
  63. */
  64. protected $dataRight = false;
  65. /**
  66. * 数据权限字段名
  67. * @var string
  68. */
  69. protected $dataRightField = 'admin_id';
  70. /**
  71. * 是否开启布局模板|布局模板文件路径
  72. * @var bool|string
  73. */
  74. protected $layout = false;
  75. /**
  76. * 模板渲染数据
  77. * @var array
  78. */
  79. protected $assignData = [];
  80. /**
  81. * 模板基础路径
  82. * @var string
  83. */
  84. protected $viewPath = '';
  85. /**
  86. * 权限Auth
  87. * @var Auth
  88. */
  89. protected $auth = null;

通用方法

由于后台采用了白名单权限控制,如有使用到某些 public 方法,请将此方法的url手动添加到权限菜单。

  1. /**
  2. * 新增数据
  3. *
  4. * @return mixed
  5. */
  6. public function add()
  7. {
  8. }
  9. /**
  10. * 编辑数据
  11. *
  12. * @param integer $id 主键值
  13. * @return mixed
  14. */
  15. public function edit()
  16. {
  17. }
  18. /**
  19. * 删除数据(支持软删除自动识别)
  20. *
  21. * @param integer|array $id 主键值
  22. * @return mixed
  23. */
  24. public function delete()
  25. {
  26. }
  27. /**
  28. * 恢复软删除
  29. *
  30. * @param integer|array $id 主键值
  31. * @return mixed
  32. */
  33. public function restore()
  34. {
  35. }
  36. /**
  37. * 设置状态
  38. *
  39. * @param string $field 状态字段,默认status
  40. * @param integer $value 状态值,0或1
  41. * @param integer|array $id 主键值
  42. * @return mixed
  43. */
  44. public function setStatus()
  45. {
  46. }
  47. /**
  48. * 快速更新某个字段
  49. *
  50. * @param string $field 字段名,默认sort
  51. * @param integer $value 字段值
  52. * @param integer|array $id 主键值
  53. * @return mixed
  54. */
  55. public function setField()
  56. {
  57. }
  58. /**
  59. * 切换默认设置
  60. *
  61. * @param string $field 默认字段名,默认is_default
  62. * @param integer $value 字段值
  63. * @param integer $id 主键值
  64. * @return mixed
  65. */
  66. public function setDefault()
  67. {
  68. }
  69. /**
  70. * 上传附件
  71. *
  72. * @param string $action 上传方法,save保存入库;store只上传不入库
  73. * @param string $from 来源(input默认,kindeditor,umeditor,markdown,ckeditor,ueditor)
  74. * @param string $group 本地分组名
  75. * @param string $thumb 缩略图尺寸(默认调用系统配置-上传配置-缩略图尺寸)
  76. * @param string $thumb_type 缩略图裁剪类型(默认调用系统配置-上传配置-缩略图裁剪)
  77. * @param integer $full_path 是否返回全路径(0否,1是)
  78. * @param string $disk 磁盘(请根据/config/filesystem.php里面的disks来配置)
  79. * @param string $driver 上传驱动(默认调用系统配置-上传配置-上传驱动)
  80. * @param string $watermark 默认水印设置(默认调用系统配置-上传配置-默认水印)
  81. * @param string $watermark_font 文字水印字体(默认调用系统配置-上传配置-文字水印字体)
  82. * @param string $watermark_text 文字水印内容(默认调用系统配置-上传配置-文字水印内容)
  83. * @param string $watermark_size 文字水印大小(默认调用系统配置-上传配置-文字水印大小)
  84. * @param string $watermark_color 文字水印颜色(默认调用系统配置-上传配置-文字水印颜色)
  85. * @param string $watermark_picture 水印图片地址(默认调用系统配置-上传配置-水印图片)
  86. * @param string $image_watermark_locate 水印图片位置(默认调用系统配置-上传配置-图片水印位置)
  87. * @param string $image_watermark_opacity 水印图片透明度(默认调用系统配置-上传配置-图片水印透明度)
  88. * @return json
  89. */
  90. public function upload()
  91. {
  92. }
  93. /**
  94. * 获取某个key的数据授权ID集合
  95. *
  96. * @param string $key 格式:应用.分组名
  97. * @return array
  98. */
  99. protected function getDataAuth(string $key)
  100. {
  101. }
  102. /**
  103. * 检查某个key的数据ID是否有授权
  104. *
  105. * @param int $id 数据ID
  106. * @param string $key 格式:应用.分组
  107. * @return bool
  108. */
  109. protected function checkDataAuth(int $id, string $key) : bool
  110. {
  111. }
  112. /**
  113. * 获取同组织下的所有管理员ID
  114. *
  115. * @return array
  116. */
  117. protected function getAdminIds()
  118. {
  119. }
  120. /**
  121. * 获取管理员的数据权限 where
  122. *
  123. * @param array $where 全部筛选条件(原样返回)
  124. * @return array
  125. */
  126. protected function getRightWhere($where = [])
  127. {
  128. }
  129. /**
  130. * 获取数据库对象
  131. *
  132. * @return object
  133. */
  134. protected function getDb()
  135. {
  136. }
  137. /**
  138. * 获取模型对象
  139. *
  140. * @return object
  141. */
  142. protected function model()
  143. {
  144. }
  145. /**
  146. * 获取数据库表对象
  147. *
  148. * @return object
  149. */
  150. protected function table()
  151. {
  152. }
  153. /**
  154. * 验证数据
  155. * @access protected
  156. * @param array $data 数据
  157. * @param string|array $validate 验证器名或者验证规则数组
  158. * @param array $message 提示信息
  159. * @param bool $batch 是否批量验证
  160. * @return array|string|true
  161. * @throws ValidateException
  162. */
  163. protected function validate(array $data, $validate, array $message = [], bool $batch = false)
  164. {
  165. }
  166. /**
  167. * 输出响应
  168. *
  169. * @param mixed $msg 提示信息
  170. * @param mixed $data 要返回的数据
  171. * @param integer $code 错误码/状态码
  172. * @param string $type 输出类型,可选值:json、xml、jsonp
  173. * @return json
  174. */
  175. protected function response($msg, $data, int $code = 0, string $type = null, array $header = [])
  176. {
  177. }
  178. /**
  179. * 输出layui的json数据
  180. *
  181. * @param array $data
  182. * @param integer $count
  183. * @return json
  184. */
  185. protected function layuiJson($data, $count = 0)
  186. {
  187. }
  188. /**
  189. * 以JSONP格式输出错误信息
  190. *
  191. * @param string $msg
  192. * @param array $data
  193. * @param string $url
  194. * @return jsonp
  195. */
  196. protected function errorJsonp($msg = 'error', $data = [], $url = '')
  197. {
  198. }
  199. /**
  200. * 以JSONP格式输出成功信息
  201. *
  202. * @param string $msg
  203. * @param array $data
  204. * @param string $url
  205. * @return jsonp
  206. */
  207. protected function successJsonp($msg = 'success', $data = [], $url = '')
  208. {
  209. }
  210. /**
  211. * 模板变量赋值
  212. * @access public
  213. * @param mixed $name 变量名
  214. * @param mixed $value 变量值
  215. * @return $this
  216. */
  217. protected function assign($name, $value = '')
  218. {
  219. }
  220. /**
  221. * 解析和获取模板内容 用于输出
  222. * @access public
  223. * @param string $template 模板文件名或者内容
  224. * @param array $vars 模板变量
  225. * @return string
  226. * @throws \Exception
  227. */
  228. protected function fetch(string $template = '', array $vars = []): string
  229. {
  230. }

控制器示例:

<?php
namespace app\demo\admin;

use app\common\controller\Admin;

/**
 * 文章控制器
 * @package app\demo\admin
*/
class Artilce extends Admin
{
    protected $model = 'modelArticle';// [选填]模型(模型、表名二选一)
    protected $table = '';// [选填]表名(模型、表名二选一)
    protected $validate = '';// [选填]验证器名
    protected $addScene = '';// [选填]添加场景名称
    protected $editScene = '';// [选填]修改场景名称
    protected $setFields = [];// [选填]允许通过setField方法更新的字段
    protected $editFields = '*';// [选填]在编辑模式下允许编辑的字段(*表示所有)
    protected $uploadConfigTable = [];// [选填]通用上传配置表
    protected $noNeedAuth = [];// [选填]无需鉴权的方法
    protected $readonlyFields = [];// [选填]只读字段定义(表单构建器专用)
    protected $dataRight = false;// [选填]数据权限设置,可选值:own 个人,org 组织,false 不启用
    protected $dataRightField = 'admin_id';// [选填]数据权限字段名

    public function index()
    {
        return $this->fetch();
    }
}

公共模板变量

模板变量名称 生成的内容 备注数据
STATIC /static/[app] 静态资源路径前缀
UPLOAD /upload 附件路径
PUBLIC_CSS /static/css 公共CSS文件目录
PUBLIC_JS /static/js 公共JS文件目录
PUBLIC_IMG /static/image 公共image文件目录
CSS /static/[app]/admin/css 当前应用的CSS文件目录
JS /static/[app]/admin/js 当前应用的js文件目录
IMG /static/[app]/admin/image 当前应用的image文件目录

[app] 为当前应用或插件名