QueueManager
in package
implements
Factory, Monitor
Tags
Interfaces, Classes and Traits
Table of Contents
- $app : Application
- The application instance.
- $connections : array<string|int, mixed>
- The array of resolved queue connections.
- $connectors : array<string|int, mixed>
- The array of resolved queue connectors.
- __call() : mixed
- Dynamically pass calls to the default connection.
- __construct() : void
- Create a new queue manager instance.
- addConnector() : void
- Add a queue connection resolver.
- after() : void
- Register an event listener for the after job event.
- before() : void
- Register an event listener for the before job event.
- connected() : bool
- Determine if the driver is connected.
- connection() : Queue
- Resolve a queue connection instance.
- exceptionOccurred() : void
- Register an event listener for the exception occurred job event.
- extend() : void
- Add a queue connection resolver.
- failing() : void
- Register an event listener for the failed job event.
- getDefaultDriver() : string
- Get the name of the default queue connection.
- getName() : string
- Get the full name for the given connection.
- isDownForMaintenance() : bool
- Determine if the application is in maintenance mode.
- looping() : void
- Register an event listener for the daemon queue loop.
- setDefaultDriver() : void
- Set the name of the default queue connection.
- stopping() : void
- Register an event listener for the daemon queue stopping.
- getConfig() : array<string|int, mixed>
- Get the queue connection configuration.
- getConnector() : ConnectorInterface
- Get the connector for a given driver.
- resolve() : Queue
- Resolve a queue connection.
Properties
$app
The application instance.
protected
Application
$app
$connections
The array of resolved queue connections.
protected
array<string|int, mixed>
$connections
= []
$connectors
The array of resolved queue connectors.
protected
array<string|int, mixed>
$connectors
= []
Methods
__call()
Dynamically pass calls to the default connection.
public
__call(string $method, array<string|int, mixed> $parameters) : mixed
Parameters
- $method : string
- $parameters : array<string|int, mixed>
Return values
mixed —__construct()
Create a new queue manager instance.
public
__construct(Application $app) : void
Parameters
- $app : Application
Return values
void —addConnector()
Add a queue connection resolver.
public
addConnector(string $driver, Closure $resolver) : void
Parameters
- $driver : string
- $resolver : Closure
Return values
void —after()
Register an event listener for the after job event.
public
after(mixed $callback) : void
Parameters
- $callback : mixed
Return values
void —before()
Register an event listener for the before job event.
public
before(mixed $callback) : void
Parameters
- $callback : mixed
Return values
void —connected()
Determine if the driver is connected.
public
connected([string $name = null ]) : bool
Parameters
- $name : string = null
Return values
bool —connection()
Resolve a queue connection instance.
public
connection([string $name = null ]) : Queue
Parameters
- $name : string = null
Return values
Queue —exceptionOccurred()
Register an event listener for the exception occurred job event.
public
exceptionOccurred(mixed $callback) : void
Parameters
- $callback : mixed
Return values
void —extend()
Add a queue connection resolver.
public
extend(string $driver, Closure $resolver) : void
Parameters
- $driver : string
- $resolver : Closure
Return values
void —failing()
Register an event listener for the failed job event.
public
failing(mixed $callback) : void
Parameters
- $callback : mixed
Return values
void —getDefaultDriver()
Get the name of the default queue connection.
public
getDefaultDriver() : string
Return values
string —getName()
Get the full name for the given connection.
public
getName([string $connection = null ]) : string
Parameters
- $connection : string = null
Return values
string —isDownForMaintenance()
Determine if the application is in maintenance mode.
public
isDownForMaintenance() : bool
Return values
bool —looping()
Register an event listener for the daemon queue loop.
public
looping(mixed $callback) : void
Parameters
- $callback : mixed
Return values
void —setDefaultDriver()
Set the name of the default queue connection.
public
setDefaultDriver(string $name) : void
Parameters
- $name : string
Return values
void —stopping()
Register an event listener for the daemon queue stopping.
public
stopping(mixed $callback) : void
Parameters
- $callback : mixed
Return values
void —getConfig()
Get the queue connection configuration.
protected
getConfig(string $name) : array<string|int, mixed>
Parameters
- $name : string
Return values
array<string|int, mixed> —getConnector()
Get the connector for a given driver.
protected
getConnector(string $driver) : ConnectorInterface
Parameters
- $driver : string
Tags
Return values
ConnectorInterface —resolve()
Resolve a queue connection.
protected
resolve(string $name) : Queue
Parameters
- $name : string