PHP Class UrbanIndo\Yii2\Queue\Queues\MultipleQueue

Since: 2015.02.25

Author: Petra Barus ([email protected])

Inheritance: extends UrbanIndo\Yii2\Queue\Queue

Public Properties

Property	Type	Description
$queues	UrbanIndo\Yii2\Queue\Queue[]	Stores the queue.
$strategy	UrbanIndo\Yii2\Queue\Strategies\Strategy	The job fetching strategy.

Method	Description
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.

Method	Description
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.

Delete the job.

protected deleteJob ( UrbanIndo\Yii2\Queue\Job $job ) : boolean
$job	UrbanIndo\Yii2\Queue\Job	The job.
return	boolean	Whether the operation succeed.

Return next job from the queue.

protected fetchJob ( ) : UrbanIndo\Yii2\Queue\Job \| boolean
return	UrbanIndo\Yii2\Queue\Job \| boolean	The job fetched or false if not found.

public getQueue ( integer $index ) : Queue \| null
$index	integer	The index of the queue.
return	UrbanIndo\Yii2\Queue\Queue \| null	the queue or null if not exists.

Returns the total number of all queue size.

public getSize ( ) : integer
return	integer

Initialize the queue.

public init ( ) : void
return	void

Post new job to the queue.

protected postJob ( UrbanIndo\Yii2\Queue\Job $job ) : boolean
$job	UrbanIndo\Yii2\Queue\Job	The job.
return	boolean	Whether operation succeed.

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.
return	boolean	Whether operation succeed.

Purge the whole queue.

public purge ( ) : boolean
return	boolean

Release the job.

protected releaseJob ( UrbanIndo\Yii2\Queue\Job $job ) : boolean
$job	UrbanIndo\Yii2\Queue\Job	The job to release.
return	boolean	whether the operation succeed.

Stores the queue.

public Queue[],UrbanIndo\Yii2\Queue $queues
return	UrbanIndo\Yii2\Queue\Queue[]

The job fetching strategy.

public Strategy,UrbanIndo\Yii2\Queue\Strategies $strategy
return	UrbanIndo\Yii2\Queue\Strategies\Strategy