Documentation

AbstractAdapter
in package
implements AdapterInterface

Queue adapter abstract class

Tags
category

Pop

author

Nick Sagona, III dev@nolainteractive.com

copyright

Copyright (c) 2009-2021 NOLA Interactive, LLC. (http://www.nolainteractive.com)

license

http://www.popphp.org/license New BSD License

version
1.2.0

Interfaces, Classes and Traits

AdapterInterface
Queue adapter interface

Table of Contents

clear()  : void
Clear completed jobs off of the queue stack
clearFailed()  : void
Clear failed jobs off of the queue stack
failed()  : void
Move failed job to failed queue stack
flush()  : void
Flush all jobs off of the queue stack
flushAll()  : void
Flush all pop queue items
flushFailed()  : void
Flush all failed jobs off of the queue stack
getCompletedJob()  : array<string|int, mixed>
Get queue completed job
getCompletedJobs()  : array<string|int, mixed>
Get queue completed jobs
getFailedJob()  : array<string|int, mixed>
Get failed job from queue stack by job ID
getFailedJobs()  : array<string|int, mixed>
Get queue failed jobs
getJob()  : array<string|int, mixed>
Get job from queue stack by job ID
getJobs()  : array<string|int, mixed>
Get queue jobs
hasCompletedJob()  : bool
Check if queue stack has completed job
hasCompletedJobs()  : bool
Check if queue adapter has completed jobs
hasFailedJob()  : bool
Check if queue stack has failed job
hasFailedJobs()  : bool
Check if queue adapter has failed jobs
hasJob()  : bool
Check if queue stack has job
hasJobs()  : bool
Check if queue adapter has jobs
pop()  : void
Pop job off of queue stack
push()  : string
Push job onto queue stack
updateJob()  : void
Update job from queue stack by job ID

Methods

clear()

Clear completed jobs off of the queue stack

public abstract clear(mixed $queue[, bool $all = false ]) : void
Parameters
$queue : mixed
$all : bool = false
Return values
void

clearFailed()

Clear failed jobs off of the queue stack

public abstract clearFailed(mixed $queue) : void
Parameters
$queue : mixed
Return values
void

failed()

Move failed job to failed queue stack

public abstract failed(mixed $queue, mixed $failedJob[, Exception $exception = null ]) : void
Parameters
$queue : mixed
$failedJob : mixed
$exception : Exception = null
Return values
void

flush()

Flush all jobs off of the queue stack

public abstract flush([bool $all = false ]) : void
Parameters
$all : bool = false
Return values
void

flushAll()

Flush all pop queue items

public abstract flushAll() : void
Return values
void

flushFailed()

Flush all failed jobs off of the queue stack

public abstract flushFailed() : void
Return values
void

getCompletedJob()

Get queue completed job

public abstract getCompletedJob(mixed $jobId[, bool $unserialize = true ]) : array<string|int, mixed>
Parameters
$jobId : mixed
$unserialize : bool = true
Return values
array<string|int, mixed>

getCompletedJobs()

Get queue completed jobs

public abstract getCompletedJobs(mixed $queue[, bool $unserialize = true ]) : array<string|int, mixed>
Parameters
$queue : mixed
$unserialize : bool = true
Return values
array<string|int, mixed>

getFailedJob()

Get failed job from queue stack by job ID

public abstract getFailedJob(mixed $jobId[, bool $unserialize = true ]) : array<string|int, mixed>
Parameters
$jobId : mixed
$unserialize : bool = true
Return values
array<string|int, mixed>

getFailedJobs()

Get queue failed jobs

public abstract getFailedJobs(mixed $queue[, bool $unserialize = true ]) : array<string|int, mixed>
Parameters
$queue : mixed
$unserialize : bool = true
Return values
array<string|int, mixed>

getJob()

Get job from queue stack by job ID

public abstract getJob(mixed $jobId[, bool $unserialize = true ]) : array<string|int, mixed>
Parameters
$jobId : mixed
$unserialize : bool = true
Return values
array<string|int, mixed>

getJobs()

Get queue jobs

public abstract getJobs(mixed $queue[, bool $unserialize = true ]) : array<string|int, mixed>
Parameters
$queue : mixed
$unserialize : bool = true
Return values
array<string|int, mixed>

hasCompletedJob()

Check if queue stack has completed job

public abstract hasCompletedJob(mixed $jobId) : bool
Parameters
$jobId : mixed
Return values
bool

hasCompletedJobs()

Check if queue adapter has completed jobs

public abstract hasCompletedJobs(mixed $queue) : bool
Parameters
$queue : mixed
Return values
bool

hasFailedJob()

Check if queue stack has failed job

public abstract hasFailedJob(mixed $jobId) : bool
Parameters
$jobId : mixed
Return values
bool

hasFailedJobs()

Check if queue adapter has failed jobs

public abstract hasFailedJobs(mixed $queue) : bool
Parameters
$queue : mixed
Return values
bool

hasJob()

Check if queue stack has job

public abstract hasJob(mixed $jobId) : bool
Parameters
$jobId : mixed
Return values
bool

hasJobs()

Check if queue adapter has jobs

public abstract hasJobs(mixed $queue) : bool
Parameters
$queue : mixed
Return values
bool

pop()

Pop job off of queue stack

public abstract pop(mixed $jobId) : void
Parameters
$jobId : mixed
Return values
void

push()

Push job onto queue stack

public abstract push(mixed $queue, mixed $job[, mixed $priority = null ]) : string
Parameters
$queue : mixed
$job : mixed
$priority : mixed = null
Return values
string

updateJob()

Update job from queue stack by job ID

public abstract updateJob(mixed $jobId[, mixed $completed = false ][, mixed $increment = false ]) : void
Parameters
$jobId : mixed
$completed : mixed = false
$increment : mixed = false
Return values
void

Search results