cms/src/queue/QueueInterface.php at 4.17.11 · craftcms/cms · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
<?php
/**
 * @link https://craftcms.com/
 * @copyright Copyright (c) Pixel & Tonic, Inc.
 * @license https://craftcms.github.io/license/
 */

namespace craft\queue;

use yii\base\InvalidArgumentException;
use yii\queue\Queue as BaseQueue;

/**
 * QueueInterface defines the common interface to be implemented by queue classes.
 *
 * @mixin BaseQueue
 * @author Pixel & Tonic, Inc. <support@pixelandtonic.com>
 * @since 3.0.0
 */
interface QueueInterface extends ReleasableQueueInterface
{
    /**
     * Runs all the queued-up jobs.
     *
     * @return mixed
     */
    public function run(): mixed;

    /**
     * Re-adds a failed job to the queue.
     *
     * @param string $id
     */
    public function retry(string $id): void;

    /**
     * Retries all failed jobs.
     *
     * @since 3.4.0
     */
    public function retryAll(): void;

    /**
     * Sets the progress for the currently reserved job.
     *
     * @param int $progress The job progress (1-100)
     * @param string|null $label The progress label
     */
    public function setProgress(int $progress, ?string $label = null): void;

    /**
     * Returns whether there are any waiting jobs.
     *
     * @return bool
     */
    public function getHasWaitingJobs(): bool;

    /**
     * Returns whether there are any reserved jobs.
     *
     * @return bool
     */
    public function getHasReservedJobs(): bool;

    /**
     * Returns the total number of jobs in the queue.
     *
     * @return int
     * @since 3.4.0
     */
    public function getTotalJobs(): int;

    /**
     * Returns info about the jobs in the queue.
     *
     * The response array should have sub-arrays with the following keys:
     *
     * - `id` – the job ID
     * - `delay` – the number of seconds remaining before the job will start
     * - `status` – the job status (1 = waiting, 2 = reserved, 3 = done, 4 = failed)
     * - `progress` – the job progress (0-100)
     * - `progressLabel` – the progress label (lazy-translated with [[\craft\i18n\Translation::translate()]])
     * - `description` – the job description (lazy-translated with [[\craft\i18n\Translation::translate()]])
     * - `error` – the error message (if the job failed)
     *
     * @param int|null $limit
     * @return array
     */
    public function getJobInfo(?int $limit = null): array;

    /**
     * Returns detailed info about a single job.
     *
     * The response array can contain the following keys:
     *
     * - `delay` – the number of seconds remaining before the job will start
     * - `status` – the job status (1 = waiting, 2 = reserved, 3 = done, 4 = failed)
     * - `progress` – the job progress (0-100)
     * - `progressLabel` – the progress label (lazy-translated with [[\craft\i18n\Translation::translate()]])
     * - `description` – the job description (lazy-translated with [[\craft\i18n\Translation::translate()]])
     * - `ttr` – the job’s time-to-reserve, in seconds
     * - `error` – the error message (if the job failed)
     * - `job` – the deserialized job
     *
     * Any other key/value pairs are allowed and will be displayed on the details page.
     *
     * @param string $id
     * @return array
     * @throws InvalidArgumentException if $id is an invalid job ID
     * @since 3.4.0
     */
    public function getJobDetails(string $id): array;
}