final class QueueConfigDefinition extends AbstractConfigDefinition (View source)

Builds typed queue configuration entries for transport topology, handlers, and database lease policy.

Properties

protected mixed[] $data from  AbstractConfigDefinition

Methods

set(string $path, mixed $value)

Replaces one configuration value at a dot-separated path.

append(string $path, mixed $value)

Appends one configuration value at a dot-separated list path.

create()

Starts an empty queue definition that can be composed with framework or application defaults.

static string

Returns the registry key under which queue definitions are merged.

string
defaultTransport(string $transport)

Selects the transport used when dispatch does not name one explicitly.

transports(array $transports)

Replaces the enabled built-in transport list while preserving caller order.

databaseTable(string $table)

Selects the active database queue table without creating or migrating it.

failedTable(string $table)

Selects the terminal failed-job table without creating or migrating it.

databaseLeaseSeconds(int $seconds)

Configures how long one database delivery remains exclusively owned without renewal.

databaseMaxAttempts(int $attempts)

Configures how many database reservations may execute before crash recovery quarantines the job.

handler(string $messageClass, callable|string $handler)

Associates a message class with the handler resolved when that message is executed.

Details

toArray

No description

Return Value

array

fromArrayData

final static AbstractConfigDefinition fromArrayData(array $data)

No description

Parameters

array $data

Return Value

AbstractConfigDefinition

set

protected AbstractConfigDefinition set(string $path, mixed $value)

Replaces one configuration value at a dot-separated path.

Parameters

string $path
mixed $value

Return Value

AbstractConfigDefinition

append

protected AbstractConfigDefinition append(string $path, mixed $value)

Appends one configuration value at a dot-separated list path.

Parameters

string $path
mixed $value

Return Value

AbstractConfigDefinition

create

Starts an empty queue definition that can be composed with framework or application defaults.

Return Value

QueueConfigDefinition

moduleKey

static string moduleKey()

Returns the registry key under which queue definitions are merged.

Return Value

string

defaultTransport

QueueConfigDefinition defaultTransport(string $transport)

Selects the transport used when dispatch does not name one explicitly.

Parameters

string $transport

Return Value

QueueConfigDefinition

transports

QueueConfigDefinition transports(array $transports)

Replaces the enabled built-in transport list while preserving caller order.

Parameters

array $transports

Return Value

QueueConfigDefinition

databaseTable

QueueConfigDefinition databaseTable(string $table)

Selects the active database queue table without creating or migrating it.

Parameters

string $table

Return Value

QueueConfigDefinition

failedTable

QueueConfigDefinition failedTable(string $table)

Selects the terminal failed-job table without creating or migrating it.

Parameters

string $table

Return Value

QueueConfigDefinition

databaseLeaseSeconds

QueueConfigDefinition databaseLeaseSeconds(int $seconds)

Configures how long one database delivery remains exclusively owned without renewal.

Parameters

int $seconds

Return Value

QueueConfigDefinition

databaseMaxAttempts

QueueConfigDefinition databaseMaxAttempts(int $attempts)

Configures how many database reservations may execute before crash recovery quarantines the job.

Parameters

int $attempts

Return Value

QueueConfigDefinition

handler

QueueConfigDefinition handler(string $messageClass, callable|string $handler)

Associates a message class with the handler resolved when that message is executed.

Parameters

string $messageClass
callable|string $handler

Return Value

QueueConfigDefinition