AbstractQueue
in package
implements
QueueInterface
AbstractYes
Abstract queue class
Tags
Table of Contents
Interfaces
- QueueInterface
- Queue interface
Properties
- $adapter : AdapterInterface|TaskAdapterInterface
- Queue adapter
- $name : string
- Queue name
Methods
- adapter() : AdapterInterface|TaskAdapterInterface
- Get adapter (alias)
- clear() : AbstractQueue
- Clear queue
- getAdapter() : AdapterInterface|TaskAdapterInterface
- Get adapter
- getName() : string
- Get name
- hasName() : bool
- Has name
- run() : array<string|int, mixed>
- Run schedule
- setAdapter() : Queue
- Set adapter
- setName() : AbstractQueue
- Set name
- work() : AbstractJob|null
- Work next job
Properties
$adapter
Queue adapter
protected
AdapterInterface|TaskAdapterInterface
$adapter
$name
Queue name
protected
string
$name
Methods
adapter()
Get adapter (alias)
public
adapter() : AdapterInterface|TaskAdapterInterface
Return values
AdapterInterface|TaskAdapterInterfaceclear()
Clear queue
public
abstract clear() : AbstractQueue
Return values
AbstractQueuegetAdapter()
Get adapter
public
getAdapter() : AdapterInterface|TaskAdapterInterface
Return values
AdapterInterface|TaskAdapterInterfacegetName()
Get name
public
getName() : string
Return values
stringhasName()
Has name
public
hasName() : bool
Return values
boolrun()
Run schedule
public
abstract run([Application|null $application = null ]) : array<string|int, mixed>
Parameters
- $application : Application|null = null
Tags
Return values
array<string|int, mixed>setAdapter()
Set adapter
public
setAdapter(AdapterInterface|TaskAdapterInterface $adapter) : Queue
Parameters
- $adapter : AdapterInterface|TaskAdapterInterface
Return values
QueuesetName()
Set name
public
setName(string $name) : AbstractQueue
Parameters
- $name : string
Return values
AbstractQueuework()
Work next job
public
abstract work([Application|null $application = null ]) : AbstractJob|null
Parameters
- $application : Application|null = null