Spec-Zone.ru › Laravel 5.8

NullQueue

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

Черты

InteractsWithTime

Свойства

protected Container $container Экземпляр контейнера IoC. из Queue
protected string $connectionName Имя соединения для очереди. из Queue
static protected callable[] $createPayloadCallbacks Обратные вызовы создания полезной нагрузки. из Queue

Методы

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

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

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

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

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

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

из Queue
string createPayload(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 getJobRetryDelay(mixed $job)

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

из Queue
mixed getJobExpiration(mixed $job)

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

из Queue
array createStringPayload(string $job, string $queue, mixed $data)

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

из Queue
static void createPayloadUsing(callable $callback)

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

из Queue
array withCreatePayloadHooks(string $queue, array $payload)

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

из Queue
string getConnectionName()

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

из Queue
$this setConnectionName(string $name)

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

из 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)

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

Job|null pop(string $queue = null)

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

Подробности

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

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

Параметры

DateTimeInterface|DateInterval|int $delay

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

int
END_OF_DOCUMENT_MARKER

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

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

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

Параметры

array $jobs
mixed $data
string|null $queue

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

void

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

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

Параметры

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 getJobRetryDelay(mixed $job)

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

Параметры

mixed $job

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

mixed

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)

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

Параметры

string $name

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

$this

void setContainer(Container $container)

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

Параметры

Container $container

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

void

int size(string|null $queue = null)

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

Параметры

string|null $queue

Значение возврата

int

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

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

Параметры

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

Значение возврата

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)

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

Параметры

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

Значение возврата

mixed

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

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

Параметры

string $queue

Значение возврата

Задача|null

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

Spec-Zone.ru

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