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
225
226
227
228
229
230
231
232
233
|
<?php
/**
* Matomo - free/libre analytics platform
*
* @link https://matomo.org
* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
*
*/
namespace Piwik\Plugins\CoreVisualizations;
use Exception;
use Piwik\API\Request;
use Piwik\Common;
use Piwik\DataTable;
use Piwik\DataTable\Row;
use Piwik\Metrics;
use Piwik\Plugins\CoreVisualizations\JqplotDataGenerator\Chart;
use Piwik\Plugins\CoreVisualizations\Visualizations\JqplotGraph;
require_once PIWIK_INCLUDE_PATH . '/plugins/CoreVisualizations/JqplotDataGenerator/Evolution.php';
/**
* Generates JSON data used to configure and populate JQPlot graphs.
*
* Supports pie graphs, bar graphs and time serieses (aka, evolution graphs).
*/
class JqplotDataGenerator
{
/**
* View properties. @see \Piwik\ViewDataTable for more info.
*
* @var array
*/
protected $properties;
protected $graphType;
protected $isComparing;
private $availableSegments;
/**
* @var JqplotGraph
*/
protected $graph;
/**
* Creates a new JqplotDataGenerator instance for a graph type and view properties.
*
* @param string $type 'pie', 'bar', or 'evolution'
* @param array $properties The view properties.
* @throws \Exception
* @return JqplotDataGenerator
*/
public static function factory($type, $properties, JqplotGraph $graph)
{
switch ($type) {
case 'evolution':
return new JqplotDataGenerator\Evolution($properties, $type, $graph);
case 'pie':
case 'bar':
return new JqplotDataGenerator($properties, $type, $graph);
default:
throw new Exception("Unknown JqplotDataGenerator type '$type'.");
}
}
/**
* Constructor.
*
* @param array $properties
* @param string $graphType
*
* @internal param \Piwik\Plugin\ViewDataTable $visualization
*/
public function __construct($properties, $graphType, JqplotGraph $graph)
{
$this->properties = $properties;
$this->graphType = $graphType;
$this->isComparing = $graph->isComparing();
$this->graph = $graph;
$this->availableSegments = Request::processRequest('SegmentEditor.getAll', $override = [], $default = []);
}
/**
* Generates JSON graph data and returns it.
*
* @param DataTable|DataTable\Map $dataTable
* @return string
*/
public function generate($dataTable)
{
$visualization = new Chart();
if ($dataTable->getRowsCount() > 0) {
$dataTable->applyQueuedFilters();
$this->initChartObjectData($dataTable, $visualization);
}
return $visualization->render();
}
/**
* @param DataTable|DataTable\Map $dataTable
* @param Chart $visualization
*/
protected function initChartObjectData($dataTable, $visualization)
{
$xLabels = $dataTable->getColumn('label');
$columnsToDisplay = array_values($this->properties['columns_to_display']);
if (($labelColumnIndex = array_search('label', $columnsToDisplay)) !== false) {
unset($columnsToDisplay[$labelColumnIndex]);
}
$seriesMetadata = null;
if ($this->isComparing) {
list($yLabels, $serieses, $seriesMetadata) = $this->getComparisonTableSerieses($dataTable, $columnsToDisplay);
} else {
list($yLabels, $serieses) = $this->getMainTableSerieses($dataTable, $columnsToDisplay);
}
$visualization->dataTable = $dataTable;
$visualization->properties = $this->properties;
$visualization->setAxisXLabels($xLabels);
$visualization->setAxisYValues($serieses, $seriesMetadata);
$visualization->setAxisYLabels($yLabels);
$units = $this->getUnitsForSerieses($yLabels);
$visualization->setAxisYUnits($units);
}
private function getMainTableSerieses(DataTable $dataTable, $columnNames)
{
$columnNameToTranslation = [];
foreach ($columnNames as $columnName) {
$columnNameToTranslation[$columnName] = @$this->properties['translations'][$columnName];
}
$columnNameToValue = array();
foreach ($columnNames as $columnName) {
$columnNameToValue[$columnName] = $dataTable->getColumn($columnName);
}
return [$columnNameToTranslation, $columnNameToValue];
}
private function getComparisonTableSerieses(DataTable $dataTable, $columnsToDisplay)
{
$seriesLabels = [];
$serieses = [];
$seriesMetadata = [];
$seriesIndices = [];
foreach ($dataTable->getRows() as $row) {
/** @var DataTable $comparisonTable */
$comparisonTable = $row->getComparisons();
if (empty($comparisonTable)) {
continue;
}
foreach ($comparisonTable->getRows() as $index => $compareRow) {
foreach ($columnsToDisplay as $columnIndex => $columnName) {
$seriesId = $columnName . '|' . $index;
if (!isset($seriesIndices[$seriesId])) {
$seriesIndices[$seriesId] = count($seriesIndices);
}
$seriesLabel = $this->getComparisonSeriesLabel($compareRow, $columnName);
$seriesLabels[$seriesId] = $seriesLabel;
$serieses[$seriesId][] = $compareRow->getColumn($columnName);
$seriesMetadata[$seriesId] = [
'seriesIndex' => $seriesIndices[$seriesId],
'metricIndex' => $columnIndex,
];
}
}
}
return [$seriesLabels, $serieses, $seriesMetadata];
}
protected function getComparisonSeriesLabel(Row $compareRow, $columnName, $rowLabel = false)
{
return $this->getComparisonSeriesLabelFromCompareSeries($compareRow->getMetadata('compareSeriesPretty'), $columnName, $rowLabel);
}
protected function getComparisonSeriesLabelFromCompareSeries($compareSeriesPretty, $columnName, $rowLabel = false)
{
$columnTranslation = @$this->properties['translations'][$columnName];
if (empty($rowLabel)) {
$label = $columnTranslation;
} else {
$label = "$rowLabel ($columnTranslation)";
}
$label .= ' ' . $compareSeriesPretty;
return $label;
}
protected function getUnitsForSerieses($yLabels)
{
// derive units from column names
$units = $this->deriveUnitsFromRequestedColumnNames($yLabels);
if (!empty($this->properties['y_axis_unit'])) {
$units = array_fill(0, count($units), $this->properties['y_axis_unit']);
}
return $units;
}
private function deriveUnitsFromRequestedColumnNames($yLabels)
{
$idSite = Common::getRequestVar('idSite', null, 'int');
$units = array();
foreach ($yLabels as $seriesId => $ignore) {
$parts = explode('|', $seriesId, 2);
$columnName = $parts[0];
$derivedUnit = Metrics::getUnit($columnName, $idSite);
$units[$seriesId] = empty($derivedUnit) ? false : $derivedUnit;
}
return $units;
}
}
|
