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 «доступно в».

из InteractsWithTime

DateTimeInterface|int

parseDateInterval(DateTimeInterface|DateInterval|int $delay)

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

из InteractsWithTime

int

currentTime()

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

из InteractsWithTime

string

getJobId()

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

string

getRawBody()

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

string|null

uuid()

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

из Job

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

maxExceptions()

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

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

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

Details

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

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

Parameters

DateTimeInterface|DateInterval|int

$delay

Return Value

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)

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

Параметры

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

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

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

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