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

BroadcastEvent

class BroadcastEvent implements ShouldQueue

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
DateTime|int|null $delay

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

 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
delay(DateTime|int|null $delay)

Set the desired delay for the job.

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.

Details

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

Set the desired connection for the job.

Parameters

string|null $connection

Return Value

$this

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

Set the desired queue for the job.

Parameters

string|null $queue

Return Value

$this

in Queueable at line 60
$this delay(DateTime|int|null $delay)

Set the desired delay for the job.

Parameters

DateTime|int|null $delay

Return Value

$this

at line 30
void __construct(mixed $event)

Create a new job handler instance.

Parameters

mixed $event

Return Value

void

at line 41
void handle(Broadcaster $broadcaster)

Handle the queued job.

Parameters

Broadcaster $broadcaster

Return Value

void

at line 58
protected array getPayloadFromEvent(mixed $event)

Get the payload for the given event.

Parameters

mixed $event

Return Value

array

at line 83
protected mixed formatProperty(mixed $value)

Format the given value for a property.

Parameters

mixed $value

Return Value

mixed

at line 97
string displayName()

Get the display name for the queued job.

Return Value

string