CallQueuedListener
класс CallQueuedListener реализует ShouldQueue (View source)
Трейты
| InteractsWithQueue | |
| Queueable | |
| InteractsWithTime |
Свойства
| 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 |
| string | $class | Имя класса слушателя. | |
| string | $method | Метод слушателя. | |
| array | $data | Данные, которые должны быть переданы слушателю. | |
| int | $tries | Количество попыток выполнения задачи. | |
| int | $maxExceptions | Максимальное количество исключений, разрешенных независимо от попыток. | |
| int | $backoff | Количество секунд ожидания перед повторной попыткой задачи, которая столкнулась с непредвиденным исключением. | |
| int | $retryUntil | Отметка времени, указывающая, когда задача должна истечь. | |
| int | $timeout | Количество секунд, которые задача может работать, прежде чем истечет время. | |
| bool | $failOnTimeout | Указывает, должна ли задача завершиться неудачно, если время истечет. | |
| 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()
Указать, что взаимодействия с очередью, такие как сбой, удаление и освобождение, должны быть подделаны. | 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 |
| void | __construct(string $class, string $method, array $data)
Создать новый экземпляр задачи. | |
| void | handle(Container $container)
Обработать задачу из очереди. | |
| object | setJobInstanceIfNecessary(Job $job, object $instance)
Установить экземпляр задачи заданного класса, если необходимо. | |
| void | failed(Throwable $e)
Вызвать метод failed для экземпляра задачи. | |
| void | prepareData()
Десериализовать данные при необходимости. | |
| string | displayName()
Получить отображаемое имя задачи из очереди. | |
| void | __clone()
Подготовить экземпляр для клонирования. |
Подробности
protected int secondsUntil(DateTimeInterface|DateInterval|int $delay)
Получить количество секунд до заданной даты и времени.
protected int availableAt(DateTimeInterface|DateInterval|int $delay = 0)
Получить отметку времени «доступно в» в формате UNIX timestamp.
protected DateTimeInterface|int parseDateInterval(DateTimeInterface|DateInterval|int $delay)
Если заданное значение является интервалом, преобразуйте его в экземпляр DateTime.
protected int currentTime()
Получить текущее системное время в формате UNIX timestamp.
protected string runTimeForHumans(float $startTime, float $endTime = null)
При заданном начальном времени, отформатировать общее время выполнения для удобного чтения человеком.
int attempts()
Получить количество попыток выполнения задачи.
void delete()
Удалить задачу из очереди.
void fail(Throwable|string|null $exception = null)
Отметить задачу как проваленную в очереди.
void release(DateTimeInterface|DateInterval|int $delay = 0)
Вернуть задачу обратно в очередь через (n) секунд.
$this withFakeQueueInteractions()
Указать, что взаимодействия с очередью (например, fail, delete, release) должны быть смоделированы.
$this assertDeleted()
Утверждение, что задача была удалена из очереди.
$this assertFailed()
Утверждение, что задача была отмечена как проваленная.
$this assertReleased(DateTimeInterface|DateInterval|int $delay = null)
Утверждение, что задача была возвращена в очередь.
$this setJob(Job $job)
Установить базовый экземпляр задачи очереди.
$this onConnection(string|null $connection)
Установите желаемое подключение для задачи.
$this onQueue(string|null $queue)
Установите желаемую очередь для задачи.
$this allOnConnection(string|null $connection)
Установите желаемое подключение для цепочки.
$this allOnQueue(string|null $queue)
Установите желаемую очередь для цепочки.
$this delay(DateTimeInterface|DateInterval|array|int|null $delay)
Установите желаемую задержку в секундах для задачи.
$this withoutDelay()
Установите задержку для задачи в ноль секунд.
$this afterCommit()
Укажите, что задача должна быть отправлена после завершения всех транзакций базы данных.
$this beforeCommit()
Укажите, что задача не должна ожидать завершения транзакций базы данных перед отправкой.
$this through(array|object $middleware)
Укажите средствами обработки, через которые должна быть отправлена задача.
$this chain(array $chain)
Установите задачи, которые должны выполняться, если эта задача выполнена успешно.
$this prependToChain(mixed $job)
Добавьте задачу в начало текущей цепочки, чтобы она выполнялась после текущей.
$this appendToChain(mixed $job)
Добавьте задачу в конец текущей цепочки.
protected string serializeJob(mixed $job)
Сериализовать задачу для очереди.
void dispatchNextJobInChain()
Отправить следующую задачу в цепочке.
void invokeChainCatchCallbacks(Throwable $e)
Вызвать все обработчики ошибок задач в цепочке.
void assertHasChain(array $expectedChain)
Утверждать, что у задачи есть заданная цепочка задач, прикрепленных к ней.
void assertDoesntHaveChain()
Утверждать, что у задачи нет оставшихся связанных задач.
void __construct(string $class, string $method, array $data)
Создать новый экземпляр задачи.
void handle(Container $container)
Обработать задачу в очереди.
protected object setJobInstanceIfNecessary(Job $job, object $instance)
Установить экземпляр задачи заданного класса, если необходимо.
void failed(Throwable $e)
Вызвать метод failed у экземпляра задачи.
В качестве параметров будут переданы экземпляр события и исключение.
protected void prepareData()
Десериализовать данные, если необходимо.
string displayName()
Получить имя для отображения запланированной задачи.
void __clone()
Подготовить экземпляр для клонирования.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/11.x/Illuminate/Events/CallQueuedListener.html