Spec-Zone.ru › Laravel 5.2

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 Данные сообщения очереди.

Методы

void fire()

Запустить задачу.

void delete()

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

из Job
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 resolveName()

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

из Job
string getQueue()

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

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

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

string getJobId()

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

Подробности

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

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

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

string

string getQueue()

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

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

string

void __construct(Container $container, string $payload)

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

Параметры

Container $container
string $payload

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

void

string getJobId()

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

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

string

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

Spec-Zone.ru

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