Spec-Zone.ru › Laravel 5.4

Работа

класс Работа (Просмотреть исходный код)

Трейты

InteractsWithTime

Свойства

protected mixed $instance Экземпляр обработчика задачи.
protected Container $container Экземпляр контейнера IoC.
protected bool $deleted Указывает, была ли задача удалена.
protected bool $released Указывает, была ли задача выпущена.
protected bool $failed Указывает, произошла ли ошибка в задаче.
protected $connectionName Имя соединения, к которому принадлежит задача.
protected string $queue Имя очереди, к которой принадлежит задача.

Методы

int secondsUntil(DateTimeInterface $delay)

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

from InteractsWithTime
int availableAt(DateTimeInterface|int $delay)

Получить отметку времени "доступно в" в формате UNIX.

from InteractsWithTime
int currentTime()

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

from InteractsWithTime
void fire()

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

void delete()

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

bool isDeleted()

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

void release(int $delay)

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

bool isReleased()

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

bool isDeletedOrReleased()

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

bool hasFailed()

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

void markAsFailed()

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

void failed(Exception $e)

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

mixed resolve(string $class)

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

array payload()

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

int|null maxTries()

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

int|null timeout()

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

string getName()

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

string resolveName()

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

string getConnectionName()

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

string getQueue()

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

Container getContainer()

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

Details

protected int secondsUntil(DateTimeInterface $delay)

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

Parameters

DateTimeInterface $delay

Return Value

int

protected int availableAt(DateTimeInterface|int $delay)

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

Параметры

DateTimeInterface|int $delay

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

int

protected int currentTime()

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

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

int

void fire()

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

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

void

void delete()

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

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

void

bool isDeleted()

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

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

bool

void release(int $delay)

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

Параметры

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

string getName()

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

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

string

string resolveName()

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

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

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

string

string getConnectionName()

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

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

string

string getQueue()

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

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

string

Container getContainer()

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

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

Container

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

Spec-Zone.ru

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