DatabaseQueue
class DatabaseQueue extends Очередь implements Очередь, ОчередьСУдалением (Просмотреть исходный код)
Особенности
| Взаимодействие со временем |
Свойства
| protected Контейнер | $container | Экземпляр контейнера IoC. | из Очереди |
| protected string | $connectionName | Имя подключения к очереди. | из Очереди |
| protected bool | $dispatchAfterCommit | Указывает, что задания должны запускаться после завершения всех транзакций базы данных. | из Очереди |
| static protected callable[] | $createPayloadCallbacks | Обработчики создания полезной нагрузки. | из Очереди |
| protected Подключение | $database | Экземпляр подключения к базе данных. | |
| protected string | $table | Таблица базы данных, хранящая задания. | |
| protected string | $default | Название очереди по умолчанию. | |
| protected int|null | $retryAfter | Время ожидания перед повторной попыткой. |
Методы
| 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 |
| mixed | pushOn(string $queue, string $job, mixed $data = '')
Добавить новую задачу в очередь. | from Queue |
| mixed | laterOn(string $queue, DateTimeInterface|DateInterval|int $delay, string $job, mixed $data = '')
Добавить новую задачу в определенную очередь через (n) секунд. | from Queue |
| void | bulk(array $jobs, mixed $data = '', string|null $queue = null)
Добавить массив задач в очередь. | |
| string | createPayload(Closure|string|object $job, string $queue, mixed $data = '')
Создать строку полезной нагрузки из заданной задачи и данных. | from Queue |
| array | createPayloadArray(string|object $job, string $queue, mixed $data = '')
Создать массив полезной нагрузки из заданной задачи и данных. | from Queue |
| array | createObjectPayload(object $job, string $queue)
Создать полезную нагрузку для обработчика очереди на основе объекта. | from Queue |
| string | getDisplayName(object $job)
Получить отображаемое имя для заданной задачи. | from Queue |
| mixed | getJobTries(mixed $job)
Получить максимальное количество попыток для обработчика очереди на основе объекта. | from Queue |
| mixed | getJobBackoff(mixed $job)
Получить откат для обработчика очереди на основе объекта. | from Queue |
| mixed | getJobExpiration(mixed $job)
Получить метку времени истечения срока действия для обработчика очереди на основе объекта. | from Queue |
| bool | jobShouldBeEncrypted(object $job)
Определить, следует ли шифровать задачу. | from Queue |
| array | createStringPayload(string $job, string $queue, mixed $data)
Создать типичный массив полезной нагрузки очереди на основе строки. | from Queue |
| static void | createPayloadUsing(callable|null $callback)
Зарегистрировать обратный вызов, который будет выполнен при создании полезных нагрузок задач. | from Queue |
| array | withCreatePayloadHooks(string $queue, array $payload)
Создать заданную полезную нагрузку, используя любые зарегистрированные хуки полезной нагрузки. | from Queue |
| mixed | enqueueUsing(Closure|string|object $job, string $payload, string $queue, DateTimeInterface|DateInterval|int|null $delay, callable $callback)
Добавить задачу в очередь, используя заданный обратный вызов. | from Queue |
| bool | shouldDispatchAfterCommit(Closure|string|object $job)
Определить, следует ли отправлять задачу после фиксации всех транзакций базы данных. | from Queue |
| void | raiseJobQueueingEvent(Closure|string|object $job, string $payload)
Вызвать событие постановки задачи в очередь. | from Queue |
| void | raiseJobQueuedEvent(string|int|null $jobId, Closure|string|object $job, string $payload)
Вызвать событие добавления задачи в очередь. | from Queue |
| string | getConnectionName()
Получить имя подключения для очереди. | from Queue |
| $this | setConnectionName(string $name)
Установить имя подключения для очереди. | from Queue |
| Container | getContainer()
Получить экземпляр контейнера, используемый подключением. | from Queue |
| void | setContainer(Container $container)
Установить экземпляр контейнера IoC. | from Queue |
| void | __construct(Connection $database, string $table, string $default = 'default', int $retryAfter = 60, bool $dispatchAfterCommit = false)
Создать новый экземпляр очереди базы данных. | |
| int | size(string|null $queue = null)
Получить размер очереди. | |
| mixed | push(string|object $job, mixed $data = '', string|null $queue = null)
Добавить новую задачу в очередь. |
| mixed | pushRaw(string $payload, string|null $queue = null, array $options = [])
Отправить сырое содержимое в очередь. | |
| mixed | later(DateTimeInterface|DateInterval|int $delay, string|object $job, mixed $data = '', string|null $queue = null)
Отправить задачу в очередь через (n) секунд. | |
| mixed | release(string $queue, DatabaseJobRecord $job, int $delay)
Вернуть зарезервированную задачу в очередь через (n) секунд. | |
| mixed | pushToDatabase(string|null $queue, string $payload, DateTimeInterface|DateInterval|int $delay = 0, int $attempts = 0)
Отправить сырое содержимое в базу данных с заданным отсрочкой (n) секунд. | |
| array | buildDatabaseRecord(string|null $queue, string $payload, int $availableAt, int $attempts = 0)
Создать массив для вставки заданной задачи. | |
| Job|null | pop(string|null $queue = null)
Извлечь следующую задачу из очереди. | |
| DatabaseJobRecord|null | getNextAvailableJob(string|null $queue)
Получить следующую доступную задачу для очереди. | |
| string|bool | getLockForPopping()
Получить блокировку, необходимую для извлечения следующей задачи. | |
| void | isAvailable(Builder $query)
Изменить запрос для проверки доступных задач. | |
| void | isReservedButExpired(Builder $query)
Изменить запрос для проверки зарезервированных, но истекших задач. | |
| DatabaseJob | marshalJob(string $queue, DatabaseJobRecord $job)
Преобразовать зарезервированную задачу в экземпляр DatabaseJob. | |
| DatabaseJobRecord | markJobAsReserved(DatabaseJobRecord $job)
Отметить заданную задачу как зарезервированную. | |
| void | deleteReserved(string $queue, string $id)
Удалить зарезервированную задачу из очереди. | |
| void | deleteAndRelease(string $queue, DatabaseJob $job, int $delay)
Удалить зарезервированную задачу из очереди и вернуть её в неё. | |
| int | clear(string $queue)
Удалить все задачи из очереди. | |
| string | getQueue(string|null $queue)
Получить очередь или вернуть значение по умолчанию. | |
| Connection | getDatabase()
Получить базовый экземпляр базы данных. |
Подробности
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-времени.
mixed pushOn(string $queue, string $job, mixed $data = '')
Отправить новую задачу в очередь.
mixed laterOn(string $queue, DateTimeInterface|DateInterval|int $delay, string $job, mixed $data = '')
Отправить новую задачу в определенную очередь через (n) секунд.
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 getJobTries(mixed $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 raiseJobQueueingEvent(Closure|string|object $job, string $payload)
Сгенерировать событие добавления задания в очередь.
protected void raiseJobQueuedEvent(string|int|null $jobId, Closure|string|object $job, string $payload)
Сгенерировать событие о добавлении задания в очередь.
string getConnectionName()
Получить имя подключения для очереди.
$this setConnectionName(string $name)
Установить имя подключения для очереди.
Container getContainer()
Получить экземпляр контейнера, используемый подключением.
void setContainer(Container $container)
Установить экземпляр контейнера IoC.
void __construct(Connection $database, string $table, string $default = 'default', int $retryAfter = 60, bool $dispatchAfterCommit = false)
Создать новый экземпляр очереди базы данных.
int size(string|null $queue = null)
Получить размер очереди.
mixed push(string|object $job, mixed $data = '', string|null $queue = null)
Добавить новую задачу в очередь.
mixed pushRaw(string $payload, string|null $queue = null, array $options = [])
Добавить сырое содержимое в очередь.
mixed later(DateTimeInterface|DateInterval|int $delay, string|object $job, mixed $data = '', string|null $queue = null)
Добавить новую задачу в очередь через (n) секунд.
mixed release(string $queue, DatabaseJobRecord $job, int $delay)
Возвратить зарезервированную задачу обратно в очередь через (n) секунд.
protected mixed pushToDatabase(string|null $queue, string $payload, DateTimeInterface|DateInterval|int $delay = 0, int $attempts = 0)
Добавить сырое содержимое в базу данных с заданным отсрочкой (n) секунд.
protected array buildDatabaseRecord(string|null $queue, string $payload, int $availableAt, int $attempts = 0)
Создать массив для вставки заданной задачи.
Job|null pop(string|null $queue = null)
Извлечь следующую задачу из очереди.
protected DatabaseJobRecord|null getNextAvailableJob(string|null $queue)
Получить следующую доступную задачу для очереди.
protected string|bool getLockForPopping()
Получить блокировку, необходимую для извлечения следующей задачи.
protected void isAvailable(Builder $query)
Изменить запрос для проверки наличия задач.
protected void isReservedButExpired(Builder $query)
Изменить запрос для проверки задач, которые зарезервированы, но истекли.
protected DatabaseJob marshalJob(string $queue, DatabaseJobRecord $job)
Обработать зарезервированную задачу в экземпляр DatabaseJob.
protected DatabaseJobRecord markJobAsReserved(DatabaseJobRecord $job)
Отметить заданный идентификатор задания как зарезервированный.
void deleteReserved(string $queue, string $id)
Удалить зарезервированное задание из очереди.
void deleteAndRelease(string $queue, DatabaseJob $job, int $delay)
Удалить зарезервированное задание из очереди и выпустить его.
int clear(string $queue)
Удалить все задания из очереди.
string getQueue(string|null $queue)
Получить очередь или вернуть значение по умолчанию.
Connection getDatabase()
Получить базовый экземпляр базы данных.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/10.x/Illuminate/Queue/DatabaseQueue.html
