Работа

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

Трейты

Свойства

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

runTimeForHumans(float $startTime, float $endTime = null)

Форматирует общее время выполнения для удобочитаемости человеком.

из InteractsWithTime

string

getJobId()

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

string

getRawBody()

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

string|null

uuid()

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

void

fire()

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

void

delete()

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

bool

isDeleted()

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

void

release(int $delay = 0)

Выпустить задачу обратно в очередь через (n) секунд.

bool

isReleased()

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

bool

isDeletedOrReleased()

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

bool

hasFailed()

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

void

markAsFailed()

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

void

fail(Throwable|null $e = null)

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

void

failed(Throwable|null $e)

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

mixed

resolve(string $class)

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

mixed

getResolvedJob()

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

array

payload()

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

int|null

maxTries()

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

int|null

maxExceptions()

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

bool

shouldFailOnTimeout()

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

int|int[]|null

backoff()

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

int|null

timeout()

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

int|null

retryUntil()

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

string

getName()

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

string

resolveName()

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

string

getConnectionName()

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

string

getQueue()

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

Container

getContainer()

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

Подробное описание

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

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

Параметры

DateTimeInterface|DateInterval|int

$delay

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

int

END_OF_DOCUMENT_MARKER

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

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

Parameters

DateTimeInterface|DateInterval|int

$delay

Return Value

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

protected string runTimeForHumans(float $startTime, float $endTime = null)

Учитывая начальное время, отформатировать общее время выполнения для удобного чтения человеком.

Parameters

float	$startTime
float	$endTime

Return Value

string

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)

Вернуть задачу в очередь после (n) секунд.

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

bool shouldFailOnTimeout()

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

Return Value

bool

int|int[]|null backoff()

Количество секунд ожидания перед повторной попыткой выполнения задачи, столкнувшейся с необработанным исключением.

Return Value

int|int[]|null

int|null timeout()

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

Return Value

int|null

int|null retryUntil()

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

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

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