1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
|
<?php
/**
* Matomo - free/libre analytics platform
*
* @link https://matomo.org
* @license https://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
*/
namespace Piwik\Plugin;
use Piwik\Archive\DataTableFactory;
use Piwik\Columns\Dimension;
use Piwik\Common;
use Piwik\DataTable;
use Piwik\Metrics\Formatter;
use Piwik\Piwik;
class ArchivedMetric extends Metric
{
public const AGGREGATION_COUNT = 'count(%s)';
public const AGGREGATION_COUNT_PREFIX = 'nb_';
public const AGGREGATION_SUM = 'sum(%s)';
public const AGGREGATION_SUM_PREFIX = 'sum_';
public const AGGREGATION_MAX = 'max(%s)';
public const AGGREGATION_MAX_PREFIX = 'max_';
public const AGGREGATION_MIN = 'min(%s)';
public const AGGREGATION_MIN_PREFIX = 'min_';
public const AGGREGATION_UNIQUE = 'count(distinct %s)';
public const AGGREGATION_UNIQUE_PREFIX = 'nb_uniq_';
public const AGGREGATION_COUNT_WITH_NUMERIC_VALUE = 'sum(if(%s > 0, 1, 0))';
public const AGGREGATION_COUNT_WITH_NUMERIC_VALUE_PREFIX = 'nb_with_';
/**
* @var string
*/
private $aggregation;
/**
* @var int
*/
protected $idSite;
private $name = '';
private $type = '';
private $translatedName = '';
private $documentation = '';
private $dbTable = '';
private $category = '';
private $query = '';
/**
* @var Dimension
*/
private $dimension;
public function __construct(Dimension $dimension, $aggregation = false)
{
if (!empty($aggregation) && strpos($aggregation, '%s') === false) {
throw new \Exception(sprintf('The given aggregation for %s.%s needs to include a %%s for the column name', $dimension->getDbTableName(), $dimension->getColumnName()));
}
$this->setDimension($dimension);
$this->setDbTable($dimension->getDbTableName());
$this->aggregation = $aggregation;
}
public function getAggregation()
{
return $this->aggregation;
}
public function setDimension($dimension)
{
$this->dimension = $dimension;
return $this;
}
public function getDimension()
{
return $this->dimension;
}
public function setCategory($category)
{
$this->category = $category;
return $this;
}
public function getCategoryId()
{
return $this->category;
}
public function setDbTable($dbTable)
{
$this->dbTable = $dbTable;
return $this;
}
public function setDocumentation($documentation)
{
$this->documentation = $documentation;
return $this;
}
public function setTranslatedName($name)
{
$this->translatedName = $name;
return $this;
}
public function setType($type)
{
$this->type = $type;
return $this;
}
public function setName($name)
{
$this->name = $name;
return $this;
}
public function setQuery($query)
{
$this->query = $query;
return $this;
}
public function getName()
{
return $this->name;
}
public function format($value, Formatter $formatter)
{
switch ($this->type) {
case Dimension::TYPE_BOOL:
return $formatter->getPrettyNumber($value);
case Dimension::TYPE_ENUM:
return $formatter->getPrettyNumber($value);
case Dimension::TYPE_MONEY:
return $formatter->getPrettyMoney($value, $this->idSite);
case Dimension::TYPE_FLOAT:
return $formatter->getPrettyNumber((float) $value, $precision = 2);
case Dimension::TYPE_NUMBER:
return $formatter->getPrettyNumber($value);
case Dimension::TYPE_DURATION_S:
return $formatter->getPrettyTimeFromSeconds($value, $displayAsSentence = true);
case Dimension::TYPE_DURATION_MS:
$val = round(($value / 1000), ($value / 1000) > 60 ? 0 : 2);
return $formatter->getPrettyTimeFromSeconds($val, $displayAsSentence = true);
case Dimension::TYPE_PERCENT:
return $formatter->getPrettyPercentFromQuotient($value);
case Dimension::TYPE_BYTE:
return $formatter->getPrettySizeFromBytes($value);
}
return $value;
}
public function getType()
{
return $this->type;
}
public function getTranslatedName()
{
if (!empty($this->translatedName)) {
return Piwik::translate($this->translatedName);
}
return $this->translatedName;
}
public function getDependentMetrics()
{
return array($this->getName());
}
public function getDocumentation()
{
return $this->documentation;
}
public function getDbTableName()
{
return $this->dbTable;
}
public function getQuery()
{
if ($this->query) {
return $this->query;
}
$column = $this->dbTable . '.' . $this->dimension->getColumnName();
if ($this->dimension->getSqlSegment()) {
$column = str_replace($this->dimension->getDbTableName(), $this->dbTable, $this->dimension->getSqlSegment());
}
if (!empty($this->aggregation)) {
return sprintf($this->aggregation, $column);
}
return $column;
}
public function beforeFormat($report, DataTable $table)
{
$this->idSite = DataTableFactory::getSiteIdFromMetadata($table);
if (empty($this->idSite)) {
$this->idSite = Common::getRequestVar('idSite', 0, 'int');
}
return !empty($this->idSite); // skip formatting if there is no site to get currency info from
}
public function getSemanticType(): ?string
{
return $this->type;
}
}
|
