Spec-Zone.ru › Laravel 5.3

IronJob

class IronJob 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 IronQueue $iron Экземпляр очереди Iron.
protected object $job Экземпляр сообщения IronMQ.
protected bool $pushed Указывает, было ли сообщение сообщением push.

Методы

void fire()

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

void delete()

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

bool isDeleted()

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

из Job
void release(int $delay)

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

bool isReleased()

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

из Job
bool isDeletedOrReleased()

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

из Job
int attempts()

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

string getRawBody()

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

void resolveAndFire(array $payload)

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

из Job
array parseJob(string $job)

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

из Job
mixed resolve(string $class)

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

из Job
mixed resolveQueueableEntities(mixed $data)

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

из Job
QueueableEntity resolveQueueableEntity(mixed $value)

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

из Job
void failed()

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

из Job
EntityResolver getEntityResolver()

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

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

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

из Job
int getTime()

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

из Job
string getName()

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

из Job
string getQueue()

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

void __construct(Container $container, IronQueue $iron, object $job, bool $pushed = false)

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

void recreateJob(int $delay)

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

string getJobId()

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

Container getContainer()

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

IronQueue getIron()

Получить базовый экземпляр очереди Iron.

array getIronJob()

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

Подробности

void fire()

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

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

void

void delete()

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

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

void

bool isDeleted()

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

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

bool

void release(int $delay)

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

Параметры

int $delay

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

void

bool isReleased()

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

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

bool

bool isDeletedOrReleased()

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

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

bool

int attempts()

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

Значение результата

int

string getRawBody()

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

Значение результата

string

protected void resolveAndFire(array $payload)

Обработать и запустить обработчик задачи.

Параметры

array $payload

Значение результата

void

protected array parseJob(string $job)

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

Параметры

string $job

Значение результата

array

protected mixed resolve(string $class)

Обработка заданного обработчика задач.

Параметры

string $class

Значение результата

mixed

protected mixed resolveQueueableEntities(mixed $data)

Обработка всех сущностей очереди в заданном наборе данных.

Параметры

mixed $data

Значение результата

mixed

protected QueueableEntity resolveQueueableEntity(mixed $value)

Обработка одной сущности очереди из решателя.

Параметры

mixed $value

Значение результата

QueueableEntity

void failed()

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

Значение результата

void

protected EntityResolver getEntityResolver()

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

Значение результата

EntityResolver

protected int getSeconds(DateTime|int $delay)

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

Параметры

DateTime|int $delay

Значение результата

int

protected int getTime()

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

Значение результата

int

string getName()

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

Значение результата

string

string getQueue()

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

Значение результата

string

void __construct(Container $container, IronQueue $iron, object $job, bool $pushed = false)

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

Параметры

Container $container
IronQueue $iron
object $job
bool $pushed

Значение результата

void

protected void recreateJob(int $delay)

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

Параметры

int $delay

Значение результата

void

string getJobId()

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

Значение результата

string

Container getContainer()

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

Значение результата

Container

IronQueue getIron()

Получить базовый экземпляр очереди Iron.

Значение результата

IronQueue

array getIronJob()

Получить базу данных задачи IronMQ.

Значение результата

array

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

Spec-Zone.ru

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