Задача

абстрактный класс Задача (Просмотр исходного кода)

Трейты

Свойства

protected смешанный	$instance	Экземпляр обработчика задач.
protected Контейнер	$container	Экземпляр контейнера IoC.
protected логический	$deleted	Указывает, была ли задача удалена.
protected логический	$released	Указывает, была ли задача выпущена.
protected логический	$failed	Указывает, потерпела ли задача неудачу.
protected	$connectionName	Имя подключения, к которому относится задача.
protected строка	$queue	Имя очереди, к которой относится задача.

Методы

целое

secondsUntil(DateTimeInterface|DateInterval|целое $delay)

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

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

целое

availableAt(DateTimeInterface|DateInterval|целое $delay = 0)

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

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

DateTimeInterface|целое

parseDateInterval(DateTimeInterface|DateInterval|целое $delay)

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

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

целое

currentTime()

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

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

строка

getJobId()

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

строка

getRawBody()

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

void

fire()

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

void

delete()

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

логический

isDeleted()

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

void

release(целое $delay = 0)

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

логический

isReleased()

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

логический

isDeletedOrReleased()

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

логический

hasFailed()

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

void

markAsFailed()

Пометить задачу как «неудачная».

void

failed(Исключение $e)

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

смешанный

resolve(строка $class)

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

массив

payload()

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

целое|null

maxTries()

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

целое|null

timeout()

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

целое|null

timeoutAt()

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

строка

getName()

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

строка

resolveName()

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

строка

getConnectionName()

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

строка

getQueue()

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

Контейнер

getContainer()

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

Детали

protected целое secondsUntil(DateTimeInterface|DateInterval|целое $delay)

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

Параметры

DateTimeInterface|DateInterval|целое

$delay

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

целое

protected целое availableAt(DateTimeInterface|DateInterval|целое $delay = 0)

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

Параметры

DateTimeInterface|DateInterval|целое

$delay

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

целое

protected DateTimeInterface|целое parseDateInterval(DateTimeInterface|DateInterval|целое $delay)

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

Параметры

DateTimeInterface|DateInterval|целое

$delay

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

DateTimeInterface|целое

protected целое currentTime()

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

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

целое

abstract строка getJobId()

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

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

строка

END_OF_DOCUMENT_MARKER

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

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

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

строка

пусто fire()

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

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

пусто

пусто delete()

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

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

пусто

логическое значение isDeleted()

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

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

логическое значение

пусто release(int $delay = 0)

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

Параметры

int

$delay

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

пусто

логическое значение isReleased()

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

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

логическое значение

логическое значение isDeletedOrReleased()

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

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

логическое значение

логическое значение hasFailed()

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

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

логическое значение

пусто markAsFailed()

Пометить задачу как "ошибка".

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

пусто

пусто failed(Exception $e)

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

Параметры

Exception

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

пусто

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

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

Параметры

строка

$class

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

смешанный

массив payload()

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

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

массив

int|null maxTries()

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

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

int|null

int|null timeout()

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

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

int|null

int|null timeoutAt()

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

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

int|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.7/Illuminate/Queue/Jobs/Job.html