PHP Class UrbanIndo\Yii2\Queue\Queues\DummyQueue

Inheritance: extends UrbanIndo\Yii2\Queue\Queue
Show file Open project: urbanindo/yii2-queue

Public Methods

Method Description
getSize ( ) : integer Returns the number of queue size.
purge ( ) : boolean Purge the whole queue.

Protected Methods

Method Description
deleteJob ( UrbanIndo\Yii2\Queue\Job $job ) : boolean Delete the job. Override this for the queue implementation.
fetchJob ( ) : UrbanIndo\Yii2\Queue\Job | boolean Return next job from the queue. Override this for queue implementation.
postJob ( UrbanIndo\Yii2\Queue\Job $job ) : boolean Post new job to the queue.
releaseJob ( UrbanIndo\Yii2\Queue\Job $job ) : boolean Release the job. Override this for the queue implementation.

Method Details

deleteJob() protected method

Delete the job. Override this for the queue implementation.
protected deleteJob ( UrbanIndo\Yii2\Queue\Job $job ) : boolean
$job UrbanIndo\Yii2\Queue\Job The job to delete.
return boolean whether the operation succeed.

fetchJob() protected method

Return next job from the queue. Override this for queue implementation.
protected fetchJob ( ) : UrbanIndo\Yii2\Queue\Job | boolean
return UrbanIndo\Yii2\Queue\Job | boolean the job or false if not found.

getSize() public method

Returns the number of queue size.
public getSize ( ) : integer
return integer

postJob() protected method

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.

purge() public method

Purge the whole queue.
public purge ( ) : boolean
return boolean

releaseJob() protected method

Release the job. Override this for the queue implementation.
protected releaseJob ( UrbanIndo\Yii2\Queue\Job $job ) : boolean
$job UrbanIndo\Yii2\Queue\Job The job to release.
return boolean whether the operation succeed.