README

Kue 是一个基于 redis 的优先级任务队列，为 node.js 构建。

此包是 Kue JSON API 的 PHP 客户端。它与 Kue 版本 0.10.3 进行了测试，并将尽力保持与 Kue 变更的同步。

要求

PHP 5.5

安装

安装此扩展的首选方式是通过 Composer。

运行以下命令

composer require kop/php-kue-client "dev-master"

或者在您的 composer.json 文件的 require 部分添加以下内容

"kop/php-kue-client": "dev-master"

使用方法

为了连接到 Kue JSON API，您只需创建一个 \kop\kue\Client 的实例即可

$client = new \kop\kue\Client('https://kue-dashboard.domain.com');

// Get Kue stats
$stats = $client->stats();

// Create a new Job
$response = $client->jobs()->create(
    'email',
    [
        'title' => 'welcome email for tj',
        'to' => 'tj@learnboost.com',
        'template' => 'welcome-email',
    ],
    [
        'priority' => 'high',
    ],
);
$jobID = $response['id'];

// Get Job by it's ID
$job = $client->jobs()->get($jobID);

// Delete Job by it's ID
$client->jobs()->delete($jobID);

支持的 API 端点

此 API 客户端支持 Kue JSON API 暴露的所有端点。以下是将用于映射到这些 API 端点的方法

通用

以下方法

stats() - 返回状态计数和工作活动时间（毫秒）;
jobs() - 返回与 Kue 任务相关的命令。

任务

可以通过 \kop\kue\Client 的 jobs() 方法访问以下方法。

search($query) - 搜索任务；
create($type, $data, $options = []) - 创建新的任务；
get($id) - 通过 ID 返回任务；
logs($id) - 通过任务 ID 返回任务日志；
delete($id) - 通过 ID 删除任务。

配置

此 API 客户端实现了与日志记录和错误处理相关的某些附加功能。有关更多详细信息，请参阅类源代码 - 它有良好的文档，不应引起任何疑问。

报告

在 GitHub 问题跟踪器上报告任何问题。

许可证

本项目在 MIT 许可证下发布。有关详细信息，请参阅附带 LICENSE.md。

kop / php-kue-client

维护者

详细信息

README

要求

安装

使用方法

支持的 API 端点

通用

任务

配置

报告

许可证

资源