表单回调

Form目前提供了下面几个方法来接收回调函数：

creating

在新增页面调用（非提交操作）

  1. $form->creating(function (Form $form) {
  2.     if (...) { // 验证逻辑
  3.         $form->responseValidationMessages('title', 'title格式错误');
  5.         // 如有多个错误信息，第二个参数可以传数组
  6.         $form->responseValidationMessages('content', ['content格式错误', 'content不能为空']);
  7.     }
  8. });

editing

在编辑页面调用（非提交操作）

  1. $form->editing(function (Form $form) {
  2.     if (...) { // 验证逻辑
  3.         $form->responseValidationMessages('title', 'title格式错误');
  5.         // 如有多个错误信息，第二个参数可以传数组
  6.         $form->responseValidationMessages('content', ['content格式错误', 'content不能为空']);
  7.     }
  8. });

submitted

在表单提交前调用，在此事件中可以修改、删除用户提交的数据或者中断提交操作

  1. $form->submitted(function (Form $form) {
  2.     // 获取用户提交参数
  3.     $title = $form->title;
  5.     // 上面写法等同于
  6.     $title = $form->input('title');
  8.     // 删除用户提交的数据
  9.     $form->deleteInput('title');
  11.     // 中断后续逻辑
  12.     return $form->error('服务器出错了~');
  13. });

saving

保存前回调，在此事件中可以修改、删除用户提交的数据或者中断提交操作

  1. $form->saving(function (Form $form) {
  2.     // 判断是否是新增操作
  3.     if ($form->isCreating()) {
  5.     }
  7.     // 删除用户提交的数据
  8.     $form->deleteInput('title');
  10.     // 中断后续逻辑
  11.     return $form->error('服务器出错了~');
  12. });

saved

保存后回调，此事件新增和修改操作共用，通过第二个参数$result可以判断数据是否保存成功。

{tip} 新增页面下，$result的值是新增记录的自增ID

  1. $form->saved(function (Form $form, $result) {
  2.     // 判断是否是新增操作
  3.     if ($form->isCreating()) {
  4.         // 自增ID
  5.         $newId = $result;
  6.         // 也可以这样获取自增ID
  7.         $newId = $form->getKey();
  9.         if (! $newId) {
  10.             return $form->error('数据保存失败');
  11.         }
  13.         return;
  14.     }
  16.     // 修改操作
  17. });

{tip} $form->repository()->eloquent()為當前新增或編輯後的eloquent

  1. $form->saved(function (Form $form, $result) {
  2.     // 在表單保存後獲取eloquent
  3.     $form->repository()->eloquent()->update(['data' => 'new']);
  4. });

deleting

删除前回调

  1. $form->deleting(function (Form $form) {
  2.     // 获取待删除行数据，这里获取的是一个二维数组
  3.     $data = $form->model()->toArray();
  4. });

deleted

删除后回调，通过第二个参数$result可以判断数据是否删除成功。

  1. $form->deleted(function (Form $form, $result) {
  2.     // 获取待删除行数据，这里获取的是一个二维数组
  3.     $data = $form->model()->toArray();
  5.     // 通过 $result 可以判断数据是否删除成功
  6.     if (! $result) {
  7.         return $form->error('数据删除失败');
  8.     }
  10.     // 返回删除成功提醒，此处跳转参数无效
  11.     return $form->success('删除成功');
  12. });

uploading

图片、文件上传事件

{tip} 文件上传是一个独立的api请求，这个事件内redirect方法是无效的。

  1. use Dcat\Admin\Form;
  2. use Dcat\Admin\Form\Field;
  3. use Dcat\Admin\Contracts\UploadField as UploadFieldInterface;
  4. use Symfony\Component\HttpFoundation\File\UploadedFile;
  6. $form->uploading(function (Form $form, UploadFieldInterface $field, UploadedFile $file) {
  7.     // $file 即是当前上传的完整文件
  9.     /* @var Field $field */
  10.     // 获取文件上传字段名称
  11.     $column = $field->column();
  12. });

uploaded

图片、文件上传完毕事件

{tip} 文件上传是一个独立的api请求，这个事件内redirect方法是无效的。

  1. use Dcat\Admin\Form;
  2. use Dcat\Admin\Form\Field;
  3. use Dcat\Admin\Contracts\UploadField as UploadFieldInterface;
  4. use Symfony\Component\HttpFoundation\File\UploadedFile;
  6. $form->uploaded(function (Form $form, UploadFieldInterface $field, UploadedFile $file, $response) {
  7.     // $file 即是当前上传的完整文件
  9.     /* @var Field $field */
  10.     // 获取文件上传字段名称
  11.     $column = $field->column();
  13.     $response = (array) $response->getData();
  15.     // 文件上传成功
  16.     if ($response['status']) {
  17.         // 文件访问地址
  18.         $url = $response['url'];
  19.     }
  20. });

获取模型中的数据

  1. $form->saved(function (Form $form) {
  3.     $id = $form->getKey();
  5.     $username = $form->model()->username;
  7.     // 获取最终保存的数组
  8.     $updates = $form->updates();
  9. });

修改或删除用户提交的数据

此功能在saving和submitted事件中有效

  1. $form->select('author_id');
  3. $form->saving(function (Form $form) {
  4.     // 修改用户提交的数据
  5.     $form->author_id = 1;
  7.     // 删除、忽略用户提交的数据
  8.     $form->deleteInput('author_id');  
  9. });

修改模型中的数据

修改模型中的数据需要配合隐藏表单使用。举例：

  1. $form->hidden('author_id');
  3. $form->saving(function (Form $form) {
  5.     $form->author_id = 1;
  6. });

页面跳转

{tip} 此方法在creating、editing、uploading、uploaded事件中均不可用。

redirect（局部刷新/单页刷新）

  1. // 跳转并提示成功信息
  2. $form->saved(function (Form $form) {
  3.     return $form->redirect('auth/user', '保存成功');
  4. });
  6. // 跳转并提示错误信息
  7. $form->saved(function (Form $form) {
  8.     return $form->redirect('auth/user', [
  9.         'message' => '系统错误',
  10.         'status' => false,
  11.     ]);
  12. });

{tip} Since v1.6.0

location（刷新整个页面）

  1. // 跳转并提示成功信息
  2. $form->saved(function (Form $form) {
  3.     // 不传参数则刷新当前页面
  4.     // return $form->location();
  6.     return $form->location('auth/user', '保存成功');
  7. });
  9. // 跳转并提示错误信息
  10. $form->saved(function (Form $form) {
  11.     return $form->location('auth/user', [
  12.         'message' => '系统错误',
  13.         'status' => false,
  14.     ]);
  15. });

仅返回错误信息但不跳转

通过error方法可以在提交表单时返回错误提示信息

{tip} 此方法在creating、editing、uploading、uploaded事件中均不可用。

  1. $form->saving(function (Form $form) {
  2.     return $form->error('系统异常');
  3. });

返回字段验证出错信息

通过responseValidationMessages方法可以很方便的返回字段验证出错信息，而不需要使用Laravel validation功能。

普通使用

  1. protected function form()
  2. {
  3.     return Form::make(new Model(), function (Form $form) {
  4.         if (...) { // 验证逻辑
  5.             $form->responseValidationMessages('title', 'title格式错误');
  7.             // 如有多个错误信息，第二个参数可以传数组
  8.             $form->responseValidationMessages('content', ['content格式错误', 'content不能为空']);
  9.         }
  10.     });
  11. }

在事件中使用

{tip} 此方法仅在submitted事件中可用

  1. $form->submitted(function (Form $form) {
  2.     // 接收表单参数
  3.     $title = $form->title;
  5.     if (...) { // 验证逻辑
  6.         $form->responseValidationMessages('title', 'title格式错误');
  8.         // 如有多个错误信息，第二个参数可以传数组
  9.         $form->responseValidationMessages('content', ['content格式错误', 'content不能为空']);
  10.     }
  11. });