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 - 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
*/
/**
* Outputs an AJAX Table for a given DataTable.
*
* Reads the requested DataTable from the API.
*
* @package Piwik
* @subpackage Piwik_ViewDataTable
*/
class Piwik_ViewDataTable_HtmlTable extends Piwik_ViewDataTable
{
/**
* Set to true when the DataTable must be loaded along with all its children subtables
* Useful when searching for a pattern in the DataTable Actions (we display the full hierarchy)
*
* @var bool
*/
protected $recursiveDataTableLoad = false;
/**
* PHP array conversion of the Piwik_DataTable
*
* @var array
*/
public $arrayDataTable; // phpArray
/**
* @see Piwik_ViewDataTable::init()
*/
function init($currentControllerName,
$currentControllerAction,
$apiMethodToRequestDataTable,
$controllerActionCalledWhenRequestSubTable = null )
{
parent::init($currentControllerName,
$currentControllerAction,
$apiMethodToRequestDataTable,
$controllerActionCalledWhenRequestSubTable);
$this->dataTableTemplate = 'CoreHome/templates/datatable.tpl';
$this->variablesDefault['enable_sort'] = '1';
$this->setSortedColumn('nb_visits', 'desc');
$this->setLimit(Zend_Registry::get('config')->General->datatable_default_limit);
$this->handleLowPopulation();
}
protected function getViewDataTableId()
{
return 'table';
}
/**
* @see Piwik_ViewDataTable::main()
*/
public function main()
{
if($this->mainAlreadyExecuted)
{
return;
}
$this->mainAlreadyExecuted = true;
$this->isDataAvailable = true;
try {
$this->loadDataTableFromAPI();
} catch(Exception $e) {
$this->isDataAvailable = false;
}
$this->postDataTableLoadedFromAPI();
$this->view = $this->buildView();
}
/**
* Hook called after the dataTable has been loaded from the API
* Can be used to add, delete or modify the data freshly loaded
*/
protected function postDataTableLoadedFromAPI()
{
}
/**
* @return Piwik_View with all data set
*/
protected function buildView()
{
$view = new Piwik_View($this->dataTableTemplate);
if(!$this->isDataAvailable)
{
$view->arrayDataTable = array();
}
else
{
$columns = $this->getColumnsToDisplay();
$columnTranslations = array();
foreach($columns as $columnName)
{
$columnTranslations[$columnName] = $this->getColumnTranslation($columnName);
}
$nbColumns = count($columns);
// case no data in the array we use the number of columns set to be displayed
if($nbColumns == 0)
{
$nbColumns = count($this->columnsToDisplay);
}
$view->arrayDataTable = $this->getPHPArrayFromDataTable();
$view->dataTableColumns = $columns;
$view->columnTranslations = $columnTranslations;
$view->nbColumns = $nbColumns;
$view->defaultWhenColumnValueNotDefined = '-';
}
$view->javascriptVariablesToSet = $this->getJavascriptVariablesToSet();
$view->properties = $this->getViewProperties();
return $view;
}
protected function handleLowPopulation( $columnToApplyFilter = null)
{
if(Piwik_Common::getRequestVar('enable_filter_excludelowpop', '0', 'string' ) == '0')
{
return;
}
if(is_null($columnToApplyFilter))
{
$columnToApplyFilter = Piwik_Archive::INDEX_NB_VISITS;
}
$this->setExcludeLowPopulation( $columnToApplyFilter);
}
/**
* Returns friendly php array from the Piwik_DataTable
* @see Piwik_DataTable_Renderer_Php
* @return array
*/
protected function getPHPArrayFromDataTable()
{
$renderer = Piwik_DataTable_Renderer::factory('php');
$renderer->setTable($this->dataTable);
$renderer->setSerialize( false );
// we get the php array from the datatable but conserving the original datatable format,
// ie. rows 'columns', 'metadata' and 'idsubdatatable'
$phpArray = $renderer->originalRender();
return $phpArray;
}
/**
* Adds a column to the list of columns to be displayed
*
* @param string $columnName
*/
public function addColumnToDisplay( $columnName )
{
$this->columnsToDisplay[] = $columnName;
}
/**
*/
public function disableSort()
{
$this->variablesDefault['enable_sort'] = 'false';
}
/**
* Sets the search on a table to be recursive (also searches in subtables)
* Works only on Actions/Downloads/Outlinks tables.
*
* @return bool If the pattern for a recursive search was set in the URL
*/
public function setSearchRecursive()
{
$this->variablesDefault['search_recursive'] = true;
return $this->setRecursiveLoadDataTableIfSearchingForPattern();
}
protected function getRequestString()
{
$requestString = parent::getRequestString();
if($this->recursiveDataTableLoad)
{
$requestString .= '&expanded=1';
}
return $requestString;
}
/**
* Set the flag to load the datatable recursively so we can search on subtables as well
*
* @return bool if recursive search is enabled
*/
protected function setRecursiveLoadDataTableIfSearchingForPattern()
{
try{
$requestValue = Piwik_Common::getRequestVar('filter_column_recursive');
$requestValue = Piwik_Common::getRequestVar('filter_pattern_recursive');
// if the 2 variables are set we are searching for something.
// we have to load all the children subtables in this case
$this->recursiveDataTableLoad = true;
return true;
}
catch(Exception $e) {
$this->recursiveDataTableLoad = false;
return false;
}
}
}
|
