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表及其模型。

更新

请更新到tem后重新发布tem资产

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 中可用

所有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 许可协议下发布。

© 2017 Roshan Gautam，保留所有权利。