QueueInterface
in
Queue interface
Tags
Table of Contents
Methods
- adapter() : AdapterInterface|TaskAdapterInterface
- Get adapter (alias)
- clear() : QueueInterface
- Clear queue
- getAdapter() : AdapterInterface|TaskAdapterInterface
- Get adapter
- getName() : string
- Get name
- hasName() : bool
- Has name
- run() : array<string|int, mixed>
- Run schedule
- setAdapter() : QueueInterface
- Set adapter
- setName() : QueueInterface
- Set name
- work() : AbstractJob|null
- Work next job
Methods
adapter()
Get adapter (alias)
public
adapter() : AdapterInterface|TaskAdapterInterface
Return values
AdapterInterface|TaskAdapterInterfaceclear()
Clear queue
public
clear() : QueueInterface
Return values
QueueInterfacegetAdapter()
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
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) : QueueInterface
Parameters
- $adapter : AdapterInterface|TaskAdapterInterface
Return values
QueueInterfacesetName()
Set name
public
setName(string $name) : QueueInterface
Parameters
- $name : string
Return values
QueueInterfacework()
Work next job
public
work([Application|null $application = null ]) : AbstractJob|null
Parameters
- $application : Application|null = null