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
|
<?php
/**
* Piwik - 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\Visualizations;
use Piwik\API\Request as ApiRequest;
use Piwik\Columns\Dimension;
use Piwik\Common;
use Piwik\DataTable\Row;
use Piwik\Metrics;
use Piwik\DataTable;
use Piwik\Period;
use Piwik\Plugin\Visualization;
/**
* DataTable visualization that shows DataTable data in an HTML table.
*
* @property HtmlTable\Config $config
*/
class HtmlTable extends Visualization
{
const ID = 'table';
const TEMPLATE_FILE = "@CoreVisualizations/_dataTableViz_htmlTable.twig";
const FOOTER_ICON = 'icon-table';
const FOOTER_ICON_TITLE = 'General_DisplaySimpleTable';
public static function getDefaultConfig()
{
return new HtmlTable\Config();
}
public static function getDefaultRequestConfig()
{
return new HtmlTable\RequestConfig();
}
public function beforeLoadDataTable()
{
$this->checkRequestIsNotForMultiplePeriods();
}
public function beforeRender()
{
if ($this->requestConfig->idSubtable
&& $this->config->show_embedded_subtable) {
$this->config->show_visualization_only = true;
}
if ($this->requestConfig->idSubtable) {
$this->config->show_totals_row = false;
}
foreach (Metrics::getMetricIdsToProcessReportTotal() as $metricId) {
$this->config->report_ratio_columns[] = Metrics::getReadableColumnName($metricId);
}
if (!empty($this->report)) {
foreach ($this->report->getMetricNamesToProcessReportTotals() as $metricName) {
$this->config->report_ratio_columns[] = $metricName;
}
}
// we do not want to get a datatable\map
$period = Common::getRequestVar('period', 'day', 'string');
if (Period\Range::parseDateRange($period)) {
$period = 'range';
}
if ($this->dataTable->getRowsCount()) {
$request = new ApiRequest(array(
'method' => 'API.get',
'module' => 'API',
'action' => 'get',
'format' => 'original',
'filter_limit' => '-1',
'disable_generic_filters' => 1,
'expanded' => 0,
'flat' => 0,
'filter_offset' => 0,
'period' => $period,
'showColumns' => implode(',', $this->config->columns_to_display),
'columns' => implode(',', $this->config->columns_to_display),
'pivotBy' => ''
));
$dataTable = $request->process();
$this->assignTemplateVar('siteSummary', $dataTable);
}
if ($this->isPivoted()) {
$this->config->columns_to_display = $this->dataTable->getColumns();
}
// Note: This needs to be done right before rendering, as otherwise some plugins might change the columns to display again
if ($this->isFlattened()) {
$dimensions = $this->dataTable->getMetadata('dimensions');
$hasMultipleDimensions = is_array($dimensions) && count($dimensions) > 1;
$this->assignTemplateVar('hasMultipleDimensions', $hasMultipleDimensions);
if ($hasMultipleDimensions) {
if ($this->config->show_dimensions) {
// ensure first metric translation is used as label if other dimensions are in separate columns
$this->config->addTranslation('label', $this->config->translations[reset($dimensions)]);
} else {
// concatenate dimensions if table is shown flattened
foreach ($dimensions as $dimension) {
$labels[] = $this->config->translations[$dimension];
}
$this->config->addTranslation('label', implode(' - ', $labels));
}
}
if ($this->config->show_dimensions && $hasMultipleDimensions) {
$properties = $this->config;
array_shift($dimensions); // shift away first dimension, as that will be shown as label
$this->dataTable->filter(function (DataTable $dataTable) use ($properties, $dimensions) {
if (empty($properties->columns_to_display)) {
$columns = $dataTable->getColumns();
$hasNbVisits = in_array('nb_visits', $columns);
$hasNbUniqVisitors = in_array('nb_uniq_visitors', $columns);
$properties->setDefaultColumnsToDisplay($columns, $hasNbVisits, $hasNbUniqVisitors);
}
$label = array_search('label', $properties->columns_to_display);
if ($label !== false) {
unset($properties->columns_to_display[$label]);
}
foreach (array_reverse($dimensions) as $dimension) {
array_unshift($properties->columns_to_display, $dimension);
}
array_unshift($properties->columns_to_display, 'label');
});
}
}
}
public function beforeGenericFiltersAreAppliedToLoadedDataTable()
{
if ($this->isPivoted()) {
$this->config->columns_to_display = $this->dataTable->getColumns();
$this->dataTable->applyQueuedFilters();
}
parent::beforeGenericFiltersAreAppliedToLoadedDataTable();
// Note: This needs to be done right before generic filter are applied, to make sorting such columns possible
if ($this->isFlattened()) {
$dimensions = $this->dataTable->getMetadata('dimensions');
$hasMultipleDimensions = is_array($dimensions) && count($dimensions) > 1;
if ($hasMultipleDimensions) {
foreach (Dimension::getAllDimensions() as $dimension) {
$dimensionId = str_replace('.', '_', $dimension->getId());
$dimensionName = $dimension->getName();
if (!empty($dimensionId) && !empty($dimensionName) && in_array($dimensionId, $dimensions)) {
$this->config->translations[$dimensionId] = $dimensionName;
}
}
}
if ($this->config->show_dimensions && $hasMultipleDimensions) {
$this->dataTable->filter(function($dataTable) use ($dimensions) {
/** @var DataTable $dataTable */
$rows = $dataTable->getRows();
foreach ($rows as $row) {
foreach ($dimensions as $dimension) {
$row->setColumn($dimension, $row->getMetadata($dimension));
}
}
});
# replace original label column with first dimension
$firstDimension = array_shift($dimensions);
$this->dataTable->filter('ColumnCallbackAddMetadata', array('label', 'combinedLabel', function ($label) { return $label; }));
$this->dataTable->filter('ColumnDelete', array('label'));
$this->dataTable->filter('ReplaceColumnNames', array(array($firstDimension => 'label')));
}
}
}
protected function isPivoted()
{
return $this->requestConfig->pivotBy || Common::getRequestVar('pivotBy', '');
}
/**
* Override to compute a custom cell HTML attributes (such as style).
*
* @param Row $row
* @param $column
* @return array Array of name => value pairs.
*/
public function getCellHtmlAttributes(Row $row, $column)
{
return null;
}
protected function isFlattened()
{
return $this->requestConfig->flat || Common::getRequestVar('flat', '');
}
}
|
