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.	из 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 задания.	из Job
void	fire() Запустить задание.	из Job
void	delete() Удалить задание из очереди.
bool	isDeleted() Определить, было ли задание удалено.	из Job
void	release(int $delay = 0) Вернуть задание обратно в очередь через (n) секунд.
bool	isReleased() Определить, было ли задание возвращено обратно в очередь.	из Job
bool	isDeletedOrReleased() Определить, было ли задание удалено или возвращено обратно в очередь.	из Job
bool	hasFailed() Определить, было ли задание помечено как неисправное.	из Job
void	markAsFailed() Пометить задание как "неисправное".	из Job
void	fail(Throwable\|null $e = null) Удалить задание, вызвать метод "неисправно" и поднять событие о неисправном задании.	из Job
void	failed(Throwable\|null $e) Обработать исключение, из-за которого задание не удалось выполнить.	из Job
mixed	resolve(string $class) Разрешить указанный класс.	из Job
mixed	getResolvedJob() Получить разрешённую экземпляр обработчика заданий.	из Job
array	payload() Получить декодированное тело задания.	из Job
int\|null	maxTries() Получить количество попыток выполнения задания.	из Job
int\|null	maxExceptions() Получить количество попыток выполнения задания после исключения.	из Job
bool	shouldFailOnTimeout() Определить, должно ли задание не удаться при истечении времени ожидания.	из Job
int\|int[]\|null	backoff() Количество секунд ожидания перед повторной попыткой выполнения задания, столкнувшегося с неуловленным исключением.	из Job
int\|null	timeout() Получить количество секунд, которое может выполняться задание.	из Job
int\|null	retryUntil() Получить отметку времени, до которой задание должно иметь возможность выполняться.	из Job
string	getName() Получить имя класса очереди задания.	из Job
string	resolveName() Получить разрешённое имя класса очереди задания.	из Job
string	getConnectionName() Получить имя подключения, к которому относится задание.	из Job
string	getQueue() Получить имя очереди, к которой относится задание.	из Job
Container	getContainer() Получить экземпляр контейнера сервисов.	из Job
void	__construct(Container $container, DatabaseQueue $database, stdClass $job, string $connectionName, string $queue) Создать новый экземпляр задания.
int	attempts() Получить количество попыток выполнения задания.

DatabaseJobRecord

getJobRecord()

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

Подробности

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

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

Параметры

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

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

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

Параметры

float	$startTime
float	$endTime

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

string

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