README

简介

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

文档

兼容性矩阵

安装

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

composer require cebugle/laravel-totem

Laravel Totem 支持自动包发现，因此不需要注册服务提供者。

一旦 Laravel Totem 安装并注册，

• 运行迁移

php artisan migrate

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

php artisan totem:assets

表前缀

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

更新

请在更新 Totem 到新版本后重新发布 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 的启动方法或任何合适的地方。

use Cebugle\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 还提供了一个 artisan 命令来查看计划的任务列表。

php artisan schedule:list

屏幕截图

任务列表

任务详情

编辑任务

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

变更日志

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

致谢

• Roshan Gautam
• 开源贡献者

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

贡献与协议

• 版本管理
• 编码规范
• 拉取请求

许可协议

本软件根据MIT 许可协议发布。

© 2020 Roshan Gautam，版权所有。