Spec-Zone.ru › Laravel 5.3

SyncJob

class SyncJob extends Job implements Job (View source)

Свойства

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

Методы

int attempts()

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

string getRawBody()

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

void fire()

Выполнить задачу.

из Job
mixed resolve(string $class)

Обработать указанный обработчик задач.

из Job
void delete()

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

из Job
bool isDeleted()

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

из Job
void release(int $delay)

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

bool isReleased()

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

из Job
bool isDeletedOrReleased()

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

из Job
void failed(Exception $e)

Вызвать метод failed для экземпляра задачи.

из Job
array parseJob(string $job)

Разбор объявления задачи на класс и метод.

из Job
int getSeconds(DateTime|int $delay)

Вычисление количества секунд с заданной задержкой.

из Job
int getTime()

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

из Job
string getName()

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

из Job
string resolveName()

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

из Job
array payload()

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

из Job
string getQueue()

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

Container getContainer()

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

из Job
void __construct(Container $container, string $payload, string $queue)

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

string getJobId()

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

Подробности

int attempts()

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

Значение

int

string getRawBody()

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

Значение

string

void fire()

Выполнить задачу.

Значение

void

protected mixed resolve(string $class)

Обработать указанный обработчик задач.

Параметры

string $class

Значение

mixed

void delete()

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

Значение

void

bool isDeleted()

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

Значение

bool

void release(int $delay)

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

Параметры

int $delay

Значение

void

bool isReleased()

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

Значение

bool

bool isDeletedOrReleased()

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

Значение

bool

void failed(Exception $e)

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

Параметры

Exception $e

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

void

protected array parseJob(string $job)

Разбор объявления задания на класс и метод.

Параметры

string $job

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

array

protected int getSeconds(DateTime|int $delay)

Вычисление количества секунд с заданной задержкой.

Параметры

DateTime|int $delay

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

int

protected int getTime()

Получение текущего системного времени.

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

int

string getName()

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

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

string

string resolveName()

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

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

string

array payload()

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

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

array

string getQueue()

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

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

string

Container getContainer()

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

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

Container

void __construct(Container $container, string $payload, string $queue)

Создание нового экземпляра задания.

Параметры

Container $container
string $payload
string $queue

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

void

string getJobId()

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

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

string

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

Spec-Zone.ru

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