Documentation

BroadcastEvent
in package

Application

implements ShouldQueue Uses Queueable

Interfaces, Classes and Traits

ShouldQueue

$chainConnection : string|null: The name of the connection the chain should be sent to.
$chained : array<string|int, mixed>: The jobs that should run if this job is successful.
$chainQueue : string|null: The name of the queue the chain should be sent to.
$connection : string|null: The name of the connection the job should be sent to.
$delay : DateTimeInterface|DateInterval|int|null: The number of seconds before the job should be made available.
$event : mixed: The event instance.
$queue : string|null: The name of the queue the job should be sent to.
__clone() : void: Prepare the instance for cloning.
__construct() : void: Create a new job handler instance.
allOnConnection() : $this: Set the desired connection for the chain.
allOnQueue() : $this: Set the desired queue for the chain.
chain() : $this: Set the jobs that should run if this job is successful.
delay() : $this: Set the desired delay for the job.
dispatchNextJobInChain() : void: Dispatch the next job on the chain.
displayName() : string: Get the display name for the queued job.
handle() : void: Handle the queued job.
onConnection() : $this: Set the desired connection for the job.
onQueue() : $this: Set the desired queue for the job.
formatProperty() : mixed: Format the given value for a property.
getPayloadFromEvent() : array<string|int, mixed>: Get the payload for the given event.

$chainConnection

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


    public
        string|null
    $chainConnection

$chained

The jobs that should run if this job is successful.


    public
        array<string|int, mixed>
    $chained
     = []

$chainQueue

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


    public
        string|null
    $chainQueue

$connection

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


    public
        string|null
    $connection

$delay

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


    public
        DateTimeInterface|DateInterval|int|null
    $delay

$event

The event instance.


    public
        mixed
    $event

$queue

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


    public
        string|null
    $queue

__clone()

Prepare the instance for cloning.


    public
                __clone() : void

Return values

void —

__construct()

Create a new job handler instance.


    public
                __construct(mixed $event) : void

Parameters

$event : mixed

Return values

void —

allOnConnection()

Set the desired connection for the chain.


    public
                allOnConnection(string|null $connection) : $this

Parameters

$connection : string|null

Return values

$this —

allOnQueue()

Set the desired queue for the chain.


    public
                allOnQueue(string|null $queue) : $this

Parameters

$queue : string|null

Return values

$this —

chain()

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


    public
                chain(array<string|int, mixed> $chain) : $this

Parameters

$chain : array<string|int, mixed>

Return values

$this —

delay()

Set the desired delay for the job.


    public
                delay(DateTimeInterface|DateInterval|int|null $delay) : $this

Parameters

$delay : DateTimeInterface|DateInterval|int|null

Return values

$this —

dispatchNextJobInChain()

Dispatch the next job on the chain.


    public
                dispatchNextJobInChain() : void

Return values

void —

displayName()

Get the display name for the queued job.


    public
                displayName() : string

Return values

string —

handle()

Handle the queued job.


    public
                handle(Broadcaster $broadcaster) : void

Parameters

$broadcaster : Broadcaster

Return values

void —

onConnection()

Set the desired connection for the job.


    public
                onConnection(string|null $connection) : $this

Parameters

$connection : string|null

Return values

$this —

onQueue()

Set the desired queue for the job.


    public
                onQueue(string|null $queue) : $this

Parameters

$queue : string|null

Return values

$this —

formatProperty()

Format the given value for a property.


    protected
                formatProperty(mixed $value) : mixed

Parameters

$value : mixed

Return values

mixed —

getPayloadFromEvent()

Get the payload for the given event.


    protected
                getPayloadFromEvent(mixed $event) : array<string|int, mixed>

Parameters

$event : mixed

Return values

array<string|int, mixed> —