Doctrine\ODM\MongoDB\Aggregation\Stage\CollStats

Complexity

Total Complexity

7

Size/Duplication

Total Lines	54
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	showLatencyStats()	0	6	2
A	showStorageStats()	0	6	1
A	getExpression()	0	13	3

<?php

declare(strict_types=1);

namespace Doctrine\ODM\MongoDB\Aggregation\Stage;

use Doctrine\ODM\MongoDB\Aggregation\Builder;
use Doctrine\ODM\MongoDB\Aggregation\Stage;

/**
 * Fluent interface for adding a $collStats stage to an aggregation pipeline.
 */
class CollStats extends Stage
{
    public const LATENCY_STATS_NONE       = 0;
    public const LATENCY_STATS_SIMPLE     = 1;
    public const LATENCY_STATS_HISTOGRAMS = 2;

    /** @var int */
    private $latencyStats = self::LATENCY_STATS_NONE;

    /** @var bool */
    private $storageStats = false;

    public function __construct(Builder $builder)
    {
        parent::__construct($builder);
    }

    /**
     * Adds latency statistics to the return document.
     */
    public function showLatencyStats(bool $histograms = false) : self
    {
        $this->latencyStats = $histograms ? self::LATENCY_STATS_HISTOGRAMS : self::LATENCY_STATS_SIMPLE;

        return $this;
    }

    /**
     * Adds storage statistics to the return document.
     */
    public function showStorageStats() : self
    {
        $this->storageStats = true;

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function getExpression() : array
    {
        $collStats = [];
        if ($this->latencyStats !== self::LATENCY_STATS_NONE) {
            $collStats['latencyStats'] = ['histograms' => $this->latencyStats === self::LATENCY_STATS_HISTOGRAMS];
        }

        if ($this->storageStats) {
            $collStats['storageStats'] = [];
        }

        return ['$collStats' => $collStats];
    }
}