Spec-Zone.ru › Laravel 11

SendQueuedNotifications

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

Трейты

InteractsWithQueue
Queueable
SerializesModels
InteractsWithTime
SerializesAndRestoresModelIdentifiers

Свойства

Job|null $job

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

из InteractsWithQueue
string|null $connection

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

из Queueable
string|null $queue

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

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

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

из Queueable
bool|null $afterCommit

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

из Queueable
array $middleware

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

из Queueable
array $chained

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

из Queueable
string|null $chainConnection

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

из Queueable
string|null $chainQueue

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

из Queueable
array|null $chainCatchCallbacks

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

из Queueable
Collection $notifiables

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

Notification $notification

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

array $channels

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

int $tries

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

int $timeout

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

int $maxExceptions

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

bool $shouldBeEncrypted

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

Методы

int secondsUntil(DateTimeInterface|DateInterval|int $delay)

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

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
string runTimeForHumans(float $startTime, float $endTime = null)

Учитывая время начала, отформатируйте общее время выполнения для удобства чтения человеком.

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 withFakeQueueInteractions()

Указать, что взаимодействия с очередью, такие как fail, delete и release, должны быть подделаны.

from InteractsWithQueue
$this assertDeleted()

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

from InteractsWithQueue
$this assertFailed()

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

from InteractsWithQueue
$this assertReleased(DateTimeInterface|DateInterval|int $delay = null)

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

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 withoutDelay()

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

from Queueable
$this afterCommit()

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

from Queueable
$this beforeCommit()

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

from Queueable
$this through(array|object $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)

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

из Queueable
void assertHasChain(array $expectedChain)

Утвердить, что задаче прикреплена заданная цепочка задач.

из Queueable
void assertDoesntHaveChain()

Утвердить, что у задачи нет оставшихся задач в цепочке.

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

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

из SerializesAndRestoresModelIdentifiers
mixed getRestoredPropertyValue(mixed $value)

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

из SerializesAndRestoresModelIdentifiers
Collection restoreCollection(ModelIdentifier $value)

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

из SerializesAndRestoresModelIdentifiers
Model restoreModel(ModelIdentifier $value)

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

из SerializesAndRestoresModelIdentifiers
TModel> getQueryForModelRestoration(TModel $model, array|int $ids)

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

из SerializesAndRestoresModelIdentifiers
array __serialize()

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

из SerializesModels
void __unserialize(array $values)

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

из SerializesModels
mixed getPropertyValue(ReflectionProperty $property)

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

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

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

Collection wrapNotifiables(Notifiable|Collection $notifiables)

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

void handle(ChannelManager $manager)

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

string displayName()

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

void failed(Throwable $e)

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

mixed 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-временную метку "доступно в".

Параметры

DateTimeInterface|DateInterval|int $delay

Значение результата

int

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

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

Параметры

DateTimeInterface|DateInterval|int $delay

Значение результата

DateTimeInterface|int

protected int currentTime()

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

Значение результата

int

protected string runTimeForHumans(float $startTime, float $endTime = null)

Учитывая начальное время, отформатировать общее время работы для удобства чтения.

Параметры

float $startTime
float $endTime

Значение результата

string

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 withFakeQueueInteractions()

Указать, что взаимодействия с очередью, такие как fail, delete и release, должны быть смоделированы.

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

$this

$this assertDeleted()

Утверждение, что задание было удалено из очереди.

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

$this

$this assertFailed()

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

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

$this

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

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

Параметры

DateTimeInterface|DateInterval|int $delay

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

$this

$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 withoutDelay()

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

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

$this

$this afterCommit()

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

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

$this

$this beforeCommit()

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

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

$this

$this through(array|object $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
END_OF_DOCUMENT_MARKER

void dispatchNextJobInChain()

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

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

void

void invokeChainCatchCallbacks(Throwable $e)

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

Параметры

Throwable $e

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

void

void assertHasChain(array $expectedChain)

Утверждение, что задача содержит указанную цепочку задач.

Параметры

array $expectedChain

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

void

void assertDoesntHaveChain()

Утверждение, что задача не содержит связанных задач.

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

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)

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

Параметры

ModelIdentifier $value

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

Collection

Model restoreModel(ModelIdentifier $value)

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

Параметры

ModelIdentifier $value

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

Model

protected TModel> getQueryForModelRestoration(TModel $model, array|int $ids)

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

Параметры

TModel $model
array|int $ids

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

TModel>

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|null $channels = null)

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

Параметры

Notifiable|Collection $notifiables
Notification $notification
array|null $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
END_OF_DOCUMENT_MARKER

void __clone()

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

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

void

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

Spec-Zone.ru

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