[TOC]
> 所有的控制器都在`/app/admin/controller`目录下,不再赘述。
## 基础控制器
### 介绍
- 基础控制器为`AdminBaseController`,方法及变量都有完整的注释,可自行查看。
- 基础控制器引用了三个`trait`,分别为`AdminAuthTrait`,`AdminTreeTrait`,`AdminPhpOffice`,分别对应后台权限相关验证、树结构生成,Excel导出(目前)相关功能,方法解析可参看下一节。
### 流程
1. 检查登录
1. 检查权限
3. 单设备登录检查
2. csrfToken检查
2. 初始化view
1. 分页配置赋值
1. 记录访问日志
1. 执行具体控制器方法
1. 抛出`HttpResponseException`异常或使用`fetch`,`admin_success`,`admin_error`返回结果
## 具体业务控制器
### 主要方法
> 以下方法均可使用代码生成器一键生成,无需手动写代码。
#### index(列表方法)
`index`方法为列表页方法,包含搜索、查询、导出功能,如下:
```php
/**
* 列表
* @param Request $request
* @param User $model
* @return string
* @throws Exception
*/
public function index(Request $request, User $model): string
{
$param = $request->param();
$data = $model->with('user_level')->scope('where', $param)
->paginate([
'list_rows' => $this->admin['admin_list_rows'],
'var_page' => 'page',
'query' => $request->get(),
]);
// 关键词,排序等赋值
$this->assign($request->get());
$this->assign([
'data' => $data,
'page' => $data->render(),
'total' => $data->total(),
'user_level_list' => UserLevel::select(),
'status_list' => User::STATUS_LIST,
]);
return $this->fetch();
}
````
#### add
`add`为添加数据方法,包含添加数据视图的显示,添加数据的验证,保存功能,代码如下:
```php
//添加
public function add(Request $request, User $model, UserValidate $validate)
{
if ($request->isPost()) {
$param = $request->param();
$validate_result = $validate->scene('add')->check($param);
if (!$validate_result) {
return admin_error($validate->getError());
}
//处理头像上传
$attachment_avatar = new \app\common\model\Attachment;
$file_avatar = $attachment_avatar->upload('avatar');
if ($file_avatar) {
$param['avatar'] = $file_avatar->url;
} else {
return admin_error($attachment_avatar->getError());
}
$result = $model::create($param);
$url = URL_BACK;
if (isset($param['_create']) && $param['_create'] == 1) {
$url = URL_RELOAD;
}
return $result ? admin_success('添加成功', $url) : admin_error();
}
return $this->fetch();
}
```
#### eidt
`edit`为更新方法,包含更新数据视图的显示,更新数据的验证,保存功能,代码如下:
```
//修改
public function edit($id, Request $request, User $model, UserValidate $validate)
{
$data = $model::get($id);
if ($request->isPost()) {
$param = $request->param();
$validate_result = $validate->scene('edit')->check($param);
if (!$validate_result) {
return admin_error($validate->getError());
}
//处理头像上传
if (!empty($_FILES['avatar']['name'])) {
$attachment_avatar = new \app\common\model\Attachment;
$file_avatar = $attachment_avatar->upload('avatar');
if ($file_avatar) {
$param['avatar'] = $file_avatar->url;
}
}
$result = $data->save($param);
return $result ? admin_success() : admin_error();
}
$this->assign([
'data' => $data,
]);
return $this->fetch('add');
}
```
#### del
`del`方法为删除方法,包含删除数据的判断,批量删除,然删除等,示例代码如下:
```
//删除
public function del($id, User $model)
{
if (count($model->noDeletionId) > 0) {
if (is_array($id)) {
if (array_intersect($model->noDeletionId, $id)) {
return admin_error('ID为' . implode(',', $model->noDeletionId) . '的数据无法删除');
}
} else if (in_array($id, $model->noDeletionId)) {
return admin_error('ID为' . $id . '的数据无法删除');
}
}
if ($model->softDelete) {
$result = $model->whereIn('id', $id)->useSoftDelete('delete_time', time())->delete();
} else {
$result = $model->whereIn('id', $id)->delete();
}
return $result ? admin_success('操作成功', URL_RELOAD) : admin_error();
}
```
#### enable
`enable`方法为启用方法,可进行单个数据或批量数据的启用,示例代码如下:
```
//启用
public function enable($id, User $model)
{
$result = $model->whereIn('id', $id)->update(['status' => 1]);
return $result ? admin_success('操作成功', URL_RELOAD) : admin_error();
}
```
#### disable
`disable`方法为禁用方法,可进行单个数据或批量数据的禁用,示例代码如下:
```
//禁用
public function disable($id, User $model)
{
$result = $model->whereIn('id', $id)->update(['status' => 0]);
return $result ? admin_success('操作成功', URL_RELOAD) : admin_error();
}
```