Spec-Zone.ru › Laravel 11

NullQueue

class NullQueue extends Очередь implements Очередь (Просмотреть исходный код)

Методы

Взаимодействие со временем

Свойства

protected Контейнер $container

Экземпляр контейнера IoC.

из Очередь
protected string $connectionName

Имя подключения к очереди.

из Очередь
protected bool $dispatchAfterCommit

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

из Очередь
static protected callable[] $createPayloadCallbacks

Обратные вызовы создания полезной нагрузки.

из Очередь

Методы

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
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|null $queue, DateTimeInterface|DateInterval|int|null $delay, callable $callback)

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

из Queue
bool shouldDispatchAfterCommit(Closure|string|object $job)

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

из Queue
void raiseJobQueueingEvent(string $queue, Closure|string|object $job, string $payload, DateTimeInterface|DateInterval|int|null $delay)

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

из Queue
void raiseJobQueuedEvent(string|null $queue, string|int|null $jobId, Closure|string|object $job, string $payload, DateTimeInterface|DateInterval|int|null $delay)

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

из Queue
string getConnectionName()

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

из Queue
$this setConnectionName(string $name)

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

из Queue
Container getContainer()

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

из Queue
void setContainer(Container $container)

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

из очереди
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)

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

Подробности

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

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

Параметры

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 timestamp.

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

int

protected string runTimeForHumans(float $startTime, float $endTime = null)

Учитывая начальное время, отформатируйте общее время выполнения для удобочитаемости человеком.

Параметры

float $startTime
float $endTime

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

string

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 = '')

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

Параметры

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

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

mixed

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

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

Параметры

array $jobs
mixed $data
string|null $queue

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

void

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

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

Параметры

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

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

string

Исключения

InvalidPayloadException

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

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

Параметры

string|object $job
string $queue
mixed $data

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

array

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

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

Параметры

object $job
string $queue

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

array

protected string getDisplayName(object $job)

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

Параметры

object $job

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

string

mixed getJobTries(mixed $job)

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

Параметры

mixed $job

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

mixed
END_OF_DOCUMENT_MARKER

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)

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

Parameters

string $job
string $queue
mixed $data

Return Value

array

static void createPayloadUsing(callable|null $callback)

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

Parameters

callable|null $callback

Return Value

void

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

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

Parameters

string $queue
array $payload

Return Value

array

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

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

Parameters

Closure|string|object $job
string $payload
string|null $queue
DateTimeInterface|DateInterval|int|null $delay
callable $callback

Return Value

mixed

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

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

Parameters

Closure|string|object $job

Return Value

bool

protected void raiseJobQueueingEvent(string $queue, Closure|string|object $job, string $payload, DateTimeInterface|DateInterval|int|null $delay)

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

Parameters

string $queue
Closure|string|object $job
string $payload
DateTimeInterface|DateInterval|int|null $delay

Return Value

void

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

Сгенерировать событие задания, помещённого в очередь.

Parameters

string|null $queue
string|int|null $jobId
Closure|string|object $job
string $payload
DateTimeInterface|DateInterval|int|null $delay

Return Value

void

string getConnectionName()

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

Return Value

string

$this setConnectionName(string $name)

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

Parameters

string $name

Return Value

$this

Container getContainer()

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

Return Value

Container

void setContainer(Container $container)

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

Parameters

Container $container

Return Value

void

int size(string|null $queue = null)

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

Parameters

string|null $queue

Return Value

int

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

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

Parameters

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

Return Value

mixed

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

Отправить сырые данные в очередь.

Параметры

string $payload
string|null $queue
array $options

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

mixed

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

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

Параметры

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

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

mixed

Job|null pop(string|null $queue = null)

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

Параметры

string|null $queue

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

Job|null

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API