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
|
<?php
/**
* Piwik - Open source web analytics
*
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
*
* @category Piwik
* @package Piwik
*/
/**
* Reads data from the API and prepares data to give to the renderer Piwik_Visualization_Chart.
* This class is used to generate the data for the FLASH charts. It is given as a parameter of the SWF file.
* You can set the number of elements to appear in the graph using: setGraphLimit();
* Example:
* <pre>
* function getWebsites( $fetch = false)
* {
* $view = Piwik_ViewDataTable::factory();
* $view->init( $this->pluginName, 'getWebsites', 'Referers.getWebsites', 'getUrlsFromWebsiteId' );
* $view->setColumnsToDisplay( array('label','nb_visits') );
* $view->setLimit(10);
* $view->setGraphLimit(12);
* return $this->renderView($view, $fetch);
* }
* </pre>
*
* @package Piwik
* @subpackage Piwik_ViewDataTable
*/
abstract class Piwik_ViewDataTable_GenerateGraphData extends Piwik_ViewDataTable
{
/**
* Number of elements to display in the graph.
* @var int
*/
protected $graphLimit = null;
protected $yAxisUnit = '';
public function setAxisYUnit($unit)
{
$this->yAxisUnit = $unit;
}
/**
* Sets the number max of elements to display (number of pie slice, vertical bars, etc.)
* If the data has more elements than $limit then the last part of the data will be the sum of all the remaining data.
*
* @param int $limit
*/
public function setGraphLimit( $limit )
{
$this->graphLimit = $limit;
}
/**
* Returns numbers of elemnts to display in the graph
*
* @return int
*/
public function getGraphLimit()
{
return $this->graphLimit;
}
protected $displayPercentageInTooltip = true;
/**
* The percentage in tooltips is computed based on the sum of all values for the plotted column.
* If the sum of the column in the data set is not the number of elements in the data set,
* for example when plotting visits that have a given plugin enabled:
* one visit can have several plugins, hence the sum is much greater than the number of visits.
* In this case displaying the percentage doesn't make sense.
*/
public function disallowPercentageInGraphTooltip()
{
$this->displayPercentageInTooltip = false;
}
public function main()
{
if($this->mainAlreadyExecuted)
{
return;
}
$this->mainAlreadyExecuted = true;
if (!Zend_Registry::get('config')->General->serve_widget_and_data)
{
@header( "Content-Type: application/json" );
}
// Graphs require the full dataset, setting limit to null (same as 'no limit')
$this->setLimit(null);
// the queued filters will be manually applied later. This is to ensure that filtering using search
// will be done on the table before the labels are enhanced (see ReplaceColumnNames)
$this->disableQueuedFilters();
// throws exception if no view access
$this->loadDataTableFromAPI();
$graphLimit = $this->getGraphLimit();
if(!empty($graphLimit))
{
$offsetStartSummary = $this->getGraphLimit() - 1;
$this->dataTable->filter('AddSummaryRow',
array($offsetStartSummary,
Piwik_Translate('General_Others'),
Piwik_Archive::INDEX_NB_VISITS
)
);
}
$this->isDataAvailable = $this->dataTable->getRowsCount() != 0;
if(!$this->isDataAvailable)
{
$this->view->setTitle(html_entity_decode(Piwik_Translate('General_NoDataForGraph'), ENT_COMPAT, 'UTF-8'), '{font-size: 25px;}');
}
else
{
$this->initChartObjectData();
}
$this->view->customizeChartProperties();
}
protected function initChartObjectData()
{
$this->dataTable->applyQueuedFilters();
// We apply a filter to the DataTable, decoding the label column (useful for keywords for example)
$this->dataTable->filter('ColumnCallbackReplace', array('label','urldecode'));
$xLabels = $this->dataTable->getColumn('label');
$columnNames = parent::getColumnsToDisplay();
if(($labelColumnFound = array_search('label',$columnNames)) !== false)
{
unset($columnNames[$labelColumnFound]);
}
$columnNameToTranslation = $columnNameToValue = array();
foreach($columnNames as $columnName)
{
$columnNameToTranslation[$columnName] = $this->getColumnTranslation($columnName);
$columnNameToValue[$columnName] = $this->dataTable->getColumn($columnName);
}
$this->view->setAxisXLabels($xLabels);
$this->view->setAxisYValues($columnNameToValue);
$this->view->setAxisYLabels($columnNameToTranslation);
$this->view->setAxisYUnit($this->yAxisUnit);
$this->view->setDisplayPercentageInTooltip($this->displayPercentageInTooltip);
}
}
|
