Spec-Zone.ru › Laravel 5.7

DatabaseJob

class DatabaseJob extends Job implements Job (View source)

Трейты

InteractsWithTime

Свойства

protected mixed $instance Экземпляр обработчика задачи. из Job
protected Container $container Экземпляр контейнера IoC. из Job
protected bool $deleted Указывает, была ли задача удалена. из Job
protected bool $released Указывает, была ли задача освобождена. из Job
protected bool $failed Указывает, произошла ли ошибка в задаче. из Job
protected $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 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 failed(Exception $e)

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

из Job
mixed resolve(string $class)

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

из Job
array payload()

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

из Job
int|null maxTries()

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

из 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 failed(Exception $e)

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

Параметры

Exception $e

Значение возвращаемого значения

void

protected mixed resolve(string $class)

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

Параметры

string $class

Значение возвращаемого значения

mixed

array payload()

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

Значение возвращаемого значения

array

int|null maxTries()

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

Значение возвращаемого значения

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API