PHP Класс UrbanIndo\Yii2\Queue\Queues\MultipleQueue

С версии: 2015.02.25
Автор: Petra Barus ([email protected])
Наследование: extends UrbanIndo\Yii2\Queue\Queue
Показать файл Открыть проект

Открытые свойства

Свойство Тип Описание
$queues UrbanIndo\Yii2\Queue\Queue[] Stores the queue.
$strategy UrbanIndo\Yii2\Queue\Strategies\Strategy The job fetching strategy.

Открытые методы

Метод Описание
getQueue ( integer $index ) : Queue | null
getSize ( ) : integer Returns the total number of all queue size.
init ( ) : void Initialize the queue.
postToQueue ( UrbanIndo\Yii2\Queue\Job &$job, integer $index ) : boolean Post new job to a specific queue.
purge ( ) : boolean Purge the whole queue.

Защищенные методы

Метод Описание
deleteJob ( UrbanIndo\Yii2\Queue\Job $job ) : boolean Delete the job.
fetchJob ( ) : UrbanIndo\Yii2\Queue\Job | boolean Return next job from the queue.
postJob ( UrbanIndo\Yii2\Queue\Job $job ) : boolean Post new job to the queue.
releaseJob ( UrbanIndo\Yii2\Queue\Job $job ) : boolean Release the job.

Описание методов

deleteJob() защищенный Метод

Delete the job.
protected deleteJob ( UrbanIndo\Yii2\Queue\Job $job ) : boolean
$job UrbanIndo\Yii2\Queue\Job The job.
Результат boolean Whether the operation succeed.

fetchJob() защищенный Метод

Return next job from the queue.
protected fetchJob ( ) : UrbanIndo\Yii2\Queue\Job | boolean
Результат UrbanIndo\Yii2\Queue\Job | boolean The job fetched or false if not found.

getQueue() публичный Метод

public getQueue ( integer $index ) : Queue | null
$index integer The index of the queue.
Результат UrbanIndo\Yii2\Queue\Queue | null the queue or null if not exists.

getSize() публичный Метод

Returns the total number of all queue size.
public getSize ( ) : integer
Результат integer

init() публичный Метод

Initialize the queue.
public init ( ) : void
Результат void

postJob() защищенный Метод

Post new job to the queue.
protected postJob ( UrbanIndo\Yii2\Queue\Job $job ) : boolean
$job UrbanIndo\Yii2\Queue\Job The job.
Результат boolean Whether operation succeed.

postToQueue() публичный Метод

Post new job to a specific queue.
public postToQueue ( UrbanIndo\Yii2\Queue\Job &$job, integer $index ) : boolean
$job UrbanIndo\Yii2\Queue\Job The job.
$index integer The queue index.
Результат boolean Whether operation succeed.

purge() публичный Метод

Purge the whole queue.
public purge ( ) : boolean
Результат boolean

releaseJob() защищенный Метод

Release the job.
protected releaseJob ( UrbanIndo\Yii2\Queue\Job $job ) : boolean
$job UrbanIndo\Yii2\Queue\Job The job to release.
Результат boolean whether the operation succeed.

Описание свойств

$queues публичное свойство

Stores the queue.
public Queue[],UrbanIndo\Yii2\Queue $queues
Результат UrbanIndo\Yii2\Queue\Queue[]

$strategy публичное свойство

The job fetching strategy.
public Strategy,UrbanIndo\Yii2\Queue\Strategies $strategy
Результат UrbanIndo\Yii2\Queue\Strategies\Strategy