Completed
Push — master ( 11f27c...4713a5 )
by Andreas
08:33
created

CollStats   A

Complexity

Total Complexity 7

Size/Duplication

Total Lines 67
Duplicated Lines 0 %

Coupling/Cohesion

Components 1
Dependencies 1

Test Coverage

Coverage 100%

Importance

Changes 0
Metric Value
wmc 7
lcom 1
cbo 1
dl 0
loc 67
ccs 16
cts 16
cp 1
rs 10
c 0
b 0
f 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
1
<?php
2
/*
3
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
4
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
5
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
6
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
7
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
8
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
9
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
10
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
11
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
12
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
13
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
14
 *
15
 * This software consists of voluntary contributions made by many individuals
16
 * and is licensed under the MIT license. For more information, see
17
 * <http://www.doctrine-project.org>.
18
 */
19
20
namespace Doctrine\ODM\MongoDB\Aggregation\Stage;
21
22
use Doctrine\ODM\MongoDB\Aggregation\Builder;
23
use Doctrine\ODM\MongoDB\Aggregation\Stage;
24
25
/**
26
 * Fluent interface for adding a $collStats stage to an aggregation pipeline.
27
 *
28
 * @author alcaeus <[email protected]>
29
 * @since 1.5
30
 */
31
class CollStats extends Stage
32
{
33
    const LATENCY_STATS_NONE = 0;
34
    const LATENCY_STATS_SIMPLE = 1;
35
    const LATENCY_STATS_HISTOGRAMS = 2;
36
37
    /**
38
     * @var int
39
     */
40
    private $latencyStats = self::LATENCY_STATS_NONE;
41
42
    /**
43
     * @var bool
44
     */
45
    private $storageStats = false;
46
47
    /**
48
     * @param Builder $builder
49
     */
50 5
    public function __construct(Builder $builder)
51
    {
52 5
        parent::__construct($builder);
53 5
    }
54
55
    /**
56
     * Adds latency statistics to the return document.
57
     *
58
     * @param bool $histograms Adds latency histogram information to latencyStats if true.
59
     *
60
     * @return $this
61
     */
62 3
    public function showLatencyStats($histograms = false)
63
    {
64 3
        $this->latencyStats = $histograms ? self::LATENCY_STATS_HISTOGRAMS : self::LATENCY_STATS_SIMPLE;
65
66 3
        return $this;
67
    }
68
69
    /**
70
     * Adds storage statistics to the return document.
71
     *
72
     * @return $this
73
     */
74 2
    public function showStorageStats()
75
    {
76 2
        $this->storageStats = true;
77
78 2
        return $this;
79
    }
80
81
    /**
82
     * {@inheritdoc}
83
     */
84 5
    public function getExpression()
85
    {
86 5
        $collStats = [];
87 5
        if ($this->latencyStats !== self::LATENCY_STATS_NONE) {
88 3
            $collStats['latencyStats'] = ['histograms' => $this->latencyStats === self::LATENCY_STATS_HISTOGRAMS];
89
        }
90
91 5
        if ($this->storageStats) {
92 2
            $collStats['storageStats'] = [];
93
        }
94
95 5
        return ['$collStats' => $collStats];
96
    }
97
}
98