0 follower

Final Class Yiisoft\Queue\Debug\QueueCollector

All Classes | Methods
InheritanceYiisoft\Queue\Debug\QueueCollector
ImplementsYiisoft\Yii\Debug\Collector\SummaryCollectorInterface
Uses TraitsYiisoft\Yii\Debug\Collector\CollectorTrait

Public Methods

Hide inherited methods

Method Description Defined By
collectPush() Yiisoft\Queue\Debug\QueueCollector
collectStatus() Yiisoft\Queue\Debug\QueueCollector
collectWorkerProcessing() Yiisoft\Queue\Debug\QueueCollector
getCollected() Yiisoft\Queue\Debug\QueueCollector
getSummary() Yiisoft\Queue\Debug\QueueCollector

Method Details

Hide inherited methods

collectPush() public method

public void collectPush ( string|null $channel, Yiisoft\Queue\Message\MessageInterface $message, string|array|callable|Yiisoft\Queue\Middleware\Push\MiddlewarePushInterface $middlewareDefinitions )
$channel string|null
$message Yiisoft\Queue\Message\MessageInterface
$middlewareDefinitions string|array|callable|Yiisoft\Queue\Middleware\Push\MiddlewarePushInterface 

                public function collectPush(
    ?string $channel,
    MessageInterface $message,
    string|array|callable|MiddlewarePushInterface ...$middlewareDefinitions,
): void {
    if (!$this->isActive()) {
        return;
    }
    if ($channel === null) {
        $channel = 'null';
    }
    $this->pushes[$channel][] = [
        'message' => $message,
        'middlewares' => $middlewareDefinitions,
    ];
}
collectStatus() public method

public void collectStatus ( string $id, \Yiisoft\Queue\JobStatus $status )
$id string
$status \Yiisoft\Queue\JobStatus 

                public function collectStatus(string $id, JobStatus $status): void
{
    if (!$this->isActive()) {
        return;
    }
    $this->statuses[] = [
        'id' => $id,
        'status' => $status->key(),
    ];
}
collectWorkerProcessing() public method

public void collectWorkerProcessing ( Yiisoft\Queue\Message\MessageInterface $message, Yiisoft\Queue\QueueInterface $queue )
$message Yiisoft\Queue\Message\MessageInterface
$queue Yiisoft\Queue\QueueInterface 

                public function collectWorkerProcessing(MessageInterface $message, QueueInterface $queue): void
{
    if (!$this->isActive()) {
        return;
    }
    $this->processingMessages[$queue->getChannel()][] = $message;
}
getCollected() public method

public array getCollected ( )

                public function getCollected(): array
{
    if (!$this->isActive()) {
        return [];
    }
    return [
        'pushes' => $this->pushes,
        'statuses' => $this->statuses,
        'processingMessages' => $this->processingMessages,
    ];
}
getSummary() public method

public array getSummary ( )

                public function getSummary(): array
{
    if (!$this->isActive()) {
        return [];
    }
    $countPushes = array_sum(array_map(static fn ($messages) => is_countable($messages) ? count($messages) : 0, $this->pushes));
    $countStatuses = count($this->statuses);
    $countProcessingMessages = array_sum(array_map(static fn ($messages) => is_countable($messages) ? count($messages) : 0, $this->processingMessages));
    return [
        'countPushes' => $countPushes,
        'countStatuses' => $countStatuses,
        'countProcessingMessages' => $countProcessingMessages,
    ];
}