Spec-Zone.ru › Laravel 5.1

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)

Возвращение отправленного задания обратно в очередь.

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)

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

Параметры

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()

Получить базовый job IronMQ.

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

array

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

Spec-Zone.ru

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