DatabaseJob

class DatabaseJob extends Job implements Job (View source)

Трейты

Свойства

protected mixed	$instance	Экземпляр обработчика задания.	из Job
protected Container	$container	Экземпляр контейнера IoC.	из Job
protected bool	$deleted	Указывает, было ли задание удалено.	из Job
protected bool	$released	Указывает, было ли задание выпущено.	из Job
protected bool	$failed	Указывает, потерпело ли задание неудачу.	из Job
protected string	$connectionName	Имя соединения, к которому принадлежит задание.	из Job
protected string	$queue	Имя очереди, к которой принадлежит задание.	из Job
protected DatabaseQueue	$database	Экземпляр очереди базы данных.
protected stdClass	$job	Загрузка задания базы данных.

Методы

int

secondsUntil(DateTimeInterface|DateInterval|int $delay)

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

from InteractsWithTime

int

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

Получить метку времени UNIX "available at".

from InteractsWithTime

DateTimeInterface|int

parseDateInterval(DateTimeInterface|DateInterval|int $delay)

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

from InteractsWithTime

int

currentTime()

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

from InteractsWithTime

string

getJobId()

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

string

getRawBody()

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

string|null

uuid()

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

from Job

void

fire()

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

from Job

void

delete()

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

bool

isDeleted()

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

from Job

void

release(int $delay = 0)

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

bool

isReleased()

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

from Job

bool

isDeletedOrReleased()

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

from Job

bool

hasFailed()

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

from Job

void

markAsFailed()

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

from Job

void

fail(Throwable|null $e = null)

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

from Job

void

failed(Throwable|null $e)

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

from Job

mixed

resolve(string $class)

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

from Job

mixed

getResolvedJob()

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

from Job

array

payload()

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

from Job

int|null

maxTries()

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

from Job

int|null

maxExceptions()

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

from Job

bool

shouldFailOnTimeout()

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

from Job

int|null

backoff()

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

from Job

int|null

timeout()

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

from Job

int|null

retryUntil()

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

from Job

string

getName()

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

from Job

string

resolveName()

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

from Job

string

getConnectionName()

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

from Job

string

getQueue()

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

from Job

Container

getContainer()

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

from Job

void

__construct(Container $container, DatabaseQueue $database, stdClass $job, string $connectionName, string $queue)

Создать новый экземпляр задачи.

int

attempts()

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

DatabaseJobRecord

getJobRecord()

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

Подробности

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

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

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

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

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

Parameters

DateTimeInterface|DateInterval|int

$delay

Return Value

DateTimeInterface|int

protected int currentTime()

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

Return Value

int

string getJobId()

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

Return Value

string

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

bool shouldFailOnTimeout()

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

Return Value

bool

int|null backoff()

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

Return Value

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

void __construct(Container $container, DatabaseQueue $database, stdClass $job, string $connectionName, string $queue)

Создать новый экземпляр задачи.

Параметры

Container	$container
DatabaseQueue	$database
stdClass	$job
string	$connectionName
string	$queue

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

void

int attempts()

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

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

int

DatabaseJobRecord getJobRecord()

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

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

DatabaseJobRecord

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