DatabaseJob

class DatabaseJob extends Job implements Job (View source)

Трейты

Свойства

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

Методы

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.

из InteractsWithTime

string

getJobId()

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

string

getRawBody()

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

void

fire()

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

из Job

void

delete()

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

bool

isDeleted()

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

из Job

void

release(int $delay = 0)

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

bool

isReleased()

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

из Job

bool

isDeletedOrReleased()

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

из Job

bool

hasFailed()

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

из Job

void

markAsFailed()

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

из Job

void

fail(Throwable|null $e = null)

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

из Job

void

failed(Throwable|null $e)

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

из Job

mixed

resolve(string $class)

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

из Job

mixed

getResolvedJob()

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

из Job

array

payload()

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

из Job

int|null

maxTries()

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

из Job

int|null

delaySeconds()

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

из Job

int|null

timeout()

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

из Job

int|null

timeoutAt()

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

из 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()

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

Подробности

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

void fire()

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

Значение, возвращаемое функцией

void

void delete()

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

Значение, возвращаемое функцией

void

bool isDeleted()

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

Значение, возвращаемое функцией

bool

void release(int $delay = 0)

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

Параметры

int

$delay

Значение, возвращаемое функцией

void

bool isReleased()

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

Значение, возвращаемое функцией

bool

bool isDeletedOrReleased()

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

Значение, возвращаемое функцией

bool

bool hasFailed()

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

Значение, возвращаемое функцией

bool

void markAsFailed()

Пометить задачу как «неудачная».

Значение, возвращаемое функцией

void

void fail(Throwable|null $e = null)

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

Параметры

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

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

Значение, возвращаемое функцией

int|null

int|null timeout()

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

Значение, возвращаемое функцией

int|null

int|null timeoutAt()

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

Значение, возвращаемое функцией

int|null

string getName()

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

Значение, возвращаемое функцией

string

string resolveName()

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

Разрешает имя «упакованных» задач, таких как обработчики на основе классов.

Значение, возвращаемое функцией

string

string getConnectionName()

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

Значение, возвращаемое функцией

string

string getQueue()

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

Значение, возвращаемое функцией

string

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

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

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

Контейнер

void __construct(Контейнер $container, DatabaseQueue $database, stdClass $job, string $connectionName, string $queue)

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

Параметры

Контейнер	$container
DatabaseQueue	$database
stdClass	$job
string	$connectionName
string	$queue

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

void

int attempts()

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

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

int

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