Очередь
абстрактный класс Очередь (Просмотр исходного кода)
Трейты
| InteractsWithTime |
Свойства
| protected Container | $container | Экземпляр контейнера IoC. | |
| protected string | $connectionName | Имя подключения для очереди. | |
| protected | $dispatchAfterCommit | Указывает, что задачи должны быть отправлены после того, как все транзакции базы данных будут завершены. | |
| static protected callable[] | $createPayloadCallbacks | Обработчики создания полезной нагрузки. |
Методы
| int | secondsUntil(DateTimeInterface|DateInterval|int $delay) Получить количество секунд до заданной даты DateTime. | из InteractsWithTime |
| int | availableAt(DateTimeInterface|DateInterval|int $delay = 0) Получить UNIX-метку времени «доступно в». | из InteractsWithTime |
| DateTimeInterface|int | parseDateInterval(DateTimeInterface|DateInterval|int $delay) Если заданное значение является интервалом, преобразовать его в экземпляр DateTime. | из InteractsWithTime |
| int | currentTime() Получить текущее системное время в виде UNIX-метки времени. | из InteractsWithTime |
| mixed | pushOn(string $queue, string $job, mixed $data = '') Добавить новую задачу в очередь. | |
| mixed | laterOn(string $queue, DateTimeInterface|DateInterval|int $delay, string $job, mixed $data = '') Добавить новую задачу в очередь с задержкой. | |
| void | bulk(array $jobs, mixed $data = '', string|null $queue = null) Добавить массив задач в очередь. | |
| string | createPayload(Closure|string|object $job, string $queue, mixed $data = '') Создать строку полезной нагрузки из заданной задачи и данных. | |
| array | createPayloadArray(string|object $job, string $queue, mixed $data = '') Создать массив полезной нагрузки из заданной задачи и данных. | |
| array | createObjectPayload(object $job, string $queue) Создать полезную нагрузку для обработчика очереди на основе объекта. | |
| string | getDisplayName(object $job) Получить отображаемое имя для заданной задачи. | |
| mixed | getJobBackoff(mixed $job) Получить задержку для обработчика очереди на основе объекта. | |
| mixed | getJobExpiration(mixed $job) Получить метку времени истечения срока действия для обработчика очереди на основе объекта. | |
| bool | jobShouldBeEncrypted(object $job) Определить, должна ли задача быть зашифрована. | |
| array | createStringPayload(string $job, string $queue, mixed $data) Создать массив типичной полезной нагрузки для очереди, основанной на строках. | |
| static void | createPayloadUsing(callable|null $callback) Зарегистрировать вызов, который будет выполнен при создании полезной нагрузки задачи. | |
| array | withCreatePayloadHooks(string $queue, array $payload) Создать заданную полезную нагрузку, используя любые зарегистрированные хуки полезной нагрузки. | |
| mixed | enqueueUsing(Closure|string|object $job, string $payload, string $queue, DateTimeInterface|DateInterval|int|null $delay, callable $callback) Добавить задачу в очередь, используя указанный вызов. | |
| bool | shouldDispatchAfterCommit(Closure|string|object $job) Определить, должна ли задача быть отправлена после завершения всех баз данных транзакций. | |
| void | raiseJobQueuedEvent(string|int|null $jobId, Closure|string|object $job) Вызвать событие очереди задачи. | |
| string | getConnectionName() Получить имя подключения для очереди. | |
| $this | setConnectionName(string $name) Установить имя подключения для очереди. | |
| Container | getContainer() Получить экземпляр контейнера, используемый подключением. | |
| void | setContainer(Container $container) Установить экземпляр контейнера IoC. |
Подробности
protected int secondsUntil(DateTimeInterface|DateInterval|int $delay)
Получить количество секунд до заданной даты DateTime.
protected int availableAt(DateTimeInterface|DateInterval|int $delay = 0)
Получить UNIX-метку времени «доступно в».
protected DateTimeInterface|int parseDateInterval(DateTimeInterface|DateInterval|int $delay)
Если заданное значение представляет собой интервал, преобразуйте его в экземпляр DateTime.
protected int currentTime()
Получить текущее системное время в формате метки времени Unix.
mixed pushOn(string $queue, string $job, mixed $data = '')
Добавить новую задачу в очередь.
mixed laterOn(string $queue, DateTimeInterface|DateInterval|int $delay, string $job, mixed $data = '')
Добавить новую задачу в очередь с отложенным выполнением.
void bulk(array $jobs, mixed $data = '', string|null $queue = null)
Добавить массив задач в очередь.
protected string createPayload(Closure|string|object $job, string $queue, mixed $data = '')
Создать строку полезной нагрузки из заданной задачи и данных.
protected array createPayloadArray(string|object $job, string $queue, mixed $data = '')
Создать массив полезной нагрузки из заданной задачи и данных.
protected array createObjectPayload(object $job, string $queue)
Создать полезную нагрузку для обработчика очереди на основе объектов.
protected string getDisplayName(object $job)
Получить отображаемое имя для заданной задачи.
mixed getJobBackoff(mixed $job)
Получить отложенное выполнение для обработчика очереди на основе объектов.
mixed getJobExpiration(mixed $job)
Получить метку времени истечения срока действия для обработчика очереди на основе объектов.
protected bool jobShouldBeEncrypted(object $job)
Определить, нужно ли шифровать задачу.
protected array createStringPayload(string $job, string $queue, mixed $data)
Создать типичный массив полезной нагрузки очереди на основе строк.
static void createPayloadUsing(callable|null $callback)
Зарегистрировать вызов, который будет выполняться при создании полезной нагрузки задач.
protected array withCreatePayloadHooks(string $queue, array $payload)
Создать заданную полезную нагрузку с использованием зарегистрированных крючков полезной нагрузки.
protected mixed enqueueUsing(Closure|string|object $job, string $payload, string $queue, DateTimeInterface|DateInterval|int|null $delay, callable $callback)
Добавить задачу в очередь с использованием заданного обратного вызова.
protected bool shouldDispatchAfterCommit(Closure|string|object $job)
Определить, следует ли отправлять задачу после завершения всех баз данных транзакций.
protected void raiseJobQueuedEvent(string|int|null $jobId, Closure|string|object $job)
Вызвать событие очереди задач.
string getConnectionName()
Получить имя подключения для очереди.
$this setConnectionName(string $name)
Установить имя подключения для очереди.
Container getContainer()
Получить экземпляр контейнера, используемый подключением.
void setContainer(Container $container)
Установить экземпляр контейнера IoC.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/8.x/Illuminate/Queue/Queue.html
