Class zhuravljov\yii\queue\redis\Driver

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

Redis Driver

Public Properties

Hide inherited properties

Property Type Description Defined By
$prefix string zhuravljov\yii\queue\redis\Driver
$queue zhuravljov\yii\queue\Queue zhuravljov\yii\queue\Driver
$redis \yii\redis\Connection|array|string zhuravljov\yii\queue\redis\Driver

Public Methods

Hide inherited methods

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

Protected Methods

Hide inherited methods

Method Description Defined By
getKey() zhuravljov\yii\queue\redis\Driver
getQueue() zhuravljov\yii\queue\Driver

Property Details

Hide inherited properties

$prefix public property
public string $prefix = ''
$redis public property
public \yii\redis\Connection|array|string $redis = 'redis'

Method Details

Hide inherited methods

__construct() public method

Defined in: zhuravljov\yii\queue\Driver::__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);
}
bootstrap() public method

public bootstrap ( mixed $app )
$app mixed 

                public function bootstrap($app)
{
    if ($app instanceof \yii\console\Application) {
        $app->controllerMap[$this->queue->id] = [
            'class' => Command::class,
            'queue' => $this->queue,
        ];
    }
}
getKey() protected method

protected string getKey ( )

                protected function getKey()
{
    return $this->prefix . $this->queue->id;
}
getQueue() protected method

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

protected zhuravljov\yii\queue\Queue getQueue ( )

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

public init ( )

                public function init()
{
    parent::init();
    $this->redis = Instance::ensure($this->redis, Connection::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 = $this->redis->executeCommand('LPOP', [$this->getKey()]);
    if ($message !== null) {
        $job = unserialize($message);
        return true;
    } else {
        return false;
    }
}
purge() public method

Purges the storage.

public mixed purge ( )

                public function purge()
{
    $this->redis->executeCommand('DEL', [$this->getKey()]);
}
push() public method

Pushes job to the storage.

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

$message

 

                public function push($job)
{
    $message = serialize($job);
    $this->redis->executeCommand('RPUSH', [$this->getKey(), $message]);
    return $message;
}
release() public method

Releases the message.

public mixed release ( mixed $message )
$message mixed 

                public function release($message)
{
}