Documentation

BroadcastNotificationCreated
in package

Application

implements ShouldBroadcast Uses Queueable, SerializesModels

Interfaces, Classes and Traits

ShouldBroadcast

$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.
$data : array<string|int, mixed>: The notification data.
$delay : DateTimeInterface|DateInterval|int|null: The number of seconds before the job should be made available.
$notifiable : mixed: The notifiable entity who received the notification.
$notification : Notification: The notification instance.
$queue : string|null: The name of the queue the job should be sent to.
__construct() : void: Create a new event instance.
__sleep() : array<string|int, mixed>: Prepare the instance for serialization.
__wakeup() : void: Restore the model after serialization.
allOnConnection() : $this: Set the desired connection for the chain.
allOnQueue() : $this: Set the desired queue for the chain.
broadcastOn() : array<string|int, mixed>: Get the channels the event should broadcast on.
broadcastWith() : array<string|int, mixed>: Get the data that should be sent with the broadcasted event.
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.
onConnection() : $this: Set the desired connection for the job.
onQueue() : $this: Set the desired queue for the job.
channelName() : string: Get the broadcast channel name for the event.
getPropertyValue() : mixed: Get the property value for the given property.

$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

$data

The notification data.


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

$delay

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


    public
        DateTimeInterface|DateInterval|int|null
    $delay

$notifiable

The notifiable entity who received the notification.


    public
        mixed
    $notifiable

$notification

The notification instance.


    public
        Notification
    $notification

$queue

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


    public
        string|null
    $queue

__construct()

Create a new event instance.


    public
                __construct(mixed $notifiable, Notification $notification, array<string|int, mixed> $data) : void

Parameters

$notifiable : mixed
$notification : Notification
$data : array<string|int, mixed>

Return values

void —

__sleep()

Prepare the instance for serialization.


    public
                __sleep() : array<string|int, mixed>

Return values

array<string|int, mixed> —

__wakeup()

Restore the model after serialization.


    public
                __wakeup() : void

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 —

broadcastOn()

Get the channels the event should broadcast on.


    public
                broadcastOn() : array<string|int, mixed>

Return values

array<string|int, mixed> —

broadcastWith()

Get the data that should be sent with the broadcasted event.


    public
                broadcastWith() : array<string|int, mixed>

Return values

array<string|int, mixed> —

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 —

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 —

channelName()

Get the broadcast channel name for the event.


    protected
                channelName() : string

Return values

string —

getPropertyValue()

Get the property value for the given property.


    protected
                getPropertyValue(ReflectionProperty $property) : mixed

Parameters

$property : ReflectionProperty

Return values

mixed —