class Manager mixin QueueManager mixin Queue

Traits

Properties

static protected object|null $instance

The current globally used instance.

from  CapsuleManagerTrait
protected Container $container

The container instance.

from  CapsuleManagerTrait
protected QueueManager $manager

The queue manager instance.

Methods

void
setupContainer(Container $container)

Setup the IoC container instance.

void
setAsGlobal()

Make this capsule instance available globally.

getContainer()

Get the IoC container instance.

void
setContainer(Container $container)

Set the IoC container instance.

static void
flushState()

Flush all static state.

__construct(Container|null $container = null)

Create a new queue capsule manager.

void
setupDefaultConfiguration()

Setup the default queue configuration options.

void
setupManager()

Build the queue manager instance.

void
registerConnectors()

Register the default connectors that the component ships with.

static Queue
connection(string|null $connection = null)

Get a connection instance from the global manager.

static mixed
push(object|string $job, mixed $data = '', string|null $queue = null, string|null $connection = null)

Push a new job onto the queue.

static mixed
bulk(array $jobs, mixed $data = '', string|null $queue = null, string|null $connection = null)

Push an array of jobs onto the queue.

static mixed
later(DateInterval|DateTimeInterface|int $delay, object|string $job, mixed $data = '', string|null $queue = null, string|null $connection = null)

Push a new job onto the queue after (n) seconds.

getConnection(string|null $name = null)

Get a registered connection instance.

void
addConnection(array $config, string $name = 'default')

Register a connection with the manager.

getQueueManager()

Get the queue manager instance.

mixed
__call(string $method, array $parameters)

Pass dynamic instance methods to the manager.

static mixed
__callStatic(string $method, array $parameters)

Dynamically pass methods to the default connection.

Details

protected void setupContainer(Container $container)

Setup the IoC container instance.

Parameters

Container $container

Return Value

void

void setAsGlobal()

Make this capsule instance available globally.

Boot or tests only. Swaps the global Capsule instance used by static calls; request-time use races across coroutines.

Return Value

void

Container getContainer()

Get the IoC container instance.

Return Value

Container

void setContainer(Container $container)

Set the IoC container instance.

Boot or tests only. Swaps the Capsule container used by this standalone manager; request-time use races across coroutines.

Parameters

Container $container

Return Value

void

static void flushState()

Flush all static state.

Return Value

void

at line 31
__construct(Container|null $container = null)

Create a new queue capsule manager.

Parameters

Container|null $container

at line 45
protected void setupDefaultConfiguration()

Setup the default queue configuration options.

Return Value

void

at line 53
protected void setupManager()

Build the queue manager instance.

Return Value

void

at line 61
protected void registerConnectors()

Register the default connectors that the component ships with.

Return Value

void

at line 75
static Queue connection(string|null $connection = null)

Get a connection instance from the global manager.

Parameters

string|null $connection

Return Value

Queue

at line 83
static mixed push(object|string $job, mixed $data = '', string|null $queue = null, string|null $connection = null)

Push a new job onto the queue.

Parameters

object|string $job
mixed $data
string|null $queue
string|null $connection

Return Value

mixed

at line 91
static mixed bulk(array $jobs, mixed $data = '', string|null $queue = null, string|null $connection = null)

Push an array of jobs onto the queue.

Parameters

array $jobs
mixed $data
string|null $queue
string|null $connection

Return Value

mixed

at line 99
static mixed later(DateInterval|DateTimeInterface|int $delay, object|string $job, mixed $data = '', string|null $queue = null, string|null $connection = null)

Push a new job onto the queue after (n) seconds.

Parameters

DateInterval|DateTimeInterface|int $delay
object|string $job
mixed $data
string|null $queue
string|null $connection

Return Value

mixed

at line 107
Queue getConnection(string|null $name = null)

Get a registered connection instance.

Parameters

string|null $name

Return Value

Queue

at line 115
void addConnection(array $config, string $name = 'default')

Register a connection with the manager.

Parameters

array $config
string $name

Return Value

void

at line 123
QueueManager getQueueManager()

Get the queue manager instance.

Return Value

QueueManager

at line 131
mixed __call(string $method, array $parameters)

Pass dynamic instance methods to the manager.

Parameters

string $method
array $parameters

Return Value

mixed

at line 139
static mixed __callStatic(string $method, array $parameters)

Dynamically pass methods to the default connection.

Parameters

string $method
array $parameters

Return Value

mixed