0 follower

Final Class Yiisoft\Queue\Debug\QueueDecorator

All Classes | Methods | Constants
InheritanceYiisoft\Queue\Debug\QueueDecorator
ImplementsYiisoft\Queue\QueueInterface

Public Methods

Hide inherited methods

Method Description Defined By
__construct() Yiisoft\Queue\Debug\QueueDecorator
getChannel() Yiisoft\Queue\Debug\QueueDecorator
listen() Yiisoft\Queue\Debug\QueueDecorator
push() Yiisoft\Queue\Debug\QueueDecorator
run() Yiisoft\Queue\Debug\QueueDecorator
status() Yiisoft\Queue\Debug\QueueDecorator
withAdapter() Yiisoft\Queue\Debug\QueueDecorator

Constants

Hide inherited constants

Constant Value Description Defined By
DEFAULT_CHANNEL 'yii-queue' Yiisoft\Queue\QueueInterface

Method Details

Hide inherited methods

__construct() public method

public mixed __construct ( Yiisoft\Queue\QueueInterface $queue, Yiisoft\Queue\Debug\QueueCollector $collector )
$queue Yiisoft\Queue\QueueInterface
$collector Yiisoft\Queue\Debug\QueueCollector 

                public function __construct(
    private readonly QueueInterface $queue,
    private readonly QueueCollector $collector,
) {
}
getChannel() public method

public string getChannel ( )

                public function getChannel(): string
{
    return $this->queue->getChannel();
}
listen() public method

public void listen ( )

                public function listen(): void
{
    $this->queue->listen();
}
push() public method

public Yiisoft\Queue\Message\MessageInterface push ( Yiisoft\Queue\Message\MessageInterface $message, string|array|callable|Yiisoft\Queue\Middleware\Push\MiddlewarePushInterface $middlewareDefinitions )
$message Yiisoft\Queue\Message\MessageInterface
$middlewareDefinitions string|array|callable|Yiisoft\Queue\Middleware\Push\MiddlewarePushInterface 

                public function push(
    MessageInterface $message,
    string|array|callable|MiddlewarePushInterface ...$middlewareDefinitions
): MessageInterface {
    $message = $this->queue->push($message, ...$middlewareDefinitions);
    $this->collector->collectPush($this->queue->getChannel(), $message, ...$middlewareDefinitions);
    return $message;
}
run() public method

public integer run ( integer $max = 0 )
$max integer 

                public function run(int $max = 0): int
{
    return $this->queue->run($max);
}
status() public method

public \Yiisoft\Queue\JobStatus status ( string|integer $id )
$id string|integer 

                public function status(string|int $id): JobStatus
{
    $result = $this->queue->status($id);
    $this->collector->collectStatus((string) $id, $result);
    return $result;
}
withAdapter() public method

public Yiisoft\Queue\Debug\QueueDecorator withAdapter ( Yiisoft\Queue\Adapter\AdapterInterface $adapter )
$adapter Yiisoft\Queue\Adapter\AdapterInterface 

                public function withAdapter(AdapterInterface $adapter): static
{
    return new self($this->queue->withAdapter($adapter), $this->collector);
}