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
|
<?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
*/
/**
* @package Piwik
* @subpackage Piwik_API
*/
class Piwik_API_DataTableGenericFilter
{
function __construct( $datatable, $request )
{
$this->table = $datatable;
$this->request = $request;
}
public function filter()
{
$this->applyGenericFilters($this->table);
}
/**
* Returns an array containing the information of the generic Piwik_DataTable_Filter
* to be applied automatically to the data resulting from the API calls.
*
* Order to apply the filters:
* 1 - Filter that remove filtered rows
* 2 - Filter that sort the remaining rows
* 3 - Filter that keep only a subset of the results
* 4 - Presentation filters
*
* @return array See the code for spec
*/
public static function getGenericFiltersInformation()
{
$genericFilters = array(
'Pattern' => array(
'filter_column' => array('string'),
'filter_pattern' => array('string'),
),
'PatternRecursive' => array(
'filter_column_recursive' => array('string'),
'filter_pattern_recursive' => array('string'),
),
'ExcludeLowPopulation' => array(
'filter_excludelowpop' => array('string'),
'filter_excludelowpop_value'=> array('float', '0'),
),
'AddColumnsWhenShowAllColumns' => array(
'filter_add_columns_when_show_all_columns' => array('integer')
),
'UpdateColumnsWhenShowAllGoals' => array(
'filter_update_columns_when_show_all_goals' => array('integer'),
'filter_only_display_idgoal' => array('integer', Piwik_DataTable_Filter_UpdateColumnsWhenShowAllGoals::GOALS_OVERVIEW),
),
'Sort' => array(
'filter_sort_column' => array('string'),
'filter_sort_order' => array('string'),
),
'Limit' => array(
'filter_offset' => array('integer', '0'),
'filter_limit' => array('integer'),
),
);
return $genericFilters;
}
/**
* Apply generic filters to the DataTable object resulting from the API Call.
* Disable this feature by setting the parameter disable_generic_filters to 1 in the API call request.
*
* @param Piwik_DataTable
*/
protected function applyGenericFilters($datatable)
{
if($datatable instanceof Piwik_DataTable_Array )
{
$tables = $datatable->getArray();
$filterWasApplied = false;
foreach($tables as $table)
{
$filterWasApplied = $this->applyGenericFilters($table);
// if no generic filter was applied to the first table, we can return
// as no filter would be applied to any other dataTable
if(!$filterWasApplied)
{
return;
}
}
return;
}
$genericFilters = self::getGenericFiltersInformation();
$filterApplied = false;
foreach($genericFilters as $filterName => $parameters)
{
$filterParameters = array();
$exceptionRaised = false;
foreach($parameters as $name => $info)
{
// parameter type to cast to
$type = $info[0];
// default value if specified, when the parameter doesn't have a value
$defaultValue = null;
if(isset($info[1]))
{
$defaultValue = $info[1];
}
try {
$value = Piwik_Common::getRequestVar($name, $defaultValue, $type, $this->request);
settype($value, $type);
$filterParameters[] = $value;
}
catch(Exception $e)
{
$exceptionRaised = true;
break;
}
}
if(!$exceptionRaised)
{
if($filterName == 'Limit')
{
$datatable->setRowsCountBeforeLimitFilter();
}
$datatable->filter($filterName, $filterParameters);
$filterApplied = true;
}
}
return $filterApplied;
}
}
|
