\Pop\Queue\AdapterAbstractAdapter

Queue adapter abstract class

Summary

Methods
Properties
Constants
hasJob()
getJob()
updateJob()
hasJobs()
getJobs()
hasCompletedJob()
hasCompletedJobs()
getCompletedJob()
getCompletedJobs()
hasFailedJob()
getFailedJob()
hasFailedJobs()
getFailedJobs()
push()
failed()
pop()
clear()
clearFailed()
flush()
flushFailed()
flushAll()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Methods

hasJob()

hasJob(mixed  $jobId) : boolean

Check if queue stack has job

Parameters

mixed $jobId

Returns

boolean

getJob()

getJob(mixed  $jobId, boolean  $unserialize = true) : array

Get job from queue stack by job ID

Parameters

mixed $jobId
boolean $unserialize

Returns

array

updateJob()

updateJob(mixed  $jobId, mixed  $completed = false, mixed  $increment = false) : void

Update job from queue stack by job ID

Parameters

mixed $jobId
mixed $completed
mixed $increment

hasJobs()

hasJobs(mixed  $queue) : boolean

Check if queue adapter has jobs

Parameters

mixed $queue

Returns

boolean

getJobs()

getJobs(mixed  $queue, boolean  $unserialize = true) : array

Get queue jobs

Parameters

mixed $queue
boolean $unserialize

Returns

array

hasCompletedJob()

hasCompletedJob(mixed  $jobId) : boolean

Check if queue stack has completed job

Parameters

mixed $jobId

Returns

boolean

hasCompletedJobs()

hasCompletedJobs(mixed  $queue) : boolean

Check if queue adapter has completed jobs

Parameters

mixed $queue

Returns

boolean

getCompletedJob()

getCompletedJob(mixed  $jobId, boolean  $unserialize = true) : array

Get queue completed job

Parameters

mixed $jobId
boolean $unserialize

Returns

array

getCompletedJobs()

getCompletedJobs(mixed  $queue, boolean  $unserialize = true) : array

Get queue completed jobs

Parameters

mixed $queue
boolean $unserialize

Returns

array

hasFailedJob()

hasFailedJob(mixed  $jobId) : boolean

Check if queue stack has failed job

Parameters

mixed $jobId

Returns

boolean

getFailedJob()

getFailedJob(mixed  $jobId, boolean  $unserialize = true) : array

Get failed job from queue stack by job ID

Parameters

mixed $jobId
boolean $unserialize

Returns

array

hasFailedJobs()

hasFailedJobs(mixed  $queue) : boolean

Check if queue adapter has failed jobs

Parameters

mixed $queue

Returns

boolean

getFailedJobs()

getFailedJobs(mixed  $queue, boolean  $unserialize = true) : array

Get queue failed jobs

Parameters

mixed $queue
boolean $unserialize

Returns

array

push()

push(mixed  $queue, mixed  $job, mixed  $priority = null) : string

Push job onto queue stack

Parameters

mixed $queue
mixed $job
mixed $priority

Returns

string

failed()

failed(mixed  $queue, mixed  $failedJob, \Exception  $exception = null) : void

Move failed job to failed queue stack

Parameters

mixed $queue
mixed $failedJob
\Exception $exception

pop()

pop(mixed  $jobId) : void

Pop job off of queue stack

Parameters

mixed $jobId

clear()

clear(mixed  $queue, boolean  $all = false) : void

Clear completed jobs off of the queue stack

Parameters

mixed $queue
boolean $all

clearFailed()

clearFailed(mixed  $queue) : void

Clear failed jobs off of the queue stack

Parameters

mixed $queue

flush()

flush(boolean  $all = false) : void

Flush all jobs off of the queue stack

Parameters

boolean $all

flushFailed()

flushFailed() : void

Flush all failed jobs off of the queue stack

flushAll()

flushAll() : void

Flush all pop queue items