W3cubDocs

/Laravel 11

Manager

class Manager mixin QueueManager mixin Queue (View source)

Traits

CapsuleManagerTrait

Properties

static protected object $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.

 from CapsuleManagerTrait
void setAsGlobal()

Make this capsule instance available globally.

 from CapsuleManagerTrait
Container getContainer()

Get the IoC container instance.

 from CapsuleManagerTrait
void setContainer(Container $container)

Set the IoC container instance.

 from CapsuleManagerTrait
void __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(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 a new an array of jobs onto the queue.
static mixed later(DateTimeInterface|DateInterval|int $delay, string $job, mixed $data = '', string|null $queue = null, string|null $connection = null)

Push a new job onto the queue after (n) seconds.
Queue getConnection(string|null $name = null)

Get a registered connection instance.
void addConnection(array $config, string $name = 'default')

Register a connection with the manager.
QueueManager 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.

Return Value

void

Container getContainer()

Get the IoC container instance.

Return Value

Container

void setContainer(Container $container)

Set the IoC container instance.

Parameters

Container $container

Return Value

void

void __construct(Container|null $container = null)

Create a new queue capsule manager.

Parameters

Container|null $container

Return Value

void

protected void setupDefaultConfiguration()

Setup the default queue configuration options.

Return Value

void

protected void setupManager()

Build the queue manager instance.

Return Value

void

protected void registerConnectors()

Register the default connectors that the component ships with.

Return Value

void

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

Get a connection instance from the global manager.

Parameters

string|null $connection

Return Value

Queue

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

Push a new job onto the queue.

Parameters

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

Return Value

mixed

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

Push a new an array of jobs onto the queue.

Parameters

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

Return Value

mixed

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

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

Parameters

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

Return Value

mixed

Queue getConnection(string|null $name = null)

Get a registered connection instance.

Parameters

string|null $name

Return Value

Queue

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

Register a connection with the manager.

Parameters

array $config
string $name

Return Value

void

QueueManager getQueueManager()

Get the queue manager instance.

Return Value

QueueManager

mixed __call(string $method, array $parameters)

Pass dynamic instance methods to the manager.

Parameters

string $method
array $parameters

Return Value

mixed

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

Dynamically pass methods to the default connection.

Parameters

string $method
array $parameters

Return Value

mixed

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/11.x/Illuminate/Queue/Capsule/Manager.html