Spec-Zone.ru › Laravel 5.6

Задание

класс Задание (Просмотреть исходный код)

Трейты

InteractsWithTime

Свойства

protected mixed $instance Экземпляр обработчика задания.
protected Container $container Экземпляр контейнера IoC.
protected bool $deleted Указывает, было ли задание удалено.
protected bool $released Указывает, было ли задание возвращено в очередь.
protected bool $failed Указывает, потерпел ли провал работы задания.
protected $connectionName Имя соединения, к которому принадлежит задание.
protected string $queue Имя очереди, к которой принадлежит задание.

Методы

int secondsUntil(DateTimeInterface|DateInterval|int $delay)

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

из InteractsWithTime
int availableAt(DateTimeInterface|DateInterval|int $delay)

Получить метку времени "доступно в" в формате Unix Timestamp.

из InteractsWithTime
DateTimeInterface|int parseDateInterval(DateTimeInterface|DateInterval|int $delay)

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

из InteractsWithTime
int currentTime()

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

из InteractsWithTime
string getJobId()

Получить идентификатор задания.

string getRawBody()

Получить исходное тело задания.

void fire()

Запустить задание.

void delete()

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

bool isDeleted()

Определить, было ли задание удалено.

void release(int $delay)

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

bool isReleased()

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

bool isDeletedOrReleased()

Определить, было ли задание удалено или возвращено в очередь.

bool hasFailed()

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

void markAsFailed()

Пометить задание как "неисправное".

void failed(Exception $e)

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

mixed resolve(string $class)

Разрешить указанный класс.

array payload()

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

int|null maxTries()

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

int|null timeout()

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

int|null timeoutAt()

Получить метку времени, указывающую, когда задание должно истечь.

string getName()

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

string resolveName()

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

string getConnectionName()

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

string getQueue()

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

Container getContainer()

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

Подробности

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

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

Параметры

DateTimeInterface|DateInterval|int $delay

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

int

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

Получить метку времени "доступно в" в формате Unix Timestamp.

Параметры

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

abstract string getJobId()

Получить идентификатор задания.

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

string

абстрактный строка getRawBody()

Получить исходное тело задачи.

Значение возвращаемого значения

строка

пустое fire()

Запустить задачу.

Значение возвращаемого значения

пустое

пустое delete()

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

Значение возвращаемого значения

пустое

логическое isDeleted()

Определить, была ли задача удалена.

Значение возвращаемого значения

логическое

пустое release(int $delay)

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

Параметры

int $delay

Значение возвращаемого значения

пустое

логическое isReleased()

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

Значение возвращаемого значения

логическое

логическое isDeletedOrReleased()

Определить, была ли задача удалена или возвращена в очередь.

Значение возвращаемого значения

логическое

логическое hasFailed()

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

Значение возвращаемого значения

логическое

пустое markAsFailed()

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

Значение возвращаемого значения

пустое

пустое failed(Exception $e)

Обработать исключение, вызвавшее завершение задачи с ошибкой.

Параметры

Exception $e

Значение возвращаемого значения

пустое

защищённый смешанный resolve(string $class)

Разрешить указанный класс.

Параметры

строка $class

Значение возвращаемого значения

смешанный

массив payload()

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

Значение возвращаемого значения

массив

целое число|null maxTries()

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

Значение возвращаемого значения

целое число|null

целое число|null timeout()

Получить количество секунд, в течение которых может выполняться задача.

Значение возвращаемого значения

целое число|null

целое число|null timeoutAt()

Получить метку времени, указывающую, когда задача должна истечь.

Значение возвращаемого значения

целое число|null

строка getName()

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

Значение возвращаемого значения

строка

строка resolveName()

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

Разрешает имя задач «обёрток», таких как обработчики на основе классов.

Значение возвращаемого значения

строка

строка getConnectionName()

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

Значение возвращаемого значения

строка

строка getQueue()

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

Значение возвращаемого значения

строка

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

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

Значение возвращаемого значения

Контейнер

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

Spec-Zone.ru

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