BroadcastEvent

class BroadcastEvent implements ShouldQueue (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
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
DateTimeInterface|DateInterval|int|null $delay The number of seconds before the job should be made available. from Queueable
array $chained The jobs that should run if this job is successful. from Queueable
mixed $event The event instance.

Methods

$this onConnection(string|null $connection)

Set the desired connection for the job.

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

Set the desired queue for the job.

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

Set the desired connection for the chain.

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

Set the desired queue for the chain.

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

Set the desired delay for the job.

 from Queueable
$this chain(array $chain)

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

 from Queueable
void dispatchNextJobInChain()

Dispatch the next job on the chain.

 from Queueable
void __construct(mixed $event)

Create a new job handler instance.
void handle(Broadcaster $broadcaster)

Handle the queued job.
array getPayloadFromEvent(mixed $event)

Get the payload for the given event.
mixed formatProperty(mixed $value)

Format the given value for a property.
string displayName()

Get the display name for the queued job.
void __clone()

Prepare the instance for cloning.

Details

$this onConnection(string|null $connection)

Set the desired connection for the job.

Parameters

string|null $connection

Return Value

$this

$this onQueue(string|null $queue)

Set the desired queue for the job.

Parameters

string|null $queue

Return Value

$this

$this allOnConnection(string|null $connection)

Set the desired connection for the chain.

Parameters

string|null $connection

Return Value

$this

$this allOnQueue(string|null $queue)

Set the desired queue for the chain.

Parameters

string|null $queue

Return Value

$this

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

Set the desired delay for the job.

Parameters

DateTimeInterface|DateInterval|int|null $delay

Return Value

$this

$this chain(array $chain)

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

Parameters

array $chain

Return Value

$this

void dispatchNextJobInChain()

Dispatch the next job on the chain.

Return Value

void

void __construct(mixed $event)

Create a new job handler instance.

Parameters

mixed $event

Return Value

void

void handle(Broadcaster $broadcaster)

Handle the queued job.

Parameters

Broadcaster $broadcaster

Return Value

void

protected array getPayloadFromEvent(mixed $event)

Get the payload for the given event.

Parameters

mixed $event

Return Value

array

protected mixed formatProperty(mixed $value)

Format the given value for a property.

Parameters

mixed $value

Return Value

mixed

string displayName()

Get the display name for the queued job.

Return Value

string

void __clone()

Prepare the instance for cloning.

Return Value

void

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.7/Illuminate/Broadcasting/BroadcastEvent.html