1. class
  2. Illuminate
  3. \
  4. Broadcasting
  5. \
  6. UniqueBroadcastEvent

UniqueBroadcastEvent

class UniqueBroadcastEvent extends BroadcastEvent implements ShouldBeUnique (View source)

Traits

Queueable

Properties

string|null $connection

The name of the connection the job should be sent to.

 from  Queueable
string|null $queue

The name of the queue the job should be sent to.

 from  Queueable
DateTimeInterface|DateInterval|array|int|null $delay

The number of seconds before the job should be made available.

 from  Queueable
bool|null $afterCommit

Indicates whether the job should be dispatched after all database transactions have committed.

 from  Queueable
array $middleware

The middleware the job should be dispatched through.

 from  Queueable
array $chained

The jobs that should run if this job is successful.

 from  Queueable
string|null $chainConnection

The name of the connection the chain should be sent to.

 from  Queueable
string|null $chainQueue

The name of the queue the chain should be sent to.

 from  Queueable
array|null $chainCatchCallbacks

The callbacks to be executed on chain failure.

 from  Queueable
mixed $event

The event instance.

 from  BroadcastEvent
int $tries

The number of times the job may be attempted.

 from  BroadcastEvent
int $timeout

The number of seconds the job can run before timing out.

 from  BroadcastEvent
int $backoff

The number of seconds to wait before retrying the job when encountering an uncaught exception.

 from  BroadcastEvent
int $maxExceptions

The maximum number of unhandled exceptions to allow before failing.

 from  BroadcastEvent
mixed $uniqueId

The unique lock identifier.
int $uniqueFor

The number of seconds the unique lock should be maintained.

Methods

$this
onConnection(UnitEnum|string|null $connection)

Set the desired connection for the job.

from  Queueable
$this
onQueue(UnitEnum|string|null $queue)

Set the desired queue for the job.

from  Queueable
$this
allOnConnection(UnitEnum|string|null $connection)

Set the desired connection for the chain.

from  Queueable
$this
allOnQueue(UnitEnum|string|null $queue)

Set the desired queue for the chain.

from  Queueable
$this
delay(DateTimeInterface|DateInterval|array|int|null $delay)

Set the desired delay in seconds for the job.

from  Queueable
$this
withoutDelay()

Set the delay for the job to zero seconds.

from  Queueable
$this
afterCommit()

Indicate that the job should be dispatched after all database transactions have committed.

from  Queueable
$this
beforeCommit()

Indicate that the job should not wait until database transactions have been committed before dispatching.

from  Queueable
$this
through(array|object $middleware)

Specify the middleware the job should be dispatched through.

from  Queueable
$this
chain(array $chain)

Set the jobs that should run if this job is successful.

from  Queueable
$this
prependToChain(mixed $job)

Prepend a job to the current chain so that it is run after the currently running job.

from  Queueable
$this
appendToChain(mixed $job)

Append a job to the end of the current chain.

from  Queueable
string
serializeJob(mixed $job)

Serialize a job for queuing.

from  Queueable
void
dispatchNextJobInChain()

Dispatch the next job on the chain.

from  Queueable
void
invokeChainCatchCallbacks(Throwable $e)

Invoke all of the chain's failed job callbacks.

from  Queueable
void
assertHasChain(array $expectedChain)

Assert that the job has the given chain of jobs attached to it.

from  Queueable
void
assertDoesntHaveChain()

Assert that the job has no remaining chained jobs.

from  Queueable
__construct(mixed $event)

Create a new event instance.

void
handle(Factory $manager)

Handle the queued job.

from  BroadcastEvent
array
getPayloadFromEvent(mixed $event)

Get the payload for the given event.

from  BroadcastEvent
mixed
formatProperty(mixed $value)

Format the given value for a property.

from  BroadcastEvent
array
getConnectionChannels(array $channels, string $connection)

Get the channels for the given connection.

from  BroadcastEvent
array
getConnectionPayload(array $payload, string $connection)

Get the payload for the given connection.

from  BroadcastEvent
array
middleware()

Get the middleware for the underlying event.

from  BroadcastEvent
void
failed(Throwable|null $e = null)

Handle a job failure.

from  BroadcastEvent
string
displayName()

Get the display name for the queued job.

from  BroadcastEvent
void
__clone()

Prepare the instance for cloning.

from  BroadcastEvent
Repository
uniqueVia()

Resolve the cache implementation that should manage the event's uniqueness.

Details

in Queueable at line 85
$this onConnection(UnitEnum|string|null $connection)

Set the desired connection for the job.

Parameters

UnitEnum|string|null $connection

Return Value

$this

in Queueable at line 98
$this onQueue(UnitEnum|string|null $queue)

Set the desired queue for the job.

Parameters

UnitEnum|string|null $queue

Return Value

$this

in Queueable at line 111
$this allOnConnection(UnitEnum|string|null $connection)

Set the desired connection for the chain.

Parameters

UnitEnum|string|null $connection

Return Value

$this

in Queueable at line 127
$this allOnQueue(UnitEnum|string|null $queue)

Set the desired queue for the chain.

Parameters

UnitEnum|string|null $queue

Return Value

$this

in Queueable at line 143
$this delay(DateTimeInterface|DateInterval|array|int|null $delay)

Set the desired delay in seconds for the job.

Parameters

DateTimeInterface|DateInterval|array|int|null $delay

Return Value

$this

in Queueable at line 155
$this withoutDelay()

Set the delay for the job to zero seconds.

Return Value

$this

in Queueable at line 167
$this afterCommit()

Indicate that the job should be dispatched after all database transactions have committed.

Return Value

$this

in Queueable at line 179
$this beforeCommit()

Indicate that the job should not wait until database transactions have been committed before dispatching.

Return Value

$this

in Queueable at line 192
$this through(array|object $middleware)

Specify the middleware the job should be dispatched through.

Parameters

array|object $middleware

Return Value

$this

in Queueable at line 205
$this chain(array $chain)

Set the jobs that should run if this job is successful.

Parameters

array $chain

Return Value

$this

in Queueable at line 222
$this prependToChain(mixed $job)

Prepend a job to the current chain so that it is run after the currently running job.

Parameters

mixed $job

Return Value

$this

in Queueable at line 237
$this appendToChain(mixed $job)

Append a job to the end of the current chain.

Parameters

mixed $job

Return Value

$this

in Queueable at line 254
protected string serializeJob(mixed $job)

Serialize a job for queuing.

Parameters

mixed $job

Return Value

string

Exceptions

RuntimeException

in Queueable at line 274
void dispatchNextJobInChain()

Dispatch the next job on the chain.

Return Value

void

in Queueable at line 296
void invokeChainCatchCallbacks(Throwable $e)

Invoke all of the chain's failed job callbacks.

Parameters

Throwable $e

Return Value

void

in Queueable at line 309
void assertHasChain(array $expectedChain)

Assert that the job has the given chain of jobs attached to it.

Parameters

array $expectedChain

Return Value

void

in Queueable at line 333
void assertDoesntHaveChain()

Assert that the job has no remaining chained jobs.

Return Value

void

at line 30
__construct(mixed $event)

Create a new event instance.

Parameters

mixed $event

in BroadcastEvent at line 74
void handle(Factory $manager)

Handle the queued job.

Parameters

Factory $manager

Return Value

void

in BroadcastEvent at line 107
protected array getPayloadFromEvent(mixed $event)

Get the payload for the given event.

Parameters

mixed $event

Return Value

array

in BroadcastEvent at line 131
protected mixed formatProperty(mixed $value)

Format the given value for a property.

Parameters

mixed $value

Return Value

mixed

in BroadcastEvent at line 147
protected array getConnectionChannels(array $channels, string $connection)

Get the channels for the given connection.

Parameters

array $channels
string $connection

Return Value

array

in BroadcastEvent at line 161
protected array getConnectionPayload(array $payload, string $connection)

Get the payload for the given connection.

Parameters

array $payload
string $connection

Return Value

array

in BroadcastEvent at line 179
array middleware()

Get the middleware for the underlying event.

Return Value

array

in BroadcastEvent at line 194
void failed(Throwable|null $e = null)

Handle a job failure.

Parameters

Throwable|null $e

Return Value

void

in BroadcastEvent at line 208
string displayName()

Get the display name for the queued job.

Return Value

string

in BroadcastEvent at line 218
void __clone()

Prepare the instance for cloning.

Return Value

void

at line 54
Repository uniqueVia()

Resolve the cache implementation that should manage the event's uniqueness.

Return Value

Repository