david-garcia/php-resque-scheduler

此软件包已被放弃,不再维护。作者建议使用 symfony/messenger 软件包。

chrisboulton/php-resque-scheduler 的分支,添加了一些我需要用于另一个项目的更新

1.1.2 2017-12-05 15:05 UTC

This package is auto-updated.

Last update: 2021-06-25 08:22:08 UTC


README

php-resque-scheduler 是 resque-scheduler 的 PHP 版本,为 Resque 添加了对未来调度项目的支持。

resque-scheduler 的 PHP 版本被设计成尽可能接近 Ruby 插件,旨在与 resque 的 PHP 版本一起工作。

目前,php-resque-scheduler 仅支持延迟作业,即能够在特定时间戳或秒数后将作业推送到队列中。计划在未来版本中支持重复作业(类似于 CRON)。

由于 PHP 版本几乎是 Ruby 版本的直接 API 复制品,因此它也与 Ruby 版本的 Web 界面兼容,该界面提供了查看和管理延迟作业的能力。

请注意

这是一个分支,我进行了一些微小的调整,以便应用于另一个项目。

延迟作业

以下是 Ruby resque-scheduler 文档的引用

延迟作业是在未来某个时间点需要放入队列的一次性作业。一个经典的例子是发送电子邮件

require 'Resque/Resque.php';
require 'ResqueScheduler/ResqueScheduler.php';

$in = 3600;
$args = array('id' => $user->id);
ResqueScheduler::enqueueIn($in, 'email', 'SendFollowUpEmail', $args);

上述代码将作业存储在延迟队列中 1 小时,然后从延迟队列中取出作业,并提交到 Resque 的 email 队列以供处理,一旦有可用的工人。

除了传递以秒为单位的相对时间外,还可以将 DateTime 对象或包含 UNIX 时间戳的整数传递给 enqueueAt 方法

require 'Resque/Resque.php';
require 'ResqueScheduler/ResqueScheduler.php';

$time = 1332067214;
ResqueScheduler::enqueueAt($time, 'email', 'SendFollowUpEmail', $args);

$datetime = new DateTime('2012-03-18 13:21:49');
ResqueScheduler::enqueueAt($datetime, 'email', 'SendFollowUpEmail', $args);

注意:resque-scheduler 不能保证作业将在指定的时间触发。在指定的时间,resque-scheduler 将从延迟队列中取出作业并将其推送到 Resque 中相应的队列。下一个可用的 Resque 工人将获取作业。为了尽可能快速地处理,请保持队列尽可能空。

工人

与 resque 一样,resque-scheduler 包含一个在后台运行的工人。此工人负责从调度/延迟队列中提取项并将它们添加到 resque 的队列中。这意味着要执行延迟或计划作业,需要运行工人。

包含在根目录中的基本 "up-and-running" resque-scheduler.php 文件,它设置了一个运行中的工人环境。它接受与 php-resque 相同的许多环境变量

  • REDIS_BACKEND - 要连接的 Redis 服务器
  • LOGGING - 启用将日志记录到 STDOUT
  • VERBOSE - 启用详细日志记录
  • VVERBOSE - 启用非常详细日志记录
  • INTERVAL - 在检查计划/延迟队列之前暂停此长时间
  • APP_INCLUDE - 启动时包含此文件(以启动您的应用程序)
  • PIDFILE - 将工人的 PID 写入此文件

resque-scheduler 工作进程需要 resque 才能运行。示例 resque-scheduler.php 工作进程允许您通过提供一个 RESQUE_PHP 环境变量来指定 Resque.php 的路径。如果没有提供且 resque 尚未加载,resque-scheduler 将尝试从您的包含路径中加载它(require_once 'Resque/Resque.php';'

使用 resque-scheduler.php 很容易启动 resque-scheduler 工作进程:$ RESQUE_PHP=../resque/lib/Resque/Resque.php php resque-scheduler.php

事件/钩子系统

php-resque-scheduler 使用与 php-resque 相同的事件系统,并公开以下事件。

afterSchedule

在作业被添加到调度之后调用。传递的参数包括时间戳、作业的队列、作业的类名和作业的参数。

beforeDelayedEnqueue

在作业从延迟队列中取出并即将被添加到 resque 队列之前立即调用。传递的参数包括作业的队列、作业的类名和作业的参数。

贡献者

  • chrisboulton
  • rayward
  • atorres757
  • tonypiper
  • biinari
  • cballou