Spec-Zone.ru › Laravel 10

SendQueuedNotifications

класс SendQueuedNotifications реализует ShouldQueue (View source)

Трейты

InteractsWithQueue
Queueable
SerializesModels
InteractsWithTime
SerializesAndRestoresModelIdentifiers

Свойства

Job|null $job

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

из InteractsWithQueue
string|null $connection

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

из Queueable
string|null $queue

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

из Queueable
string|null $chainConnection

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

из Queueable
string|null $chainQueue

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

из Queueable
array|null $chainCatchCallbacks

Обработчики, которые должны быть выполнены при сбое цепочки.

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

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

из Queueable
bool|null $afterCommit

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

из Queueable
array $middleware

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

из Queueable
array $chained

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

из Queueable
Collection $notifiables

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

Notification $notification

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

array $channels

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

int $tries

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

int $timeout

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

int $maxExceptions

Максимальное количество необработанных исключений, разрешённых перед ошибкой.

bool $shouldBeEncrypted

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

Методы

int secondsUntil(DateTimeInterface|DateInterval|int $delay)

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

from InteractsWithTime
int availableAt(DateTimeInterface|DateInterval|int $delay = 0)

Получить временную метку UNIX для «доступно в».

from InteractsWithTime
DateTimeInterface|int parseDateInterval(DateTimeInterface|DateInterval|int $delay)

Если заданное значение — интервал, преобразовать его в экземпляр DateTime.

from InteractsWithTime
int currentTime()

Получить текущее системное время в формате временной метки UNIX.

from InteractsWithTime
int attempts()

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

from InteractsWithQueue
void delete()

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

from InteractsWithQueue
void fail(Throwable|string|null $exception = null)

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

from InteractsWithQueue
void release(DateTimeInterface|DateInterval|int $delay = 0)

Возвратить задачу в очередь после (n) секунд.

from InteractsWithQueue
$this setJob(Job $job)

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

from InteractsWithQueue
$this onConnection(string|null $connection)

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

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

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

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

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

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

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

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

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

from Queueable
$this afterCommit()

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

from Queueable
$this beforeCommit()

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

from Queueable
$this through(array|object $middleware)

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

from Queueable
$this chain(array $chain)

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

from Queueable
$this prependToChain(mixed $job)

Вставить задачу в начало текущей цепочки, чтобы она выполнялась после текущей задачи.

from Queueable
$this appendToChain(mixed $job)

Добавить задачу в конец текущей цепочки.

from Queueable
string serializeJob(mixed $job)

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

from Queueable
void dispatchNextJobInChain()

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

from Queueable
void invokeChainCatchCallbacks(Throwable $e)

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

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

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

from SerializesAndRestoresModelIdentifiers
mixed getRestoredPropertyValue(mixed $value)

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

from SerializesAndRestoresModelIdentifiers
Collection restoreCollection(ModelIdentifier $value)

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

from SerializesAndRestoresModelIdentifiers
Model restoreModel(ModelIdentifier $value)

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

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

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

из SerializesAndRestoresModelIdentifiers
массив __serialize()

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

из SerializesModels
void __unserialize(array $values)

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

из SerializesModels
смешанный getPropertyValue(ReflectionProperty $property)

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

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

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

Collection wrapNotifiables(Notifiable|Collection $notifiables)

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

void handle(ChannelManager $manager)

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

строка displayName()

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

void failed(Throwable $e)

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

смешанный backoff()

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

DateTime|null retryUntil()

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

void __clone()

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

Подробности

protected int secondsUntil(DateTimeInterface|DateInterval|int $delay)

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

Параметры

DateTimeInterface|DateInterval|int $delay

Возвращаемое значение

int

protected int availableAt(DateTimeInterface|DateInterval|int $delay = 0)

Получить отметку времени "доступно в" в формате UNIX timestamp.

Параметры

DateTimeInterface|DateInterval|int $delay

Возвращаемое значение

int

protected DateTimeInterface|int parseDateInterval(DateTimeInterface|DateInterval|int $delay)

Если заданное значение представляет собой интервал, преобразуйте его в экземпляр DateTime.

Параметры

DateTimeInterface|DateInterval|int $delay

Возвращаемое значение

DateTimeInterface|int

protected int currentTime()

Получить текущее системное время в формате UNIX timestamp.

Возвращаемое значение

int

int attempts()

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

Возвращаемое значение

int

void delete()

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

Возвращаемое значение

void

void fail(Throwable|string|null $exception = null)

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

Параметры

Throwable|string|null $exception

Возвращаемое значение

void

void release(DateTimeInterface|DateInterval|int $delay = 0)

Возвратить задачу обратно в очередь через (n) секунд.

Параметры

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

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

Параметры

DateTimeInterface|DateInterval|array|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

$this prependToChain(mixed $job)

Добавьте задачу в начало текущей цепочки, чтобы она выполнялась после текущей задачи.

Параметры

mixed $job

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

$this

$this appendToChain(mixed $job)

Добавьте задачу в конец текущей цепочки.

Параметры

mixed $job

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

$this

protected string serializeJob(mixed $job)

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

Параметры

mixed $job

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

string

Исключения

RuntimeException

void dispatchNextJobInChain()

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

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

void

void invokeChainCatchCallbacks(Throwable $e)

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

Параметры

Throwable $e

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

void

protected mixed getSerializedPropertyValue(mixed $value, bool $withRelations = true)

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

Параметры

mixed $value
bool $withRelations

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

mixed

protected mixed getRestoredPropertyValue(mixed $value)

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

Параметры

mixed $value

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

mixed

protected Collection restoreCollection(ModelIdentifier $value)

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

Параметры

ModelIdentifier $value

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

Collection

Model restoreModel(ModelIdentifier $value)

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

Параметры

ModelIdentifier $value

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

Model

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

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

Параметры

Model $model
array|int $ids

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

Builder

array __serialize()

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

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

array

void __unserialize(array $values)

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

Параметры

array $values

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

void

protected mixed getPropertyValue(ReflectionProperty $property)

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

Параметры

ReflectionProperty $property

Возвращаемое значение

mixed

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

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

Параметры

Notifiable|Collection $notifiables
Notification $notification
array $channels

Возвращаемое значение

void

protected Collection wrapNotifiables(Notifiable|Collection $notifiables)

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

Параметры

Notifiable|Collection $notifiables

Возвращаемое значение

Collection

void handle(ChannelManager $manager)

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

Параметры

ChannelManager $manager

Возвращаемое значение

void

string displayName()

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

Возвращаемое значение

string

void failed(Throwable $e)

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

Параметры

Throwable $e

Возвращаемое значение

void

mixed backoff()

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

Возвращаемое значение

mixed

DateTime|null retryUntil()

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

Возвращаемое значение

DateTime|null

void __clone()

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

Возвращаемое значение

void

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

Spec-Zone.ru

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