Spec-Zone.ru › Laravel 5.1

BeanstalkdJob

class BeanstalkdJob 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 Указатель, был ли удалён обработчик задания. from Job
protected bool $released Указатель, был ли обработчик задания высвобожден. from Job
protected Pheanstalk $pheanstalk Экземпляр Pheanstalk.
protected Job $job Экземпляр задания Pheanstalk.

Методы

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)

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

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, Pheanstalk $pheanstalk, Job $job, string $queue)

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

void bury()

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

string getJobId()

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

Container getContainer()

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

Pheanstalk getPheanstalk()

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

Job getPheanstalkJob()

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

Подробности

void fire()

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

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

void

void delete()

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

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

void

bool isDeleted()

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

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

bool

void release(int $delay)

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

Параметры

int $delay

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

void

bool isReleased()

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

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

bool

bool isDeletedOrReleased()

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

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

bool
END_OF_DOCUMENT_MARKER

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, Pheanstalk $pheanstalk, Job $job, string $queue)

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

Параметры

Container $container
Pheanstalk $pheanstalk
Job $job
string $queue

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

void

void bury()

Захоронить задание в очереди.

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

void

string getJobId()

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

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

string

Container getContainer()

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

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

Container

Pheanstalk getPheanstalk()

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

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

Pheanstalk

Job getPheanstalkJob()

Получить базу задания Pheanstalk.

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

Job

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

Spec-Zone.ru

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