Spec-Zone.ru › Laravel 8

Отправка очереди уведомлений

класс SendQueuedNotifications реализует ShouldQueue (Просмотреть исходный код)

Трейты

InteractsWithQueue
Queueable
SerializesModels
SerializesAndRestoresModelIdentifiers

Свойства

Job $job

Экземпляр задачи очереди.

из InteractsWithQueue
string|null $connection

Имя подключения, к которому должна быть отправлена задача.

из Queueable
string|null $queue

Имя очереди, к которой должна быть отправлена задача.

из Queueable
string|null $chainConnection

Имя подключения, к которому должна быть отправлена цепочка.

из Queueable
string|null $chainQueue

Имя очереди, к которой должна быть отправлена цепочка.

из Queueable
array|null $chainCatchCallbacks

Обработчики, которые будут выполнены при ошибке цепочки.

из Queueable
DateTimeInterface|DateInterval|int|null $delay

Количество секунд до того, как задача станет доступной.

из Queueable
bool|null $afterCommit

Указывает, должна ли задача быть отправлена после завершения всех транзакций базы данных.

из Queueable
array $middleware

Средства, через которые должна быть отправлена задача.

из Queueable
array $chained

Задачи, которые должны быть выполнены, если эта задача успешно завершена.

из Queueable
Collection $notifiables

Сущности, которые должны получить уведомление.

Notification $notification

Уведомление, которое должно быть отправлено.

array $channels

Все каналы для отправки уведомления.

int $tries

Количество попыток выполнения задачи.

int $timeout

Количество секунд, которое задача может работать, прежде чем истечет время ожидания.

bool $shouldBeEncrypted

Указывает, должна ли задача быть зашифрована.

Методы

int attempts()

Получить количество попыток выполнения задачи.

из InteractsWithQueue
void delete()

Удалить задачу из очереди.

из InteractsWithQueue
void fail(Throwable|null $exception = null)

Отметить задачу как проваленную из очереди.

из InteractsWithQueue
void release(int $delay = 0)

Вернуть задачу обратно в очередь.

из InteractsWithQueue
$this setJob(Job $job)

Установить базовый экземпляр задачи очереди.

из InteractsWithQueue
$this onConnection(string|null $connection)

Установить желаемое соединение для задачи.

из Queueable
$this onQueue(string|null $queue)

Установить желаемую очередь для задачи.

из Queueable
$this allOnConnection(string|null $connection)

Установить желаемое соединение для цепочки.

из Queueable
$this allOnQueue(string|null $queue)

Установить желаемую очередь для цепочки.

из Queueable
$this delay(DateTimeInterface|DateInterval|int|null $delay)

Установить желаемую задержку для задачи.

из Queueable
$this afterCommit()

Указать, что задача должна быть отправлена после завершения всех транзакций базы данных.

из Queueable
$this beforeCommit()

Указать, что задача не должна ждать завершения транзакций базы данных перед отправкой.

из Queueable
$this through(array|object $middleware)

Указать, через какой мидлварь должна быть отправлена задача.

из Queueable
$this chain(array $chain)

Указать задачи, которые должны выполняться, если эта задача выполнена успешно.

из Queueable
string serializeJob(mixed $job)

Сериализовать задачу для очереди.

из Queueable
void dispatchNextJobInChain()

Отправить следующую задачу в цепочке.

из Queueable
void invokeChainCatchCallbacks(Throwable $e)

Вызвать все обработчики ошибок задачи в цепочке.

из Queueable
mixed getSerializedPropertyValue(mixed $value)

Получить значение свойства, подготовленное для сериализации.

из SerializesAndRestoresModelIdentifiers
mixed getRestoredPropertyValue(mixed $value)

Получить восстановленное значение свойства после десериализации.

из SerializesAndRestoresModelIdentifiers
Collection restoreCollection(ModelIdentifier $value)

Восстановить экземпляр коллекции queueable.

из SerializesAndRestoresModelIdentifiers
Model restoreModel(ModelIdentifier $value)

Восстановить модель из экземпляра идентификатора модели.

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

Получить запрос для восстановления модели.

из SerializesAndRestoresModelIdentifiers
array __sleep()

Подготовить экземпляр к сериализации.

из SerializesModels
void __wakeup()

Восстановить модель после сериализации.

из SerializesModels
array __serialize()

Подготовить значения экземпляра к сериализации.

из SerializesModels
void __unserialize(array $values)

Восстановить модель после сериализации.

из SerializesModels
mixed getPropertyValue(ReflectionProperty $property)

Получить значение свойства для заданного свойства.

из SerializesModels
void __construct(Notifiable|Collection $notifiables, Notification $notification, array $channels = null)

Создать новый экземпляр задачи.

Коллекция wrapNotifiables(Notifiable|Коллекция $notifiables)

Оборачивает уведомляемый(ые) объект(ы) в коллекцию.

void handle(ChannelManager $manager)

Отправляет уведомления.

строка displayName()

Получить имя для отображения запланированной задачи.

void failed(Throwable $e)

Вызывает метод failed для экземпляра уведомления.

смешанный тип backoff()

Получить количество секунд, ожидаемых перед получением доступного уведомления.

смешанный тип retryUntil()

Получить срок действия уведомления.

void __clone()

Подготавливает экземпляр для клонирования.

Подробности

целое число attempts()

Получить количество попыток выполнения задачи.

Значение возврата

целое число

void delete()

Удалить задачу из очереди.

Значение возврата

void

void fail(Throwable|null $exception = null)

Приостановить задачу в очереди.

Параметры

Throwable|null $exception

Значение возврата

void

void release(int $delay = 0)

Вернуть задачу обратно в очередь.

Параметры

int $delay

Значение возврата

void

$this setJob(Job $job)

Установить базовый экземпляр задачи очереди.

Параметры

Job $job

Значение возврата

$this

$this onConnection(string|null $connection)

Установить требуемое подключение для задачи.

Параметры

string|null $connection

Значение возврата

$this

$this onQueue(string|null $queue)

Установить желаемую очередь для задачи.

Параметры

string|null $queue

Значение возврата

$this

$this allOnConnection(string|null $connection)

Установить желаемое подключение для цепочки.

Параметры

string|null $connection

Значение возврата

$this

$this allOnQueue(string|null $queue)

Установить желаемую очередь для цепочки.

Параметры

string|null $queue

Значение возврата

$this

$this delay(DateTimeInterface|DateInterval|int|null $delay)

Установить желаемую задержку для задачи.

Параметры

DateTimeInterface|DateInterval|int|null $delay

Значение возврата

$this

$this afterCommit()

Указывает, что задача должна быть отправлена после подтверждения всех баз данных.

Значение возврата

$this

$this beforeCommit()

Указывает, что задача не должна ожидать подтверждения баз данных перед отправкой.

Значение возврата

$this

$this through(array|object $middleware)

Укажите обработку задач middleware.

Параметры

array|object $middleware

Значение возврата

$this

$this chain(array $chain)

Установите задачи, которые должны выполняться, если эта задача выполняется успешно.

Параметры

array $chain

Значение возврата

$this

protected строка serializeJob(mixed $job)

Сериализуйте задачу для очереди.

Параметры

смешанный тип $job

Значение возврата

строка

Исключения

RuntimeException

void dispatchNextJobInChain()

Отправить следующую задачу в цепочке.

Значение возврата

void

void invokeChainCatchCallbacks(Throwable $e)

Вызвать все обработчики задач цепочки, которые завершились ошибкой.

Параметры

Throwable $e

Значение возврата

void

protected смешанный тип getSerializedPropertyValue(mixed $value)

Получить значение свойства, подготовленное для сериализации.

Параметры

смешанный тип $value

Значение возврата

смешанный тип

protected mixed getRestoredPropertyValue(mixed $value)

Получить значение восстановленного свойства после десериализации.

Parameters

mixed $value

Return Value

mixed

protected Collection restoreCollection(ModelIdentifier $value)

Восстановить экземпляр очереди коллекции.

Parameters

ModelIdentifier $value

Return Value

Collection

Model restoreModel(ModelIdentifier $value)

Восстановить модель из экземпляра идентификатора модели.

Parameters

ModelIdentifier $value

Return Value

Model

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

Получить запрос для восстановления модели.

Parameters

Model $model
array|int $ids

Return Value

Builder

array __sleep()

Подготовить экземпляр к сериализации.

Return Value

array

void __wakeup()

Восстановить модель после сериализации.

Return Value

void

array __serialize()

Подготовить значения экземпляра для сериализации.

Return Value

array

void __unserialize(array $values)

Восстановить модель после сериализации.

Parameters

array $values

Return Value

void

protected mixed getPropertyValue(ReflectionProperty $property)

Получить значение свойства для данного свойства.

Parameters

ReflectionProperty $property

Return Value

mixed

void __construct(Notifiable|Collection $notifiables, Notification $notification, array $channels = null)

Создать новый экземпляр задания.

Parameters

Notifiable|Collection $notifiables
Notification $notification
array $channels

Return Value

void

protected Collection wrapNotifiables(Notifiable|Collection $notifiables)

Оборачивание оповещаемого(ых) в коллекцию.

Parameters

Notifiable|Collection $notifiables

Return Value

Collection

void handle(ChannelManager $manager)

Отправить уведомления.

Parameters

ChannelManager $manager

Return Value

void

string displayName()

Получить имя для отображения запланированной задачи.

Return Value

string

void failed(Throwable $e)

Вызвать метод failed для экземпляра уведомления.

Parameters

Throwable $e

Return Value

void

mixed backoff()

Получить количество секунд, ожидающих прежде, чем отпущенное уведомление будет доступно.

Return Value

mixed

mixed retryUntil()

Получить срок действия уведомления.

Return Value

mixed

void __clone()

Подготовить экземпляр для клонирования.

Return Value

void

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API