Задача

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

Трейты

Свойства

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

Методы

int

secondsUntil(DateTimeInterface|DateInterval|int $delay)

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

из InteractsWithTime

int

availableAt(DateTimeInterface|DateInterval|int $delay = 0)

Получить отметку времени «доступно в» в формате 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 = 0)

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

bool

isReleased()

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

bool

isDeletedOrReleased()

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

bool

hasFailed()

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

void

markAsFailed()

Отметить задачу как «не выполненную».

void

fail(Throwable|null $e = null)

Удалить задачу, вызвать метод «не выполненная», и вызвать событие не выполненной задачи.

void

failed(Throwable|null $e)

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

mixed

resolve(string $class)

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

mixed

getResolvedJob()

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

array

payload()

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

int|null

maxTries()

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

int|null

delaySeconds()

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

int|null

timeout()

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

int|null

timeoutAt()

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

string

getName()

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

string

resolveName()

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

string

getConnectionName()

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

string

getQueue()

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

Container

getContainer()

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

Подробности

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

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

Parameters

DateTimeInterface|DateInterval|int

$delay

Return Value

int

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

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

Parameters

DateTimeInterface|DateInterval|int

$delay

Return Value

int

END_OF_DOCUMENT_MARKER

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

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

Parameters

DateTimeInterface|DateInterval|int

$delay

Return Value

DateTimeInterface|int

protected int currentTime()

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

Return Value

int

abstract string getJobId()

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

Return Value

string

abstract string getRawBody()

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

Return Value

string

void fire()

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

Return Value

void

void delete()

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

Return Value

void

bool isDeleted()

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

Return Value

bool

void release(int $delay = 0)

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

Parameters

int

$delay

Return Value

void

bool isReleased()

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

Return Value

bool

bool isDeletedOrReleased()

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

Return Value

bool

bool hasFailed()

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

Return Value

bool

void markAsFailed()

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

Return Value

void

void fail(Throwable|null $e = null)

Удалить задачу, вызвать метод "failed" и сгенерировать событие неудачной задачи.

Parameters

Throwable|null

Return Value

void

protected void failed(Throwable|null $e)

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

Parameters

Throwable|null

Return Value

void

protected mixed resolve(string $class)

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

Parameters

string

$class

Return Value

mixed

mixed getResolvedJob()

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

Return Value

mixed

array payload()

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

Return Value

array

int|null maxTries()

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

Return Value

int|null

int|null delaySeconds()

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

Return Value

int|null

int|null timeout()

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

Return Value

int|null

int|null timeoutAt()

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

Return Value

int|null

string getName()

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

Return Value

string

string resolveName()

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

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

Return Value

string

string getConnectionName()

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

Return Value

string

string getQueue()

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

Return Value

string

Container getContainer()

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

Return Value

Container

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