DatabaseQueue

класс DatabaseQueue расширяет Queue реализует Queue (View source)

Черты

Свойства

protected Container	$container	Экземпляр контейнера IoC.	из Queue
protected string	$connectionName	Имя соединения для очереди.	из Queue
static protected callable\|null	$createPayloadCallback	Обратный вызов для создания полезной нагрузки.	из Queue
protected Connection	$database	Экземпляр соединения с базой данных.
protected string	$table	Таблица базы данных, содержащая задания.
protected string	$default	Имя очереди по умолчанию.
protected int\|null	$retryAfter	Время истечения срока действия задания.

Методы

int	secondsUntil(DateTimeInterface\|DateInterval\|int $delay) Получить количество секунд до заданного времени DateTime.	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 = '') Добавить новую задачу в очередь после задержки.	from Queue
mixed	bulk(array $jobs, mixed $data = '', string $queue = null) Добавить массив задач в очередь.
string	createPayload(string $job, string $queue, mixed $data = '') Создать строку полезной нагрузки из заданной задачи и данных.	from Queue
array	createPayloadArray(mixed $job, string $queue, mixed $data = '') Создать массив полезной нагрузки из заданной задачи и данных.	from Queue
array	createObjectPayload(mixed $job, string $queue) Создать полезную нагрузку для обработчика очереди на основе объекта.	from Queue
string	getDisplayName(mixed $job) Получить отображаемое имя для заданной задачи.	from Queue
mixed	getJobExpiration(mixed $job) Получить метку времени истечения срока действия для обработчика очереди на основе объекта.	from Queue
array	createStringPayload(string $job, string $queue, mixed $data) Создать типичный массив полезной нагрузки очереди на основе строки.	from Queue
static void	createPayloadUsing(callable $callback) Зарегистрировать обратный вызов, который будет выполнен при создании полезных нагрузок заданий.	from Queue
array	withCreatePayloadHooks(string $queue, array $payload) Создать заданную полезную нагрузку, используя любые зарегистрированные хуки полезной нагрузки.	from Queue
string	getConnectionName() Получить имя соединения для очереди.	from Queue
$this	setConnectionName(string $name) Установить имя соединения для очереди.	from Queue
void	setContainer(Container $container) Установить экземпляр контейнера IoC.	from Queue
void	__construct(Connection $database, string $table, string $default = 'default', int $retryAfter = 60) Создать новый экземпляр очереди базы данных.
int	size(string $queue = null) Получить размер очереди.
mixed	push(string\|object $job, mixed $data = '', string $queue = null) Добавить новую задачу в очередь.
mixed	pushRaw(string $payload, string $queue = null, array $options = []) Добавить необработанную полезную нагрузку в очередь.
mixed	later(DateTimeInterface\|DateInterval\|int $delay, string\|object $job, mixed $data = '', string $queue = null) Добавить новую задачу в очередь после задержки.
mixed	release(string $queue, DatabaseJobRecord $job, int $delay) Вернуть зарезервированную задачу обратно в очередь.
mixed	pushToDatabase(string\|null $queue, string $payload, DateTimeInterface\|DateInterval\|int $delay = 0, int $attempts = 0) Добавить необработанную полезную нагрузку в базу данных с заданной задержкой.
array	buildDatabaseRecord(string\|null $queue, string $payload, int $availableAt, int $attempts = 0) Создать массив для вставки для заданной задачи.
Job\|null	pop(string $queue = null) Извлечь следующую задачу из очереди.
DatabaseJobRecord\|null	getNextAvailableJob(string\|null $queue) Получить следующую доступную задачу для очереди.
void	isAvailable(Builder $query) Изменить запрос для проверки доступных заданий.
void	isReservedButExpired(Builder $query) Изменить запрос для проверки заданий, которые зарезервированы, но срок их действия истек.
DatabaseJob	marshalJob(string $queue, DatabaseJobRecord $job) Преобразовать зарезервированную задачу в экземпляр DatabaseJob.

DatabaseJobRecord	markJobAsReserved(DatabaseJobRecord $job) Пометить заданный ID задания как зарезервированный.
void	deleteReserved(string $queue, string $id) Удалить зарезервированное задание из очереди.
string	getQueue(string\|null $queue) Получить очередь или вернуть значение по умолчанию.
Connection	getDatabase() Получить основной экземпляр базы данных.

Подробности

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

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

Параметры

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

mixed pushOn(string $queue, string $job, mixed $data = '')

Добавить новое задание в очередь.

Параметры

string	$queue
string	$job
mixed	$data

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

mixed

mixed laterOn(string $queue, DateTimeInterface|DateInterval|int $delay, string $job, mixed $data = '')

Добавить новое задание в очередь после задержки.

Параметры

string	$queue
DateTimeInterface\|DateInterval\|int	$delay
string	$job
mixed	$data

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

mixed

mixed bulk(array $jobs, mixed $data = '', string $queue = null)

Добавить массив заданий в очередь.

Параметры

array	$jobs
mixed	$data
string	$queue

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

mixed

protected string createPayload(string $job, string $queue, mixed $data = '')

Создать строку полезной нагрузки из заданного задания и данных.

Параметры

string	$job
string	$queue
mixed	$data

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

string

Исключения

InvalidPayloadException

protected array createPayloadArray(mixed $job, string $queue, mixed $data = '')

Создать массив полезной нагрузки из заданного задания и данных.

Параметры

mixed	$job
string	$queue
mixed	$data

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

array

protected array createObjectPayload(mixed $job, string $queue)

Создать полезную нагрузку для обработчика очереди на основе объекта.

Параметры

mixed	$job
string	$queue

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

array

protected string getDisplayName(mixed $job)

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

Параметры

mixed

$job

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

string

mixed getJobExpiration(mixed $job)

Получить метку времени истечения срока действия для обработчика очереди на основе объекта.

Параметры

mixed

$job

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

mixed

protected array createStringPayload(string $job, string $queue, mixed $data)

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

Параметры

string	$job
string	$queue
mixed	$data

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

array

static void createPayloadUsing(callable $callback)

Зарегистрировать обратный вызов, который будет выполнен при создании полезных нагрузок заданий.

Параметры

callable

$callback

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

void

protected array withCreatePayloadHooks(string $queue, array $payload)

Создать заданную полезную нагрузку, используя любые зарегистрированные хуки полезной нагрузки.

Параметры

string	$queue
array	$payload

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

array

string getConnectionName()

Получить имя подключения для очереди.

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

string

$this setConnectionName(string $name)

Установить имя соединения для очереди.

Parameters

string

$name

Return Value

$this

void setContainer(Container $container)

Установить экземпляр контейнера IoC.

Parameters

Container

$container

Return Value

void

void __construct(Connection $database, string $table, string $default = 'default', int $retryAfter = 60)

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

Parameters

Connection	$database
string	$table
string	$default
int	$retryAfter

Return Value

void

int size(string $queue = null)

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

Parameters

string

$queue

Return Value

int

mixed push(string|object $job, mixed $data = '', string $queue = null)

Добавить новую задачу в очередь.

Parameters

string\|object	$job
mixed	$data
string	$queue

Return Value

mixed

mixed pushRaw(string $payload, string $queue = null, array $options = [])

Добавить необработанный полезный груз в очередь.

Parameters

string	$payload
string	$queue
array	$options

Return Value

mixed

mixed later(DateTimeInterface|DateInterval|int $delay, string|object $job, mixed $data = '', string $queue = null)

Добавить новую задачу в очередь после задержки.

Parameters

DateTimeInterface\|DateInterval\|int	$delay
string\|object	$job
mixed	$data
string	$queue

Return Value

mixed

mixed release(string $queue, DatabaseJobRecord $job, int $delay)

Вернуть зарезервированную задачу обратно в очередь.

Parameters

string	$queue
DatabaseJobRecord	$job
int	$delay

Return Value

mixed

protected mixed pushToDatabase(string|null $queue, string $payload, DateTimeInterface|DateInterval|int $delay = 0, int $attempts = 0)

Добавить необработанный полезный груз в базу данных с заданной задержкой.

Parameters

string\|null	$queue
string	$payload
DateTimeInterface\|DateInterval\|int	$delay
int	$attempts

Return Value

mixed

protected array buildDatabaseRecord(string|null $queue, string $payload, int $availableAt, int $attempts = 0)

Создать массив для вставки для данной задачи.

Parameters

string\|null	$queue
string	$payload
int	$availableAt
int	$attempts

Return Value

array

Job|null pop(string $queue = null)

Извлечь следующую задачу из очереди.

Parameters

string

$queue

Return Value

Job|null

Exceptions

Throwable

protected DatabaseJobRecord|null getNextAvailableJob(string|null $queue)

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

Parameters

string|null

$queue

Return Value

DatabaseJobRecord|null

protected void isAvailable(Builder $query)

Изменить запрос для проверки доступных заданий.

Parameters

Builder

$query

Return Value

void

protected void isReservedButExpired(Builder $query)

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

Parameters

Builder

$query

Return Value

void

protected DatabaseJob marshalJob(string $queue, DatabaseJobRecord $job)

Преобразовать зарезервированную задачу в экземпляр DatabaseJob.

Parameters

string	$queue
DatabaseJobRecord	$job

Return Value

DatabaseJob

protected DatabaseJobRecord markJobAsReserved(DatabaseJobRecord $job)

Пометить заданный ID задания как зарезервированный.

Parameters

DatabaseJobRecord

$job

Return Value

DatabaseJobRecord

void deleteReserved(string $queue, string $id)

Удалить зарезервированное задание из очереди.

Parameters

string	$queue
string	$id

Return Value

void

Exceptions

Throwable

string getQueue(string|null $queue)

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

Parameters

string|null

$queue

Return Value

string

Connection getDatabase()

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

Return Value

Connection

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.7/Illuminate/Queue/DatabaseQueue.html