Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
n/a
0 / 0
n/a
0 / 0
CRAP
n/a
0 / 0
1<?php
2/**
3 * Pop PHP Framework (http://www.popphp.org/)
4 *
5 * @link       https://github.com/popphp/popphp-framework
6 * @author     Nick Sagona, III <dev@nolainteractive.com>
7 * @copyright  Copyright (c) 2009-2023 NOLA Interactive, LLC. (http://www.nolainteractive.com)
8 * @license    http://www.popphp.org/license     New BSD License
9 */
10
11/**
12 * @namespace
13 */
14namespace Pop\Queue\Adapter;
15
16use Pop\Queue\Processor\Jobs\AbstractJob;
17use Pop\Queue\Queue;
18
19/**
20 * Queue adapter interface
21 *
22 * @category   Pop
23 * @package    Pop\Queue
24 * @author     Nick Sagona, III <dev@nolainteractive.com>
25 * @copyright  Copyright (c) 2009-2023 NOLA Interactive, LLC. (http://www.nolainteractive.com)
26 * @license    http://www.popphp.org/license     New BSD License
27 * @version    1.2.0
28 */
29interface AdapterInterface
30{
31
32    /**
33     * Check if queue stack has job
34     *
35     * @param  mixed $jobId
36     * @return boolean
37     */
38    public function hasJob($jobId);
39
40    /**
41     * Get job from queue stack by job ID
42     *
43     * @param  mixed   $jobId
44     * @param  boolean $unserialize
45     * @return array
46     */
47    public function getJob($jobId, $unserialize = true);
48
49    /**
50     * Update job from queue stack by job ID
51     *
52     * @param  mixed $jobId
53     * @param  mixed $completed
54     * @param  mixed $increment
55     * @return void
56     */
57    public function updateJob($jobId, $completed = false, $increment = false);
58
59    /**
60     * Check if queue adapter has jobs
61     *
62     * @param  mixed $queue
63     * @return boolean
64     */
65    public function hasJobs($queue);
66
67    /**
68     * Get queue jobs
69     *
70     * @param  mixed   $queue
71     * @param  boolean $unserialize
72     * @return array
73     */
74    public function getJobs($queue, $unserialize = true);
75
76    /**
77     * Check if queue stack has completed job
78     *
79     * @param  mixed $jobId
80     * @return boolean
81     */
82    public function hasCompletedJob($jobId);
83
84    /**
85     * Check if queue adapter has completed jobs
86     *
87     * @param  mixed $queue
88     * @return boolean
89     */
90    public function hasCompletedJobs($queue);
91
92    /**
93     * Get queue completed jobs
94     *
95     * @param  mixed   $queue
96     * @param  boolean $unserialize
97     * @return array
98     */
99    public function getCompletedJobs($queue, $unserialize = true);
100
101    /**
102     * Get queue completed job
103     *
104     * @param  mixed   $jobId
105     * @param  boolean $unserialize
106     * @return array
107     */
108    public function getCompletedJob($jobId, $unserialize = true);
109
110    /**
111     * Check if queue stack has failed job
112     *
113     * @param  mixed $jobId
114     * @return boolean
115     */
116    public function hasFailedJob($jobId);
117
118    /**
119     * Get failed job from queue stack by job ID
120     *
121     * @param  mixed   $jobId
122     * @param  boolean $unserialize
123     * @return array
124     */
125    public function getFailedJob($jobId, $unserialize = true);
126
127    /**
128     * Check if queue adapter has failed jobs
129     *
130     * @param  mixed $queue
131     * @return boolean
132     */
133    public function hasFailedJobs($queue);
134
135    /**
136     * Get queue jobs
137     *
138     * @param  mixed   $queue
139     * @param  boolean $unserialize
140     * @return array
141     */
142    public function getFailedJobs($queue, $unserialize = true);
143
144    /**
145     * Push job onto queue stack
146     *
147     * @param  mixed $queue
148     * @param  mixed $job
149     * @param  mixed $priority
150     * @return string
151     */
152    public function push($queue, $job, $priority = null);
153
154    /**
155     * Move failed job to failed queue stack
156     *
157     * @param  mixed      $queue
158     * @param  mixed      $failedJob
159     * @param  \Exception $exception
160     * @return void
161     */
162    public function failed($queue, $failedJob, \Exception $exception = null);
163
164    /**
165     * Pop job off of queue stack
166     *
167     * @param  mixed $jobId
168     * @return void
169     */
170    public function pop($jobId);
171
172    /**
173     * Clear completed jobs off of the queue stack
174     *
175     * @param  mixed   $queue
176     * @param  boolean $all
177     * @return void
178     */
179    public function clear($queue, $all = false);
180
181    /**
182     * Clear failed jobs off of the queue stack
183     *
184     * @param  mixed $queue
185     * @return void
186     */
187    public function clearFailed($queue);
188
189    /**
190     * Flush all jobs off of the queue stack
191     *
192     * @param  boolean $all
193     * @return void
194     */
195    public function flush($all = false);
196
197    /**
198     * Flush all failed jobs off of the queue stack
199     *
200     * @return void
201     */
202    public function flushFailed();
203
204    /**
205     * Flush all pop queue items
206     *
207     * @return void
208     */
209    public function flushAll();
210
211}