README

php-resque-scheduler 是 resque-scheduler 的 PHP 版本，它为 Resque 添加了对未来排程项的支持。

resque-scheduler 的 PHP 版本被设计成几乎是 Ruby 插件的直接拷贝，并设计成与 Resque 的 PHP 版本 php-resque 一起工作。

目前，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 的队列中。这意味着要执行延迟或计划中的作业，工人需要运行。

在根目录中包含了一个基本的 "启动并运行" 的 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 工人使用 resque-scheduler.php 很简单：$ 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