Documentation

AbstractAdapter
in package
implements AdapterInterface

AbstractYes

Adapter abstract class

Tags
category

Pop

author

Nick Sagona, III dev@nolainteractive.com

copyright

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

license

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

version
2.1.0

Table of Contents

Interfaces

AdapterInterface
Adapter interface

Properties

$priority  : string
Queue type

Methods

__construct()  : mixed
Constructor
clear()  : AbstractAdapter
Clear jobs out of queue
clearFailed()  : AbstractAdapter
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()  : AbstractAdapter
Set queue priority

Properties

Methods

__construct()

Constructor

public __construct([string|null $priority = null ]) : mixed

Instantiate the adapter object

Parameters
$priority : string|null = null

getEnd()

Get queue end index

public abstract getEnd() : int
Return values
int

getFailedJob()

Get failed job

public abstract getFailedJob(int $index[, bool $unserialize = true ]) : mixed
Parameters
$index : int
$unserialize : bool = true

getFailedJobs()

Get adapter failed jobs

public abstract 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
string

getStart()

Get queue start index

public abstract getStart() : int
Return values
int

getStatus()

Get queue job status

public abstract getStatus(int $index) : int
Parameters
$index : int
Return values
int

hasFailedJob()

Check if adapter has failed job

public abstract hasFailedJob(int $index) : bool
Parameters
$index : int
Return values
bool

hasFailedJobs()

Check if adapter has failed jobs

public abstract hasFailedJobs() : bool
Return values
bool

hasJobs()

Check if adapter has jobs

public abstract hasJobs() : bool
Return values
bool

isLifo()

Is LIFO (alias to FILO)

public isLifo() : bool
Return values
bool

isLilo()

Is LILO (alias to FIFO)

public isLilo() : bool
Return values
bool

        
On this page

Search results