BroadcastNotificationCreated

class BroadcastNotificationCreated implements ShouldBroadcast (View source)

Traits

Queueable
SerializesModels
SerializesAndRestoresModelIdentifiers

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
array|null $chainCatchCallbacks The callbacks to be executed on chain failure. from Queueable
DateTimeInterface|DateInterval|int|null $delay The number of seconds before the job should be made available. 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
mixed $notifiable The notifiable entity who received the notification.
Notification $notification The notification instance.
array $data The notification data.

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 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
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
mixed getSerializedPropertyValue(mixed $value)

Get the property value prepared for serialization.

 from SerializesAndRestoresModelIdentifiers
mixed getRestoredPropertyValue(mixed $value)

Get the restored property value after deserialization.

 from SerializesAndRestoresModelIdentifiers
Collection restoreCollection(ModelIdentifier $value)

Restore a queueable collection instance.

 from SerializesAndRestoresModelIdentifiers
Model restoreModel(ModelIdentifier $value)

Restore the model from the model identifier instance.

 from SerializesAndRestoresModelIdentifiers
Builder getQueryForModelRestoration(Model $model, array|int $ids)

Get the query for model restoration.

 from SerializesAndRestoresModelIdentifiers
array __sleep()

Prepare the instance for serialization.

 from SerializesModels
void __wakeup()

Restore the model after serialization.

 from SerializesModels
array __serialize()

Prepare the instance values for serialization.

 from SerializesModels
array __unserialize(array $values)

Restore the model after serialization.

 from SerializesModels
mixed getPropertyValue(ReflectionProperty $property)

Get the property value for the given property.

 from SerializesModels
void __construct(mixed $notifiable, Notification $notification, array $data)

Create a new event instance.
Channel|Channel[] broadcastOn()

Get the channels the event should broadcast on.
array|string channelName()

Get the broadcast channel name for the event.
array broadcastWith()

Get the data that should be sent with the broadcasted event.
string broadcastType()

Get the type of the notification being broadcast.

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 through(array|object $middleware)

Specify the middleware the job should be dispatched through.

Parameters

array|object $middleware

Return Value

$this

$this chain(array $chain)

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

Parameters

array $chain

Return Value

$this

protected string serializeJob(mixed $job)

Serialize a job for queuing.

Parameters

mixed $job

Return Value

string

void dispatchNextJobInChain()

Dispatch the next job on the chain.

Return Value

void

void invokeChainCatchCallbacks(Throwable $e)

Invoke all of the chain's failed job callbacks.

Parameters

Throwable $e

Return Value

void

protected mixed getSerializedPropertyValue(mixed $value)

Get the property value prepared for serialization.

Parameters

mixed $value

Return Value

mixed

protected mixed getRestoredPropertyValue(mixed $value)

Get the restored property value after deserialization.

Parameters

mixed $value

Return Value

mixed

protected Collection restoreCollection(ModelIdentifier $value)

Restore a queueable collection instance.

Parameters

ModelIdentifier $value

Return Value

Collection

Model restoreModel(ModelIdentifier $value)

Restore the model from the model identifier instance.

Parameters

ModelIdentifier $value

Return Value

Model

protected Builder getQueryForModelRestoration(Model $model, array|int $ids)

Get the query for model restoration.

Parameters

Model $model
array|int $ids

Return Value

Builder

array __sleep()

Prepare the instance for serialization.

Return Value

array

void __wakeup()

Restore the model after serialization.

Return Value

void

array __serialize()

Prepare the instance values for serialization.

Return Value

array

array __unserialize(array $values)

Restore the model after serialization.

Parameters

array $values

Return Value

array

protected mixed getPropertyValue(ReflectionProperty $property)

Get the property value for the given property.

Parameters

ReflectionProperty $property

Return Value

mixed

void __construct(mixed $notifiable, Notification $notification, array $data)

Create a new event instance.

Parameters

mixed $notifiable
Notification $notification
array $data

Return Value

void

Channel|Channel[] broadcastOn()

Get the channels the event should broadcast on.

Return Value

Channel|Channel[]

protected array|string channelName()

Get the broadcast channel name for the event.

Return Value

array|string

array broadcastWith()

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

Return Value

array

string broadcastType()

Get the type of the notification being broadcast.

Return Value

string

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/8.x/Illuminate/Notifications/Events/BroadcastNotificationCreated.html