README

Fork chrisboulton/php-resque-scheduler

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 队列进行处理，以便在可用的 Resque 工作者处执行。

除了传递以秒为单位的相对时间外，您还可以将 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 将尝试从您的 include 路径中加载它（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