Задача

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

Трейты

Свойства

protected mixed	$instance	Экземпляр обработчика задачи.
protected Контейнер	$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 для "доступности".

из InteractsWithTime

DateTimeInterface|int

parseDateInterval(DateTimeInterface|DateInterval|int $delay)

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

из InteractsWithTime

int

currentTime()

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

из InteractsWithTime

string

getJobId()

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

string

getRawBody()

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

string|null

uuid()

Получить UUID задания.

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)

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

void

failed(Throwable|null $e)

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

mixed

resolve(string $class)

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

mixed

getResolvedJob()

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

array

payload()

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

int|null

maxTries()

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

int|null

maxExceptions()

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

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.

Параметры

DateTimeInterface|DateInterval|int

$delay

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

int

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

Получить метку времени UNIX для "доступности".

Параметры

DateTimeInterface|DateInterval|int

$delay

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

int

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

string|null uuid()

Получить UUID задания.

Return Value

string|null

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

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

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

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

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

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

Контейнер

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