NullQueue

class NullQueue extends Queue implements Queue (View source)

Свойства

protected Container	$container	Экземпляр контейнера IoC.	from Очередь
protected string	$connectionName	Имя подключения к очереди.	from Очередь
protected bool	$dispatchAfterCommit	Указывает, что задачи должны быть отправлены после подтверждения всех транзакций базы данных.	from Очередь
static protected callable[]	$createPayloadCallbacks	Обратные вызовы для создания полезной нагрузки.	from Очередь

Методы

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
mixed	pushOn(string $queue, string $job, mixed $data = '') Добавить новую задачу в очередь.	из Queue
mixed	laterOn(string $queue, DateTimeInterface\|DateInterval\|int $delay, string $job, mixed $data = '') Добавить новую задачу в определенную очередь через (n) секунд.	из Queue
void	bulk(array $jobs, mixed $data = '', string\|null $queue = null) Добавить массив заданий в очередь.	из Queue
string	createPayload(Closure\|string\|object $job, string $queue, mixed $data = '') Создать строку полезной нагрузки из заданной работы и данных.	из Queue
array	createPayloadArray(string\|object $job, string $queue, mixed $data = '') Создать массив полезной нагрузки из заданной работы и данных.	из Queue
array	createObjectPayload(object $job, string $queue) Создать полезную нагрузку для обработчика очереди на основе объекта.	из Queue
string	getDisplayName(object $job) Получить отображаемое имя для заданной задачи.	из Queue
mixed	getJobTries(mixed $job) Получить максимальное количество попыток для обработчика очереди на основе объекта.	из Queue
mixed	getJobBackoff(mixed $job) Получить откат для обработчика очереди на основе объекта.	из Queue
mixed	getJobExpiration(mixed $job) Получить метку времени истечения срока действия для обработчика очереди на основе объекта.	из Queue
bool	jobShouldBeEncrypted(object $job) Определить, следует ли шифровать задачу.	из Queue
array	createStringPayload(string $job, string $queue, mixed $data) Создать типичный массив полезной нагрузки очереди на основе строки.	из Queue
static void	createPayloadUsing(callable\|null $callback) Зарегистрировать обратный вызов, который будет выполнен при создании полезных нагрузок заданий.	из Queue
array	withCreatePayloadHooks(string $queue, array $payload) Создать заданную полезную нагрузку с использованием любых зарегистрированных хуков полезной нагрузки.	из Queue
mixed	enqueueUsing(Closure\|string\|object $job, string $payload, string $queue, DateTimeInterface\|DateInterval\|int\|null $delay, callable $callback) Добавить задачу в очередь с помощью заданного обратного вызова.	из Queue
bool	shouldDispatchAfterCommit(Closure\|string\|object $job) Определить, следует ли отправлять задачу после подтверждения всех транзакций базы данных.	из Queue
void	raiseJobQueueingEvent(Closure\|string\|object $job, string $payload) Поднять событие постановки задачи в очередь.	из Queue
void	raiseJobQueuedEvent(string\|int\|null $jobId, Closure\|string\|object $job, string $payload) Поднять событие добавления задачи в очередь.	из Queue
string	getConnectionName() Получить имя подключения для очереди.	из Queue
$this	setConnectionName(string $name) Установить имя подключения для очереди.	из Queue
Container	getContainer() Получить экземпляр контейнера, используемый подключением.	из Queue
void	setContainer(Container $container) Установить экземпляр контейнера IoC.	из Queue
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) секунд.
Job\|null	pop(string\|null $queue = null) Извлечь следующую задачу из очереди.

Details

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

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

Parameters

DateTimeInterface|DateInterval|int

$delay

Return Value

int

protected int availableAt(DateTimeInterface|DateInterval|int $delay = 0)

Получить метку времени «доступно в» (UNIX timestamp).

Parameters

DateTimeInterface|DateInterval|int

$delay

Return Value

int

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

Если заданное значение является интервалом, преобразуйте его в экземпляр DateTime.

Parameters

DateTimeInterface|DateInterval|int

$delay

Return Value

DateTimeInterface|int

protected int currentTime()

Получить текущее системное время в формате UNIX timestamp.

Return Value

int

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

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

Parameters

string	$queue
string	$job
mixed	$data

Return Value

mixed

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

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

Parameters

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

Return Value

mixed

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

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

Parameters

array	$jobs
mixed	$data
string\|null	$queue

Return Value

void

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

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

Parameters

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

Return Value

string

Exceptions

InvalidPayloadException

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

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

Parameters

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

Return Value

array

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

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

Parameters

object	$job
string	$queue

Return Value

array

protected string getDisplayName(object $job)

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

Parameters

object

$job

Return Value

string

mixed getJobTries(mixed $job)

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

Parameters

mixed

$job

Return Value

mixed

mixed getJobBackoff(mixed $job)

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

Parameters

mixed

$job

Return Value

mixed

mixed getJobExpiration(mixed $job)

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

Parameters

mixed

$job

Return Value

mixed

protected bool jobShouldBeEncrypted(object $job)

Определить, должна ли задача быть зашифрована.

Parameters

object

$job

Return Value

bool

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

Создайте типичный массив данных очереди на основе строк.

Параметры

строка	$job
строка	$queue
смешанный	$data

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

массив

static void createPayloadUsing(callable|null $callback)

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

Параметры

callable|null

$callback

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

void

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

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

Параметры

строка	$queue
массив	$payload

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

массив

protected mixed enqueueUsing(Closure|string|object $job, string $payload, string $queue, DateTimeInterface|DateInterval|int|null $delay, callable $callback)

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

Параметры

Closure\|строка\|объект	$job
строка	$payload
строка	$queue
DateTimeInterface\|DateInterval\|int\|null	$delay
callable	$callback

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

смешанный

protected bool shouldDispatchAfterCommit(Closure|string|object $job)

Определить, нужно ли запускать задачу после завершения всех транзакций базы данных.

Параметры

Closure|строка|объект

$job

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

bool

protected void raiseJobQueueingEvent(Closure|string|object $job, string $payload)

Вызвать событие добавления задачи в очередь.

Параметры

Closure\|строка\|объект	$job
строка	$payload

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

void

protected void raiseJobQueuedEvent(string|int|null $jobId, Closure|string|object $job, string $payload)

Вызвать событие, что задача добавлена в очередь.

Параметры

строка\|int\|null	$jobId
Closure\|строка\|объект	$job
строка	$payload

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

void

string getConnectionName()

Получить имя соединения для очереди.

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

строка

$this setConnectionName(string $name)

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

Параметры

строка

$name

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

$this

Контейнер getContainer()

Получить экземпляр контейнера, используемый подключением.

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

Контейнер

void setContainer(Контейнер $container)

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

Параметры

Контейнер

$container

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

void

int size(string|null $queue = null)

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

Параметры

строка|null

$queue

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

int

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

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

Параметры

строка\|объект	$job
смешанный	$data
строка\|null	$queue

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

смешанный

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

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

Параметры

строка	$payload
строка\|null	$queue
массив	$options

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

смешанный

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

Добавить новую задачу в очередь через (n) секунд.

Параметры

DateTimeInterface\|DateInterval\|int	$delay
строка\|объект	$job
смешанный	$data
строка\|null	$queue

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

смешанный

Задача|null pop(string|null $queue = null)

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

Параметры

строка|null

$queue

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

Задача|null

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