README

简介

从精美仪表板管理您的 Laravel Schedule。根据您的喜好安排 Laravel Console Commands。无需返回代码即可动态启用/禁用计划任务。

文档

兼容性矩阵

安装

Totem 需要 Laravel v5.4 及以上版本，请参考上述表格了解兼容性。使用 composer 将 totem 安装到您的 Laravel 项目中

composer require studio/laravel-totem

Laravel Totem 支持Laravel v5.5+的自动包发现，因此Laravel v5.5+中不需要注册服务提供者

将 TotemServiceProvider 添加到Laravel v5.4应用程序的配置文件app.php中的providers数组

Studio\Totem\Providers\TotemServiceProvider::class,

一旦安装并注册了 Laravel Totem

• 运行迁移

php artisan migrate

• 使用以下命令将 Totem 资产发布到您的公共文件夹

php artisan totem:assets

表前缀

Totem的表使用通用名称，可能与项目中现有的表冲突。为缓解这一问题，可以在.env参数中设置TOTEM_TABLE_PREFIX，这将为所有Totem的表及其模型应用前缀。

更新

请更新totem资产，以便在更新到新版本后使用

php artisan totem:assets

配置

cron作业

本包假设您对Laravel的任务调度和Laravel控制台命令有很好的理解。在所有这些工作之前，请确保您已经运行了以下cron

* * * * * php /path-to-your-project/artisan schedule:run >> /dev/null 2>&1

Web仪表板

Laravel Totem的仪表板灵感来自Laravel Horizon。就像Horizon一样，您可以配置对Totem仪表板的认证。将以下内容添加到AppServiceProvider的boot方法中或任何合适的位置。

use Studio\Totem\Totem;

Totem::auth(function($request) {
    // return true / false . For e.g.
    return Auth::check();
});

默认情况下，Totem的仪表板仅适用于本地环境。要查看仪表板，请将浏览器指向应用程序的/totem。例如，laravel.dev/totem。

命令下拉过滤

默认情况下，Totem在创建/编辑任务时输出所有Artisan命令。为了使此下拉菜单更简洁，可以在totem.php配置文件中设置过滤配置功能。

示例过滤器

'artisan' => [
    'command_filter' => [
        'stats:*',
        'email:daily-reports'
    ],
],

此功能使用fnmatch语法来过滤显示的命令。 stats:*将匹配所有以stats:开头的Artisan命令，而email:daily-reports将仅匹配名为email:daily-reports的命令。

此过滤器可以用作白名单或黑名单。默认情况下，它作为白名单，但可以通过选项标志将其设置为黑名单。

'artisan' => [
    'command_filter' => [
        'stats:*',
        'email:daily-reports'
    ],
    'whitelist' => true,
],

如果白名单的值为false，则过滤器作为黑名单。

'whitelist' => false

中间件

Laravel Totem使用默认的web和api中间件，但如果需要自定义，可以通过设置适当的.env值来更改中间件。这些值可以在config/totem.php中找到。

在Laravel Totem中使命令可用

所有工匠命令都可以进行调度。如果您想将命令从Totem隐藏，请确保您的命令中设置了hidden属性为true。例如：

protected $hidden = true;

从L5.5版本开始，所有命令都将自动注册，所以这不会成为问题。

命令参数

如果您的命令需要参数或选项，请使用可选的命令参数字段。您可以通过以下方式以字符串的形式为命令提供参数：

name=john.doe --greetings='Welcome to the new world'

在上面的例子中，name是参数，而greetings是选项

控制台命令

除了仪表板之外，Totem还提供了一个 artisan 命令来查看调度任务列表。

php artisan schedule:list

截图

任务列表

任务详情

编辑任务

查看调度任务的 artisan 命令

变更日志

以下列出重要版本。有关项目的完整历史，请参阅变更日志。

鸣谢

• Roshan Gautam
• 开源贡献者

可以通过遵循我们的贡献指南提交错误报告、功能请求和拉取请求。

贡献与协议

• 版本控制
• 编码标准
• 拉取请求

许可证

本软件在MIT许可证下发布。

© 2020 Roshan Gautam，版权所有。