Spec-Zone.ru › Laravel 5.1

RedisJob

class RedisJob extends Job implements Job (View source)

Свойства

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

Методы

void fire()

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

void delete()

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

bool isDeleted()

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

from Job
void release(int $delay)

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

bool isReleased()

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

from Job
bool isDeletedOrReleased()

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

from Job
int attempts()

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

string getRawBody()

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

void resolveAndFire(array $payload)

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

from Job
array parseJob(string $job)

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

from Job
mixed resolve(string $class)

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

from Job
mixed resolveQueueableEntities(mixed $data)

Обработать все сущности очереди в заданной загрузке.

from Job
QueueableEntity resolveQueueableEntity(mixed $value)

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

from Job
void failed()

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

from Job
EntityResolver getEntityResolver()

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

from Job
int getSeconds(DateTime|int $delay)

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

from Job
int getTime()

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

from Job
string getName()

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

from Job
string getQueue()

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

from Job
void __construct(Container $container, RedisQueue $redis, string $job, string $queue)

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

string getJobId()

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

Container getContainer()

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

Database getRedisQueue()

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

string getRedisJob()

Получить базовое задание Redis.

Подробности

void fire()

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

Return Value

void

void delete()

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

Return Value

void

bool isDeleted()

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

Return Value

bool

void release(int $delay)

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

Parameters

int $delay

Return Value

void

bool isReleased()

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

Return Value

bool

bool isDeletedOrReleased()

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

Return Value

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, RedisQueue $redis, string $job, string $queue)

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

Параметры

Container $container
RedisQueue $redis
string $job
string $queue

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

void

string getJobId()

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

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

string

Container getContainer()

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

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

Container

Database getRedisQueue()

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

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

Database

string getRedisJob()

Получить базовые данные задания Redis.

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

string

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

Spec-Zone.ru

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