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.

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)

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

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

Получить количество секунд до заданной даты 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.

Параметры

DateTimeInterface|DateInterval|int

$delay

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

DateTimeInterface|int

protected int currentTime()

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

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

int

string getJobId()

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

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

string

string getRawBody()

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

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

string

string|null uuid()

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

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

string|null

void fire()

Запустить задание.

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

void

void delete()

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

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

void

bool isDeleted()

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

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

bool

void release(int $delay = 0)

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

Параметры

int

$delay

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

void

bool isReleased()

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

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

bool

bool isDeletedOrReleased()

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

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

bool

bool hasFailed()

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

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

bool

void markAsFailed()

Пометить задание как "не выполненное".

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

void

void fail(Throwable|null $e = null)

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

Параметры

Throwable|null

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

void

protected void failed(Throwable|null $e)

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

Параметры

Throwable|null

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

void

protected mixed resolve(string $class)

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

Параметры

string

$class

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

mixed

mixed getResolvedJob()

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

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

mixed

array payload()

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

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

array

int|null maxTries()

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

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

int|null

int|null maxExceptions()

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

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

int|null

bool shouldFailOnTimeout()

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

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

bool

int|int[]|null backoff()

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

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

int|int[]|null

int|null timeout()

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

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

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/10.x/Illuminate/Queue/Jobs/DatabaseJob.html