BroadcastNotificationCreated
class BroadcastNotificationCreated implements ShouldBroadcast (View source)
Traits
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 |
| mixed | $notifiable | The notifiable entity who received the notification. |
|
| Notification | $notification | The notification instance. |
|
| array | $data | The notification data. |
Methods
Set the desired connection for the job.
Set the desired connection for the chain.
Set the desired delay in seconds for the job.
Indicate that the job should be dispatched after all database transactions have committed.
Indicate that the job should not wait until database transactions have been committed before dispatching.
Specify the middleware the job should be dispatched through.
Prepend a job to the current chain so that it is run after the currently running job.
Assert that the job has the given chain of jobs attached to it.
Get the property value prepared for serialization.
Get the restored property value after deserialization.
Get the query for model restoration.
Create a new event instance.
Get the channels the event should broadcast on.
Get the broadcast channel name for the event.
Get the data that should be sent with the broadcasted event.
Get the type of the notification being broadcast.
Get the event name of the notification being broadcast.
Details
$this
onConnection(BackedEnum|string|null $connection)
Set the desired connection for the job.
$this
onQueue(BackedEnum|string|null $queue)
Set the desired queue for the job.
$this
allOnConnection(BackedEnum|string|null $connection)
Set the desired connection for the chain.
$this
allOnQueue(BackedEnum|string|null $queue)
Set the desired queue for the chain.
$this
delay(DateTimeInterface|DateInterval|array|int|null $delay)
Set the desired delay in seconds for the job.
$this
withoutDelay()
Set the delay for the job to zero seconds.
$this
afterCommit()
Indicate that the job should be dispatched after all database transactions have committed.
$this
beforeCommit()
Indicate that the job should not wait until database transactions have been committed before dispatching.
$this
through(array|object $middleware)
Specify the middleware the job should be dispatched through.
$this
chain(array $chain)
Set the jobs that should run if this job is successful.
$this
prependToChain(mixed $job)
Prepend a job to the current chain so that it is run after the currently running job.
$this
appendToChain(mixed $job)
Append a job to the end of the current chain.
protected string
serializeJob(mixed $job)
Serialize a job for queuing.
void
dispatchNextJobInChain()
Dispatch the next job on the chain.
void
invokeChainCatchCallbacks(Throwable $e)
Invoke all of the chain's failed job callbacks.
void
assertHasChain(array $expectedChain)
Assert that the job has the given chain of jobs attached to it.
void
assertDoesntHaveChain()
Assert that the job has no remaining chained jobs.
protected mixed
getSerializedPropertyValue(mixed $value, bool $withRelations = true)
Get the property value prepared for serialization.
protected mixed
getRestoredPropertyValue(mixed $value)
Get the restored property value after deserialization.
protected Collection
restoreCollection(ModelIdentifier $value)
Restore a queueable collection instance.
Model
restoreModel(ModelIdentifier $value)
Restore the model from the model identifier instance.
protected TModel>
getQueryForModelRestoration(TModel $model, array|int $ids)
Get the query for model restoration.
array
__serialize()
Prepare the instance values for serialization.
void
__unserialize(array $values)
Restore the model after serialization.
protected mixed
getPropertyValue(ReflectionProperty $property)
Get the property value for the given property.
void
__construct(mixed $notifiable, Notification $notification, array $data)
Create a new event instance.
protected 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.