示例
下面我们就开始开发一个用于查看登录用户信息的按钮：
使用命令创建Action类
首先需要先创建 Action 类，运行命令
php artisan admin:action
运行成功之后会看到命令窗口出现如下信息，让开发者选择一个 Action 类的类型，这里我们输入 0 就行
Which type of action would you like to make?:
[0] default
[1] grid-batch
[2] grid-row
[3] grid-tool
[4] form-tool
[5] show-tool
[6] tree-tool
> 0 # 输入 0
接着输入 Action 类名称，这里需要输入 大驼峰 风格的英文字母
Please enter a name of action class:
> ShowCurrentAdminUser
类名输入完成之后会出现以下信息让开发者输入类的命名空间，默认的命名空间是 App\Admin\Actions ，这里我们直接按回车跳过就行了
Please enter the namespace of action class [App\Admin\Actions]:
>
这样一个 Action 类就创建完成了，刚刚创建的类路径是 app/Admin/Actions/ShowCurrentAdminUser.php
使用
修改 Action 类如下
<?php
namespace App\Admin\Actions;
use Dcat\Admin\Admin;
use Dcat\Admin\Widgets\Table;
use Dcat\Admin\Actions\Action;
use Dcat\Admin\Actions\Response;
use Dcat\Admin\Traits\HasPermissions;
use Illuminate\Contracts\Auth\Authenticatable;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Http\Request;
class ShowCurrentAdminUser extends Action
{
/**
* 按钮标题
*
* @var string
*/
protected $title = '个人信息';
/**
* @var string
*/
protected $modalId = 'show-current-user';
/**
* 处理当前动作的请求接口，如果不需要请直接删除
*
* @param Request $request
*
* @return Response
*/
public function handle(Request $request)
{
// 获取当前登录用户模型
$user = Admin::user();
// 这里我们用表格展示模型数据
$table = Table::make($user->toArray());
return $this->response()
->success('查询成功')
->html($table);
}
/**
* 处理响应的HTML字符串，附加到弹窗节点中
*
* @return string
*/
protected function handleHtmlResponse()
{
return <<<'JS'
function (target, html, data) {
var $modal = $(target.data('target'));
$modal.find('.modal-body').html(html)
$modal.modal('show')
}
JS;
}
/**
* 设置HTML标签的属性
*
* @return void
*/
protected function setupHtmlAttributes()
{
// 添加class
$this->addHtmlClass('btn btn-primary');
// 保存弹窗的ID
$this->setHtmlAttribute('data-target', '#'.$this->modalId);
parent::setupHtmlAttributes();
}
/**
* 设置按钮的HTML，这里我们需要附加上弹窗的HTML
*
* @return string|void
*/
public function html()
{
// 按钮的html
$html = parent::html();
return <<<HTML
{$html}
<div class="modal fade" id="{$this->modalId}" tabindex="-1" role="dialog">
<div class="modal-dialog modal-lg" role="document">
<div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">×</span></button>
<h4 class="modal-title">{$this->title()}</h4>
</div>
<div class="modal-body"></div>
</div>
</div>
</div>
HTML;
}
/**
* 确认弹窗信息，如不需要可以删除此方法
*
* @return string|void
*/
public function confirm()
{
// return ['Confirm?', 'contents'];
}
/**
* 动作权限判断，返回false则表示无权限，如果不需要可以删除此方法
*
* @param Model|Authenticatable|HasPermissions|null $user
*
* @return bool
*/
protected function authorize($user): bool
{
return true;
}
/**
* 通过这个方法可以设置动作发起请求时需要附带的参数，如果不需要可以删除此方法
*
* @return array
*/
protected function parameters()
{
return [];
}
}
修改完之后就可以开始使用了
<?php
use App\Admin\Actions\ShowCurrentAdminUser;
class IndexController
{
public function index(Content $content)
{
return $content->body(ShowCurrentAdminUser::make());
}
}
效果如下
方法
Dcat\Admin\Actions\Action 类方法说明
创建实例 (make)
此方法是一个静态方法，用于实例化动作类
$action = MyAction::make($param1, $param2...);
处理请求 (handle)
当Action类中包含此方法之时，目标元素会被绑定通过event属性设置的事件（默认为click ）。如果事件被触发，则会向服务器发起请求，而handle方法则可以处理并响应此请求。
设置请求数据 (parameters)
通过这个方法可以设置动作发起请求时需要附带的参数
<?php
use Dcat\Admin\Actions\Action;
use Illuminate\Http\Request;
class MyAction extends Action
{
public function handle(Request $request)
{
// 接收参数
$key1 = $request->get('key1');
$key2 = $request->get('key2');
return $this->response()->success('成功！');
}
public function parameters()
{
return [
'key1' => 'value1',
'key2' => 'value2',
];
}
}
确认弹窗 (confirm)
设置确认信息，此方法要求返回一个string类型参数。
当此方法返回值不为空时会加入确认窗功能，当事件被触发时自动弹出确认框，点击确认后才会进行下一步操作。
public function confirm()
{
return '你确定要删除此行内容吗？';
}
显示弹窗标题和内容
public function confirm()
{
return ['你确定要删除此行内容吗？', '弹窗内容'];
}
发起请求之前执行的JS代码 (actionScript)
设置动作执行的前置js代码，当按钮绑定的事件被触发后，发起请求之前会执行通过此方法设置的js代码，此方法要求返回一个js的匿名函数。
js匿名函数接收以下三个参数：
protected function actionScript()
{
return <<<JS
function (data, target, action) {
console.log('发起请求之前', data, target, action);
// return false; 在这里return false可以终止执行后面的操作
// 更改传递到接口的主键值
action.options.key = 123;
}
JS
}
处理服务器响应的HTML代码 (handleHtmlResponse)
处理服务器响应的HTML代码，此方法要求返回一个js匿名函数。
protected function handleHtmlResponse()
{
return <<<'JS'
function (target, html, data) {
// target 参数是动作按钮的JQ对象
// html 参数是接口返回HTML字符串
// data 参数是接口返回的完整数据的json对象
target.html(html);
}
JS;
}
权限 (authorize)
此方法用于判断登录用户的操作权限，默认返回true
protected function authorize($user): bool
{
return $user->can('do-action');
}
无权限响应 (failedAuthorization)
此方法用于设置鉴权失败的响应内容，如果需要则可覆写此方法
public function failedAuthorization()
{
return $this->response()->error(__('admin.deny'));
}
隐藏或显示 (disable)
设置显示或隐藏此动作
// 隐藏
MyAction::make()->disable();
// 显示
MyAction::make()->disable(false);
判断是否显示 (allowed)
判断动作是否允许显示
if (MyAction::make()->allowed()) {
...
}
设置主键 (setKey)
设置数据主键
$id = ...;
MyAction::make()->setKey($id);
获取主键值 (getKey)
获取数据主键，此方法在handle方法内也同样可用
<?php
use Dcat\Admin\Actions\Action;
use Illuminate\Http\Request;
class MyAction extends Action
{
public function handle(Request $request)
{
$id = $this->getKey();
...
return $this->response()->success('成功！');
}
public function title()
{
return "标题 {$this->key()}";
}
}
获取目标元素样式 (getElementClass)
获取动作目标元素（按钮）的class
$class = MyAction::make()->getElementClass();
获取目标元素的Css选择器 (selector)
获取动作目标元素（按钮）的CSS选择器
$selector = MyAction::make()->selector();
Admin::script(
<<<JS
$('$selector').click(...);
JS
);
追加样式 (addHtmlClass)
追加获取动作目标元素（按钮）的class
MyAction::make()->addHtmlClass('btn btn-primary');
MyAction::make()->addHtmlClass(['btn', 'btn-primary']);
设置目标元素的HTML (html)
此方法用于设置动作目标元素的HTML代码，如有需要可以覆写
protected function html()
{
return <<<HTML
<a {$this->formatHtmlAttributes()}>{$this->title()}</a>
HTML;
}
添加JS代码 (script)
此方法用于在render方法执行完毕之前添加JS代码
protected function script()
{
return <<<JS
console.log('...')
JS;
}
设置目标元素的HTML属性 (setHtmlAttribute)
设置目标元素的HTML标签属性
MyAction::make()->setHtmlAttribute('name', $value);
// 批量设置
MyAction::make()->setHtmlAttribute(['name' => $value]);