Задание

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

Свойства

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

Методы

int

secondsUntil(DateTimeInterface|DateInterval|int $delay)

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

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

int

availableAt(DateTimeInterface|DateInterval|int $delay)

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

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

DateTimeInterface|int

parseDateInterval(DateTimeInterface|DateInterval|int $delay)

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

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

int

currentTime()

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

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

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()

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

Контейнер

getContainer()

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

Подробности

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

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

Параметры

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 getRawBody()

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

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

string

void fire()

Выполнить задание.

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

void

void delete()

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

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

void

bool isDeleted()

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

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

bool

void release(int $delay)

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

Параметры

int

$delay

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

void

bool isReleased()

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

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

bool

bool isDeletedOrReleased()

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

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

bool

bool hasFailed()

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

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

bool

void markAsFailed()

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

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

void

void failed(Exception $e)

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

Параметры

Exception

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

void

protected mixed resolve(string $class)

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

Параметры

string

$class

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

mixed

array payload()

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

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

array

int|null maxTries()

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

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

int|null

int|null timeout()

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

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

int|null

int|null timeoutAt()

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

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

int|null

string getName()

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

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

string

string resolveName()

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

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

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

string

string getConnectionName()

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

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

string

string getQueue()

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

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

string

Container getContainer()

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

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

Container

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