Class zhuravljov\yii\queue\Queue

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

Class Queue

Public Properties

Hide inherited properties

Property Type Description Defined By
$driver zhuravljov\yii\queue\BaseDriver|array|string zhuravljov\yii\queue\Queue
$id string of component zhuravljov\yii\queue\Queue

Public Methods

Hide inherited methods

Method Description Defined By
bootstrap() zhuravljov\yii\queue\Queue
getId() zhuravljov\yii\queue\Queue
init() zhuravljov\yii\queue\Queue
purge() Purges the queue zhuravljov\yii\queue\Queue
push() zhuravljov\yii\queue\Queue
work() zhuravljov\yii\queue\Queue

Constants

Hide inherited constants

Constant Value Description Defined By
EVENT_ON_POP 'onPop' zhuravljov\yii\queue\Queue
EVENT_ON_PUSH 'onPush' zhuravljov\yii\queue\Queue
EVENT_ON_RELEASE 'onRelease' zhuravljov\yii\queue\Queue

Property Details

Hide inherited properties

$driver public property
public zhuravljov\yii\queue\BaseDriver|array|string $driver = []
$id public property

of component

public string $id = null

Method Details

Hide inherited methods

bootstrap() public method

public bootstrap ( mixed $app )
$app mixed 

                public function bootstrap($app)
{
    if ($this->driver instanceof BootstrapInterface) {
        $this->driver->bootstrap($app);
    }
}
getId() public method

public string getId ( )
return string

Component id

 

                public function getId()
{
    foreach (Yii::$app->getComponents(false) as $id => $component) {
        if ($component === $this) {
            return $id;
        }
    }
    return null;
}
init() public method

public init ( )

                public function init()
{
    parent::init();
    $this->driver = Yii::createObject($this->driver, [$this]);
}
purge() public method

Purges the queue

public mixed purge ( )

                public function purge()
{
    $this->driver->purge();
}
push() public method

public mixed push ( zhuravljov\yii\queue\Job $job )
$job zhuravljov\yii\queue\Job 

                public function push(Job $job)
{
    $this->driver->push($job);
    $this->trigger(self::EVENT_ON_PUSH, new Event(['job' => $job]));
}
work() public method

public boolean work ( boolean $throw = true )
$throw boolean 

                public function work($throw = true)
{
    if ($this->driver->pop($message, $job)) {
        $this->trigger(self::EVENT_ON_POP, new Event(['job' => $job]));
        try {
            /** @var Job $job */
            $job->run($this);
        } catch (\Exception $e) {
            if ($throw) {
                throw $e;
            } else {
                Yii::error($e, __METHOD__);
            }
        } finally {
            $this->driver->release($message);
            $this->trigger(self::EVENT_ON_RELEASE, new Event(['job' => $job]));
        }
        return true;
    } else {
        return false;
    }
}