Очередь
Атрибут Очередь (Просмотреть исходный код)
Атрибуты
| Отправляемый | |
| Взаимодействует с очередью | |
| Очередной | |
| Сериализует модели | |
| Взаимодействует со временем | |
| Сериализует и восстанавливает идентификаторы моделей |
Свойства
| Задача|null | $job | Экземпляр задачи очереди. | из Взаимодействует с очередью |
| строка|null | $connection | Имя соединения, к которому должна быть отправлена задача. | из Очередной |
| строка|null | $queue | Имя очереди, к которому должна быть отправлена задача. | из Очередной |
| DateTimeInterface|DateInterval|массив|целое число|null | $delay | Количество секунд, ожидающих, прежде чем задача станет доступной. | из Очередной |
| логическое значение|null | $afterCommit | Указывает, должна ли задача быть отправлена после завершения всех транзакций базы данных. | из Очередной |
| массив | $middleware | Средства, через которые должна быть отправлена задача. | из Очередной |
| массив | $chained | Задачи, которые должны выполняться, если эта задача выполнена успешно. | из Очередной |
| строка|null | $chainConnection | Имя соединения, к которому должна быть отправлена цепочка. | из Очередной |
| строка|null | $chainQueue | Имя очереди, к которому должна быть отправлена цепочка. | из Очередной |
| массив|null | $chainCatchCallbacks | Обратные вызовы для выполнения при ошибке цепочки. | из Очередной |
Методы
| static PendingDispatch | dispatch(mixed ...$arguments)
Отправить задачу с указанными аргументами. | из Dispatchable |
| static PendingDispatch|Fluent | dispatchIf(bool|Closure $boolean, mixed ...$arguments)
Отправить задачу с указанными аргументами, если заданное истинное условие выполняется. | из Dispatchable |
| static PendingDispatch|Fluent | dispatchUnless(bool|Closure $boolean, mixed ...$arguments)
Отправить задачу с указанными аргументами, если заданное истинное условие НЕ выполняется. | из Dispatchable |
| static mixed | dispatchSync(mixed ...$arguments)
Отправить команду соответствующему обработчику в текущем процессе. | из Dispatchable |
| static mixed | dispatchAfterResponse(mixed ...$arguments)
Отправить команду соответствующему обработчику после текущего процесса. | из Dispatchable |
| static PendingChain | withChain(array $chain)
Установить задачи, которые должны выполняться, если эта задача завершится успешно. | из Dispatchable |
| int | secondsUntil(DateTimeInterface|DateInterval|int $delay)
Получить количество секунд до указанной даты и времени. | из InteractsWithTime |
| int | availableAt(DateTimeInterface|DateInterval|int $delay = 0)
Получить отметку времени «доступно в» в формате UNIX. | из InteractsWithTime |
| DateTimeInterface|int | parseDateInterval(DateTimeInterface|DateInterval|int $delay)
Если заданное значение представляет собой интервал, преобразовать его в экземпляр DateTime. | из InteractsWithTime |
| int | currentTime()
Получить текущее системное время в формате UNIX. | из InteractsWithTime |
| string | runTimeForHumans(float $startTime, float $endTime = null)
Учитывая начальное время, отформатировать общее время выполнения для удобного чтения человеком. | из InteractsWithTime |
| int | attempts()
Получить количество попыток выполнения задачи. | из InteractsWithQueue |
| void | delete()
Удалить задачу из очереди. | из InteractsWithQueue |
| void | fail(Throwable|string|null $exception = null)
Признавать задачу проваленной в очереди. | из InteractsWithQueue |
| void | release(DateTimeInterface|DateInterval|int $delay = 0)
Вернуть задачу обратно в очередь через (n) секунд. | из InteractsWithQueue |
| $this | withFakeQueueInteractions()
Указать, что взаимодействия с очередью, такие как fail, delete и release, должны быть смоделированы. | из InteractsWithQueue |
| $this | assertDeleted()
Утверждение, что задача была удалена из очереди. | из InteractsWithQueue |
| $this | assertFailed()
Утверждение, что задача была вручную отмечена как проваленная. | из InteractsWithQueue |
| $this | assertReleased(DateTimeInterface|DateInterval|int $delay = null)
Утверждение, что задача была возвращена в очередь. | из 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|array|int|null $delay)
Установить желаемую задержку для задачи в секундах. | из Queueable |
| $this | withoutDelay()
Установить задержку для задания на ноль секунд. | из Queueable |
| $this | afterCommit()
Указать, что задание должно быть отправлено после подтверждения всех транзакций базы данных. | из Queueable |
| $this | beforeCommit()
Указать, что задание не должно ожидать подтверждения транзакций базы данных перед отправкой. | из Queueable |
| $this | through(array|object $middleware)
Указать, через какой middleware должно быть отправлено задание. | из Queueable |
| $this | chain(array $chain)
Установить задания, которые должны выполняться, если это задание выполняется успешно. | из Queueable |
| $this | prependToChain(mixed $job)
Добавить задание в начало текущей цепочки, чтобы оно выполнялось после текущего выполняемого задания. | из Queueable |
| $this | appendToChain(mixed $job)
Добавить задание в конец текущей цепочки. | из Queueable |
| string | serializeJob(mixed $job)
Сериализовать задание для очереди. | из Queueable |
| void | dispatchNextJobInChain()
Отправить следующее задание в цепочке. | из 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 |
Подробности
static PendingDispatch dispatch(mixed ...$arguments)
Отправить задание с заданными аргументами.
static PendingDispatch|Fluent dispatchIf(bool|Closure $boolean, mixed ...$arguments)
Отправить задание с заданными аргументами, если заданное условие истинно.
static PendingDispatch|Fluent dispatchUnless(bool|Closure $boolean, mixed ...$arguments)
Отправить задание с заданными аргументами, если заданное условие ложно.
static mixed dispatchSync(mixed ...$arguments)
Отправить команду соответствующему обработчику в текущем процессе.
Задачки, поддерживающие очереди, будут отправлены в очередь "sync".
static mixed dispatchAfterResponse(mixed ...$arguments)
Отправить команду соответствующему обработчику после завершения текущего процесса.
static PendingChain withChain(array $chain)
Установить задачи, которые должны выполняться, если эта задача завершится успешно.
protected int secondsUntil(DateTimeInterface|DateInterval|int $delay)
Получить количество секунд до указанной даты и времени.
protected int availableAt(DateTimeInterface|DateInterval|int $delay = 0)
Получить отметку времени UNIX "доступно в" .
protected DateTimeInterface|int parseDateInterval(DateTimeInterface|DateInterval|int $delay)
Если заданное значение является интервалом, преобразовать его в экземпляр DateTime.
protected int currentTime()
Получить текущее системное время в виде отметки времени UNIX.
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()
Проверить, что задание не имеет оставшихся связанных заданий.
protected mixed getSerializedPropertyValue(mixed $value, bool $withRelations = true)
Получить значение свойства, подготовленное для сериализации.
protected mixed getRestoredPropertyValue(mixed $value)
Получить восстановленное значение свойства после десериализации.
protected Collection restoreCollection(ModelIdentifier $value)
Восстановить экземпляр коллекций, которые можно поместить в очередь.
Model restoreModel(ModelIdentifier $value)
Восстановить модель из экземпляра идентификатора модели.
protected TModel> getQueryForModelRestoration(TModel $model, array|int $ids)
Получить запрос для восстановления модели.
array __serialize()
Подготовить значения экземпляра для сериализации.
void __unserialize(array $values)
Восстановить модель после сериализации.
protected mixed getPropertyValue(ReflectionProperty $property)
Получить значение свойства для данного свойства.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/11.x/Illuminate/Foundation/Queue/Queueable.html
