AdapterInterface
in
Adapter interface
Tags
Table of Contents
Methods
- clear() : AdapterInterface
- Clear jobs out of queue
- clearFailed() : AdapterInterface
- Clear failed jobs out of the queue
- getEnd() : int
- Get queue end index
- getFailedJob() : mixed
- Get failed job
- getFailedJobs() : array<string|int, mixed>
- Get adapter failed jobs
- getPriority() : string
- Get queue priority
- getStart() : int
- Get queue start index
- getStatus() : int
- Get queue job status
- hasFailedJob() : bool
- Check if adapter has failed job
- hasFailedJobs() : bool
- Check if adapter has failed jobs
- hasJobs() : bool
- Check if adapter has jobs
- isFifo() : bool
- Is FIFO
- isFilo() : bool
- Is FILO
- isLifo() : bool
- Is LIFO (alias to FILO)
- isLilo() : bool
- Is LILO (alias to FIFO)
- pop() : AbstractJob|null
- Pop job off of queue
- push() : AdapterInterface
- Push job on to queue
- setPriority() : AdapterInterface
- Set queue priority
Methods
clear()
Clear jobs out of queue
public
clear() : AdapterInterface
Return values
AdapterInterfaceclearFailed()
Clear failed jobs out of the queue
public
clearFailed() : AdapterInterface
Return values
AdapterInterfacegetEnd()
Get queue end index
public
getEnd() : int
Return values
intgetFailedJob()
Get failed job
public
getFailedJob(int $index[, bool $unserialize = true ]) : mixed
Parameters
- $index : int
- $unserialize : bool = true
getFailedJobs()
Get adapter failed jobs
public
getFailedJobs([bool $unserialize = true ]) : array<string|int, mixed>
Parameters
- $unserialize : bool = true
Return values
array<string|int, mixed>getPriority()
Get queue priority
public
getPriority() : string
Return values
stringgetStart()
Get queue start index
public
getStart() : int
Return values
intgetStatus()
Get queue job status
public
getStatus(int $index) : int
Parameters
- $index : int
Return values
inthasFailedJob()
Check if adapter has failed job
public
hasFailedJob(int $index) : bool
Parameters
- $index : int
Return values
boolhasFailedJobs()
Check if adapter has failed jobs
public
hasFailedJobs() : bool
Return values
boolhasJobs()
Check if adapter has jobs
public
hasJobs() : bool
Return values
boolisFifo()
Is FIFO
public
isFifo() : bool
Return values
boolisFilo()
Is FILO
public
isFilo() : bool
Return values
boolisLifo()
Is LIFO (alias to FILO)
public
isLifo() : bool
Return values
boolisLilo()
Is LILO (alias to FIFO)
public
isLilo() : bool
Return values
boolpop()
Pop job off of queue
public
pop() : AbstractJob|null
Return values
AbstractJob|nullpush()
Push job on to queue
public
push(AbstractJob $job) : AdapterInterface
Parameters
- $job : AbstractJob
Return values
AdapterInterfacesetPriority()
Set queue priority
public
setPriority([string $priority = 'FIFO' ]) : AdapterInterface
Parameters
- $priority : string = 'FIFO'