1. class
  2. Illuminate
  3. \
  4. Notifications
  5. \
  6. Events
  7. \
  8. BroadcastNotificationCreated

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
DateTimeInterface|DateInterval|array|int|null $delay

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

 from  Queueable
bool|null $afterCommit

Indicates whether the job should be dispatched after all database transactions have committed.

 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
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

Methods

$this
onConnection(UnitEnum|string|null $connection)

Set the desired connection for the job.

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

Set the desired queue for the job.

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

Set the desired connection for the chain.

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

Set the desired queue for the chain.

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

Set the desired delay in seconds for the job.

from  Queueable
$this
withoutDelay()

Set the delay for the job to zero seconds.

from  Queueable
$this
afterCommit()

Indicate that the job should be dispatched after all database transactions have committed.

from  Queueable
$this
beforeCommit()

Indicate that the job should not wait until database transactions have been committed before dispatching.

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
$this
prependToChain(mixed $job)

Prepend a job to the current chain so that it is run after the currently running job.

from  Queueable
$this
appendToChain(mixed $job)

Append a job to the end of the current chain.

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
void
assertHasChain(array $expectedChain)

Assert that the job has the given chain of jobs attached to it.

from  Queueable
void
assertDoesntHaveChain()

Assert that the job has no remaining chained jobs.

from  Queueable
mixed
getSerializedPropertyValue(mixed $value, bool $withRelations = true)

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
TModel>
getQueryForModelRestoration(TModel $model, array|int $ids)

Get the query for model restoration.

from  SerializesAndRestoresModelIdentifiers
array
__serialize()

Prepare the instance values for serialization.

from  SerializesModels
void
__unserialize(array $values)

Restore the model after serialization.

from  SerializesModels
mixed
getPropertyValue(ReflectionProperty $property)

Get the property value for the given property.

from  SerializesModels
__construct(mixed $notifiable, Notification $notification, array $data = [])

Create a new event instance.

Channel|Channel[]|string[]|string
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.

string
broadcastAs()

Get the event name of the notification being broadcast.

Details

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

Set the desired connection for the job.

Parameters

UnitEnum|string|null $connection

Return Value

$this

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

Set the desired queue for the job.

Parameters

UnitEnum|string|null $queue

Return Value

$this

in Queueable at line 111
$this allOnConnection(UnitEnum|string|null $connection)

Set the desired connection for the chain.

Parameters

UnitEnum|string|null $connection

Return Value

$this

in Queueable at line 127
$this allOnQueue(UnitEnum|string|null $queue)

Set the desired queue for the chain.

Parameters

UnitEnum|string|null $queue

Return Value

$this

in Queueable at line 143
$this delay(DateTimeInterface|DateInterval|array|int|null $delay)

Set the desired delay in seconds for the job.

Parameters

DateTimeInterface|DateInterval|array|int|null $delay

Return Value

$this

in Queueable at line 155
$this withoutDelay()

Set the delay for the job to zero seconds.

Return Value

$this

in Queueable at line 167
$this afterCommit()

Indicate that the job should be dispatched after all database transactions have committed.

Return Value

$this

in Queueable at line 179
$this beforeCommit()

Indicate that the job should not wait until database transactions have been committed before dispatching.

Return Value

$this

in Queueable at line 192
$this through(array|object $middleware)

Specify the middleware the job should be dispatched through.

Parameters

array|object $middleware

Return Value

$this

in Queueable at line 205
$this chain(array $chain)

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

Parameters

array $chain

Return Value

$this

in Queueable at line 222
$this prependToChain(mixed $job)

Prepend a job to the current chain so that it is run after the currently running job.

Parameters

mixed $job

Return Value

$this

in Queueable at line 237
$this appendToChain(mixed $job)

Append a job to the end of the current chain.

Parameters

mixed $job

Return Value

$this

in Queueable at line 254
protected string serializeJob(mixed $job)

Serialize a job for queuing.

Parameters

mixed $job

Return Value

string

Exceptions

RuntimeException

in Queueable at line 274
void dispatchNextJobInChain()

Dispatch the next job on the chain.

Return Value

void

in Queueable at line 296
void invokeChainCatchCallbacks(Throwable $e)

Invoke all of the chain's failed job callbacks.

Parameters

Throwable $e

Return Value

void

in Queueable at line 309
void assertHasChain(array $expectedChain)

Assert that the job has the given chain of jobs attached to it.

Parameters

array $expectedChain

Return Value

void

in Queueable at line 333
void assertDoesntHaveChain()

Assert that the job has no remaining chained jobs.

Return Value

void

in SerializesAndRestoresModelIdentifiers at line 22
protected mixed getSerializedPropertyValue(mixed $value, bool $withRelations = true)

Get the property value prepared for serialization.

Parameters

mixed $value
bool $withRelations

Return Value

mixed

in SerializesAndRestoresModelIdentifiers at line 55
protected mixed getRestoredPropertyValue(mixed $value)

Get the restored property value after deserialization.

Parameters

mixed $value

Return Value

mixed

in SerializesAndRestoresModelIdentifiers at line 72
protected Collection restoreCollection(ModelIdentifier $value)

Restore a queueable collection instance.

Parameters

ModelIdentifier $value

Return Value

Collection

in SerializesAndRestoresModelIdentifiers at line 106
Model restoreModel(ModelIdentifier $value)

Restore the model from the model identifier instance.

Parameters

ModelIdentifier $value

Return Value

Model

in SerializesAndRestoresModelIdentifiers at line 122
protected TModel> getQueryForModelRestoration(TModel $model, array|int $ids)

Get the query for model restoration.

Parameters

TModel $model
array|int $ids

Return Value

TModel>

in SerializesModels at line 18
array __serialize()

Prepare the instance values for serialization.

Return Value

array

in SerializesModels at line 69
void __unserialize(array $values)

Restore the model after serialization.

Parameters

array $values

Return Value

void

in SerializesModels at line 104
protected mixed getPropertyValue(ReflectionProperty $property)

Get the property value for the given property.

Parameters

ReflectionProperty $property

Return Value

mixed

at line 24
__construct(mixed $notifiable, Notification $notification, array $data = [])

Create a new event instance.

Parameters

mixed $notifiable

The notifiable entity who received the notification.
Notification $notification

The notification instance.
array $data

The notification data.

at line 36
Channel|Channel[]|string[]|string broadcastOn()

Get the channels the event should broadcast on.

Return Value

Channel|Channel[]|string[]|string

at line 63
protected array|string channelName()

Get the broadcast channel name for the event.

Return Value

array|string

at line 79
array broadcastWith()

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

Return Value

array

at line 96
string broadcastType()

Get the type of the notification being broadcast.

Return Value

string

at line 108
string broadcastAs()

Get the event name of the notification being broadcast.

Return Value

string