SendQueuedNotifications
class SendQueuedNotifications implements ShouldQueue (View source)
Traits
InteractsWithQueue | |
Queueable | |
SerializesModels | |
SerializesAndRestoresModelIdentifiers |
Properties
Job|null | $job | The underlying queue job instance. | from InteractsWithQueue |
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|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 |
Collection | $notifiables | The notifiable entities that should receive the notification. | |
Notification | $notification | The notification to be sent. | |
array | $channels | All of the channels to send the notification to. | |
int | $tries | The number of times the job may be attempted. | |
int | $timeout | The number of seconds the job can run before timing out. | |
int | $maxExceptions | The maximum number of unhandled exceptions to allow before failing. | |
bool | $shouldBeEncrypted | Indicates if the job should be encrypted. |
Methods
int | attempts()
Get the number of times the job has been attempted. | from InteractsWithQueue |
void | delete()
Delete the job from the queue. | from InteractsWithQueue |
void | fail(Throwable|string|null $exception = null)
Fail the job from the queue. | from InteractsWithQueue |
void | release(int $delay = 0)
Release the job back into the queue after (n) seconds. | from InteractsWithQueue |
$this | setJob(Job $job)
Set the base queue job instance. | from InteractsWithQueue |
$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|array|int|null $delay)
Set the desired delay in seconds for the job. | 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 |
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 | __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 |
void | __construct(Notifiable|Collection $notifiables, Notification $notification, array $channels = null)
Create a new job instance. | |
Collection | wrapNotifiables(Notifiable|Collection $notifiables)
Wrap the notifiable(s) in a collection. | |
void | handle(ChannelManager $manager)
Send the notifications. | |
string | displayName()
Get the display name for the queued job. | |
void | failed(Throwable $e)
Call the failed method on the notification instance. | |
mixed | backoff()
Get the number of seconds before a released notification will be available. | |
DateTime|null | retryUntil()
Determine the time at which the job should timeout. | |
void | __clone()
Prepare the instance for cloning. |
Details
int attempts()
Get the number of times the job has been attempted.
void delete()
Delete the job from the queue.
void fail(Throwable|string|null $exception = null)
Fail the job from the queue.
void release(int $delay = 0)
Release the job back into the queue after (n) seconds.
$this setJob(Job $job)
Set the base queue job instance.
$this onConnection(string|null $connection)
Set the desired connection for the job.
$this onQueue(string|null $queue)
Set the desired queue for the job.
$this allOnConnection(string|null $connection)
Set the desired connection for the chain.
$this allOnQueue(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 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.
protected mixed getSerializedPropertyValue(mixed $value)
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 Builder getQueryForModelRestoration(Model $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(Notifiable|Collection $notifiables, Notification $notification, array $channels = null)
Create a new job instance.
protected Collection wrapNotifiables(Notifiable|Collection $notifiables)
Wrap the notifiable(s) in a collection.
void handle(ChannelManager $manager)
Send the notifications.
string displayName()
Get the display name for the queued job.
void failed(Throwable $e)
Call the failed method on the notification instance.
mixed backoff()
Get the number of seconds before a released notification will be available.
DateTime|null retryUntil()
Determine the time at which the job should timeout.
void __clone()
Prepare the instance for cloning.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/9.x/Illuminate/Notifications/SendQueuedNotifications.html