Spec-Zone.ru › Laravel 4.2

IronJob

class IronJob extends Job (View source)

Свойства

protected mixed $instance Экземпляр обработчика задания. из Job
protected Container $container Экземпляр контейнера IoC. из Job
protected string $queue Имя очереди, к которой принадлежит задание. из Job
protected bool $deleted Указывает, было ли задание удалено. из Job
protected IronQueue $iron Экземпляр очереди Iron.
protected object $job Экземпляр сообщения IronMQ.
protected bool $pushed Указывает, было ли сообщение отправлено в виде push.

Методы

void fire()

Запустить задание.

void delete()

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

bool isDeleted()

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

из Job
void release(int $delay)

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

int attempts()

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

string getRawBody()

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

void resolveAndFire(array $payload)

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

из Job
mixed resolve(string $class)

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

из Job
array parseJob(string $job)

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

из Job
bool autoDelete()

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

из 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
END_OF_DOCUMENT_MARKER

bool isDeleted()

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

Значение возврата

bool

void release(int $delay)

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

Параметры

int $delay

Значение возврата

void

int attempts()

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

Значение возврата

int

string getRawBody()

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

Значение возврата

string

protected void resolveAndFire(array $payload)

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

Параметры

array $payload

Значение возврата

void

protected mixed resolve(string $class)

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

Параметры

string $class

Значение возврата

mixed

protected array parseJob(string $job)

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

Параметры

string $job

Значение возврата

array

bool autoDelete()

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

Значение возврата

bool

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

Spec-Zone.ru

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