Manager
in package
Uses
CapsuleManagerTrait
Tags
Table of Contents
- $container : Container
- The container instance.
- $instance : object
- The current globally used instance.
- $manager : QueueManager
- The queue manager instance.
- __call() : mixed
- Pass dynamic instance methods to the manager.
- __callStatic() : mixed
- Dynamically pass methods to the default connection.
- __construct() : void
- Create a new queue capsule manager.
- addConnection() : void
- Register a connection with the manager.
- bulk() : mixed
- Push a new an array of jobs onto the queue.
- connection() : Queue
- Get a connection instance from the global manager.
- getConnection() : Queue
- Get a registered connection instance.
- getContainer() : Container
- Get the IoC container instance.
- getQueueManager() : QueueManager
- Get the queue manager instance.
- later() : mixed
- Push a new job onto the queue after a delay.
- push() : mixed
- Push a new job onto the queue.
- setAsGlobal() : void
- Make this capsule instance available globally.
- setContainer() : void
- Set the IoC container instance.
- registerConnectors() : void
- Register the default connectors that the component ships with.
- setupContainer() : void
- Setup the IoC container instance.
- setupDefaultConfiguration() : void
- Setup the default queue configuration options.
- setupManager() : void
- Build the queue manager instance.
Properties
$container
The container instance.
protected
Container
$container
$instance
The current globally used instance.
protected
static object
$instance
$manager
The queue manager instance.
protected
QueueManager
$manager
Methods
__call()
Pass dynamic instance methods to the manager.
public
__call(string $method, array<string|int, mixed> $parameters) : mixed
Parameters
- $method : string
- $parameters : array<string|int, mixed>
Return values
mixed —__callStatic()
Dynamically pass methods to the default connection.
public
static __callStatic(string $method, array<string|int, mixed> $parameters) : mixed
Parameters
- $method : string
- $parameters : array<string|int, mixed>
Return values
mixed —__construct()
Create a new queue capsule manager.
public
__construct([Container $container = null ]) : void
Parameters
- $container : Container = null
Return values
void —addConnection()
Register a connection with the manager.
public
addConnection(array<string|int, mixed> $config[, string $name = 'default' ]) : void
Parameters
- $config : array<string|int, mixed>
- $name : string = 'default'
Return values
void —bulk()
Push a new an array of jobs onto the queue.
public
static bulk(array<string|int, mixed> $jobs[, mixed $data = '' ][, string $queue = null ][, string $connection = null ]) : mixed
Parameters
- $jobs : array<string|int, mixed>
- $data : mixed = ''
- $queue : string = null
- $connection : string = null
Return values
mixed —connection()
Get a connection instance from the global manager.
public
static connection([string $connection = null ]) : Queue
Parameters
- $connection : string = null
Return values
Queue —getConnection()
Get a registered connection instance.
public
getConnection([string $name = null ]) : Queue
Parameters
- $name : string = null
Return values
Queue —getContainer()
Get the IoC container instance.
public
getContainer() : Container
Return values
Container —getQueueManager()
Get the queue manager instance.
public
getQueueManager() : QueueManager
Return values
QueueManager —later()
Push a new job onto the queue after a delay.
public
static later(DateTimeInterface|DateInterval|int $delay, string $job[, mixed $data = '' ][, string $queue = null ][, string $connection = null ]) : mixed
Parameters
- $delay : DateTimeInterface|DateInterval|int
- $job : string
- $data : mixed = ''
- $queue : string = null
- $connection : string = null
Return values
mixed —push()
Push a new job onto the queue.
public
static push(string $job[, mixed $data = '' ][, string $queue = null ][, string $connection = null ]) : mixed
Parameters
- $job : string
- $data : mixed = ''
- $queue : string = null
- $connection : string = null
Return values
mixed —setAsGlobal()
Make this capsule instance available globally.
public
setAsGlobal() : void
Return values
void —setContainer()
Set the IoC container instance.
public
setContainer(Container $container) : void
Parameters
- $container : Container
Return values
void —registerConnectors()
Register the default connectors that the component ships with.
protected
registerConnectors() : void
Return values
void —setupContainer()
Setup the IoC container instance.
protected
setupContainer(Container $container) : void
Parameters
- $container : Container
Return values
void —setupDefaultConfiguration()
Setup the default queue configuration options.
protected
setupDefaultConfiguration() : void
Return values
void —setupManager()
Build the queue manager instance.
protected
setupManager() : void