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应用程序的config/app.php配置文件的providers数组中

Studio\Totem\Providers\TotemServiceProvider::class,

一旦安装并注册了 Laravel Totem

• 运行迁移

php artisan migrate

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

php artisan totem:assets

表前缀

Totems的表使用通用名称，可能与项目中的现有表冲突。为了缓解这种情况，可以在.env文件中设置 TOTEM_TABLE_PREFIX 参数，这将将前缀应用于所有Totems表及其模型。

更新

请在更新到新版本后重新发布totem资产

php artisan totem:assets

配置

定时任务

此包假设您对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 中提供命令

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

protected $hidden = true;

L5.5 及以后版本的所有命令都是自动注册的，所以这不会是问题。

命令参数

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

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

在上面的示例中，name 是一个参数，而 greetings 是一个可选参数

控制台命令

除了仪表板外，Totem 还提供了一项工匠命令来查看计划任务列表。

php artisan schedule:list

屏幕截图

任务列表

任务详情

编辑任务

用于查看计划任务的 Artisan 命令

更新日志

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

致谢

• Roshan Gautam
• 开源贡献者

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

贡献与协议

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

许可证

本软件按照MIT许可证发布。

© 2020 Roshan Gautam，版权所有。