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

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

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)

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

Параметры

DateTimeInterface|DateInterval|int

$delay

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

int

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

Получить метку времени «доступно в».

Параметры

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

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

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