Class zhuravljov\yii\queue\sync\Driver

All Classes | Properties | Methods
Inheritancezhuravljov\yii\queue\sync\Driver » zhuravljov\yii\queue\BaseDriver » yii\base\Object
Source Code https://github.com/yiisoft/yii2-queue/blob/master/src/sync/Driver.php

Class SyncDriver

Public Properties

Hide inherited properties

Property Type Description Defined By
$queue zhuravljov\yii\queue\Queue zhuravljov\yii\queue\BaseDriver

Public Methods

Hide inherited methods

Method Description Defined By
__construct() zhuravljov\yii\queue\BaseDriver
init() zhuravljov\yii\queue\sync\Driver
pop() Pops message and job from the storage. zhuravljov\yii\queue\sync\Driver
purge() Purges the storage. zhuravljov\yii\queue\sync\Driver
push() Pushes job to the storage. zhuravljov\yii\queue\sync\Driver
release() Releases the message. zhuravljov\yii\queue\sync\Driver

Protected Methods

Hide inherited methods

Method Description Defined By
getQueue() zhuravljov\yii\queue\BaseDriver

Method Details

Hide inherited methods

__construct() public method

Defined in: zhuravljov\yii\queue\BaseDriver::__construct()

public __construct ( zhuravljov\yii\queue\Queue $queue, mixed $config = [] )
$queue zhuravljov\yii\queue\Queue
$config mixed 

                public function __construct(Queue $queue, $config = [])
{
    $this->_queue = $queue;
    parent::__construct($config);
}
getQueue() protected method

Defined in: zhuravljov\yii\queue\BaseDriver::getQueue()

protected zhuravljov\yii\queue\Queue getQueue ( )

                protected function getQueue()
{
    return $this->_queue;
}
init() public method

public mixed init ( )

                public function init()
{
    parent::init();
    Yii::$app->on(Application::EVENT_AFTER_REQUEST, function () {
        Yii::info('Worker has been started.', __CLASS__);
        ob_start();
        $count = 0;
        while ($this->getQueue()->work(false)) {
            $count++;
        }
        Yii::trace(ob_get_clean(), __CLASS__);
        Yii::info("$count jobs have been complete.", __CLASS__);
    });
}
pop() public method

Pops message and job from the storage.

public boolean pop ( mixed &$message, mixed &$job )
$message mixed
$job mixed 

                public function pop(&$message, &$job)
{
    $message = array_shift($this->_messages);
    if ($message !== null) {
        $job = unserialize($message);
        return true;
    } else {
        return false;
    }
}
purge() public method

Purges the storage.

public mixed purge ( )

                public function purge()
{
    $this->_messages = [];
}
push() public method

Pushes job to the storage.

public mixed push ( mixed $job )
$job mixed
return mixed

$message

 

                public function push($job)
{
    $this->_messages[] = serialize($job);
}
release() public method

Releases the message.

public mixed release ( mixed $message )
$message mixed 

                public function release($message)
{
}