Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
6a488035 TO |
2 | /* |
3 | +--------------------------------------------------------------------+ | |
7e9e8871 | 4 | | CiviCRM version 4.7 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
0f03f337 | 6 | | Copyright CiviCRM LLC (c) 2004-2017 | |
6a488035 TO |
7 | +--------------------------------------------------------------------+ |
8 | | This file is a part of CiviCRM. | | |
9 | | | | |
10 | | CiviCRM is free software; you can copy, modify, and distribute it | | |
11 | | under the terms of the GNU Affero General Public License | | |
12 | | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. | | |
13 | | | | |
14 | | CiviCRM is distributed in the hope that it will be useful, but | | |
15 | | WITHOUT ANY WARRANTY; without even the implied warranty of | | |
16 | | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. | | |
17 | | See the GNU Affero General Public License for more details. | | |
18 | | | | |
19 | | You should have received a copy of the GNU Affero General Public | | |
20 | | License and the CiviCRM Licensing Exception along | | |
21 | | with this program; if not, contact CiviCRM LLC | | |
22 | | at info[AT]civicrm[DOT]org. If you have questions about the | | |
23 | | GNU Affero General Public License or the licensing of CiviCRM, | | |
24 | | see the CiviCRM license FAQ at http://civicrm.org/licensing | | |
25 | +--------------------------------------------------------------------+ | |
d25dd0ee | 26 | */ |
6a488035 TO |
27 | |
28 | /** | |
29 | * | |
30 | * @package CRM | |
0f03f337 | 31 | * @copyright CiviCRM LLC (c) 2004-2017 |
6a488035 TO |
32 | * $Id$ |
33 | * | |
34 | */ | |
35 | class CRM_Report_Utils_Get { | |
36 | ||
74cf4551 | 37 | /** |
100fef9d | 38 | * @param string $name |
74cf4551 EM |
39 | * @param $type |
40 | * | |
41 | * @return mixed|null | |
42 | */ | |
00be9182 | 43 | public static function getTypedValue($name, $type) { |
6a488035 TO |
44 | $value = CRM_Utils_Array::value($name, $_GET); |
45 | if ($value === NULL) { | |
46 | return NULL; | |
47 | } | |
48 | return CRM_Utils_Type::escape($value, | |
49 | CRM_Utils_Type::typeToString($type), | |
50 | FALSE | |
51 | ); | |
52 | } | |
53 | ||
74cf4551 | 54 | /** |
100fef9d | 55 | * @param string $fieldName |
74cf4551 EM |
56 | * @param $field |
57 | * @param $defaults | |
ab432335 EM |
58 | * |
59 | * @return bool | |
74cf4551 | 60 | */ |
00be9182 | 61 | public static function dateParam($fieldName, &$field, &$defaults) { |
6a488035 TO |
62 | // type = 12 (datetime) is not recognized by Utils_Type::escape() method, |
63 | // and therefore the below hack | |
64 | $type = 4; | |
65 | ||
66 | $from = self::getTypedValue("{$fieldName}_from", $type); | |
67 | $to = self::getTypedValue("{$fieldName}_to", $type); | |
68 | ||
0ceea711 PN |
69 | $relative = self::getTypedValue("{$fieldName}_relative", CRM_Utils_Type::T_STRING); |
70 | if ($relative !== NULL) { | |
71 | $defaults["{$fieldName}_relative"] = $relative; | |
72 | } | |
6a488035 | 73 | if ($relative) { |
dd56d5dc | 74 | list($from, $to) = CRM_Utils_Date::getFromTo($relative, NULL, NULL); |
6a488035 TO |
75 | $from = substr($from, 0, 8); |
76 | $to = substr($to, 0, 8); | |
77 | } | |
78 | ||
79 | if (!($from || $to)) { | |
80 | return FALSE; | |
81 | } | |
82 | ||
83 | if ($from !== NULL) { | |
84 | $dateFrom = CRM_Utils_Date::setDateDefaults($from); | |
85 | if ($dateFrom !== NULL && | |
86 | !empty($dateFrom[0]) | |
87 | ) { | |
88 | $defaults["{$fieldName}_from"] = $dateFrom[0]; | |
89 | } | |
90 | } | |
91 | ||
92 | if ($to !== NULL) { | |
93 | $dateTo = CRM_Utils_Date::setDateDefaults($to); | |
94 | if ($dateTo !== NULL && | |
95 | !empty($dateTo[0]) | |
96 | ) { | |
97 | $defaults["{$fieldName}_to"] = $dateTo[0]; | |
98 | } | |
99 | } | |
100 | } | |
101 | ||
74cf4551 | 102 | /** |
100fef9d | 103 | * @param string $fieldName |
74cf4551 EM |
104 | * @param $field |
105 | * @param $defaults | |
106 | */ | |
00be9182 | 107 | public static function stringParam($fieldName, &$field, &$defaults) { |
6a488035 TO |
108 | $fieldOP = CRM_Utils_Array::value("{$fieldName}_op", $_GET, 'like'); |
109 | ||
110 | switch ($fieldOP) { | |
111 | case 'has': | |
112 | case 'sw': | |
113 | case 'ew': | |
114 | case 'nhas': | |
115 | case 'like': | |
116 | case 'neq': | |
117 | $value = self::getTypedValue("{$fieldName}_value", CRM_Utils_Array::value('type', $field)); | |
118 | if ($value !== NULL) { | |
119 | $defaults["{$fieldName}_value"] = $value; | |
120 | $defaults["{$fieldName}_op"] = $fieldOP; | |
121 | } | |
122 | break; | |
123 | ||
124 | case 'nll': | |
125 | case 'nnll': | |
126 | $defaults["{$fieldName}_op"] = $fieldOP; | |
127 | break; | |
84178120 | 128 | |
79ce64de RN |
129 | case 'in': |
130 | case 'notin': | |
dd62d149 | 131 | case 'mhas': |
79ce64de RN |
132 | $value = self::getTypedValue("{$fieldName}_value", CRM_Utils_Type::T_STRING); |
133 | if ($value !== NULL) { | |
134 | $defaults["{$fieldName}_value"] = explode(",", $value); | |
135 | $defaults["{$fieldName}_op"] = $fieldOP; | |
136 | } | |
137 | break; | |
6a488035 TO |
138 | } |
139 | } | |
140 | ||
74cf4551 | 141 | /** |
100fef9d | 142 | * @param string $fieldName |
74cf4551 EM |
143 | * @param $field |
144 | * @param $defaults | |
145 | */ | |
00be9182 | 146 | public static function intParam($fieldName, &$field, &$defaults) { |
6a488035 TO |
147 | $fieldOP = CRM_Utils_Array::value("{$fieldName}_op", $_GET, 'eq'); |
148 | ||
149 | switch ($fieldOP) { | |
150 | case 'lte': | |
151 | case 'gte': | |
152 | case 'eq': | |
153 | case 'lt': | |
154 | case 'gt': | |
155 | case 'neq': | |
156 | $value = self::getTypedValue("{$fieldName}_value", $field['type']); | |
157 | if ($value !== NULL) { | |
158 | $defaults["{$fieldName}_value"] = $value; | |
159 | $defaults["{$fieldName}_op"] = $fieldOP; | |
160 | } | |
161 | break; | |
162 | ||
163 | case 'bw': | |
164 | case 'nbw': | |
165 | $minValue = self::getTypedValue("{$fieldName}_min", $field['type']); | |
166 | $maxValue = self::getTypedValue("{$fieldName}_max", $field['type']); | |
167 | if ($minValue !== NULL || | |
168 | $maxValue !== NULL | |
169 | ) { | |
170 | if ($minValue !== NULL) { | |
171 | $defaults["{$fieldName}_min"] = $minValue; | |
172 | } | |
173 | if ($maxValue !== NULL) { | |
174 | $defaults["{$fieldName}_max"] = $maxValue; | |
175 | } | |
176 | $defaults["{$fieldName}_op"] = $fieldOP; | |
177 | } | |
178 | break; | |
179 | ||
180 | case 'in': | |
181 | case 'notin': | |
182 | // send the type as string so that multiple values can also be retrieved from url. | |
183 | // for e.g url like - "memtype_in=in&memtype_value=1,2,3" | |
184 | $value = self::getTypedValue("{$fieldName}_value", CRM_Utils_Type::T_STRING); | |
185 | if (!preg_match('/^(\d+)(,\d+){0,14}$/', $value)) { | |
186 | // extra check. Also put a limit of 15 max values. | |
187 | $value = NULL; | |
188 | } | |
189 | if ($value !== NULL) { | |
190 | $defaults["{$fieldName}_value"] = explode(",", $value); | |
191 | $defaults["{$fieldName}_op"] = $fieldOP; | |
192 | } | |
193 | break; | |
194 | } | |
195 | } | |
196 | ||
74cf4551 EM |
197 | /** |
198 | * @param $defaults | |
199 | */ | |
00be9182 | 200 | public static function processChart(&$defaults) { |
6a488035 TO |
201 | $chartType = CRM_Utils_Array::value("charts", $_GET); |
202 | if (in_array($chartType, array( | |
353ffa53 | 203 | 'barChart', |
317fceb4 | 204 | 'pieChart', |
353ffa53 | 205 | ))) { |
6a488035 TO |
206 | $defaults["charts"] = $chartType; |
207 | } | |
208 | } | |
209 | ||
74cf4551 EM |
210 | /** |
211 | * @param $fieldGrp | |
212 | * @param $defaults | |
213 | */ | |
00be9182 | 214 | public static function processFilter(&$fieldGrp, &$defaults) { |
6a488035 TO |
215 | // process only filters for now |
216 | foreach ($fieldGrp as $tableName => $fields) { | |
217 | foreach ($fields as $fieldName => $field) { | |
218 | switch (CRM_Utils_Array::value('type', $field)) { | |
219 | case CRM_Utils_Type::T_INT: | |
912a8063 | 220 | case CRM_Utils_Type::T_FLOAT: |
6a488035 TO |
221 | case CRM_Utils_Type::T_MONEY: |
222 | self::intParam($fieldName, $field, $defaults); | |
223 | break; | |
224 | ||
225 | case CRM_Utils_Type::T_DATE: | |
226 | case CRM_Utils_Type::T_DATE | CRM_Utils_Type::T_TIME: | |
227 | self::dateParam($fieldName, $field, $defaults); | |
228 | break; | |
229 | ||
230 | case CRM_Utils_Type::T_STRING: | |
231 | default: | |
232 | self::stringParam($fieldName, $field, $defaults); | |
233 | break; | |
234 | } | |
235 | } | |
236 | } | |
237 | } | |
238 | ||
74cf4551 | 239 | /** |
fe482240 | 240 | * unset default filters. |
74cf4551 EM |
241 | * @param $defaults |
242 | */ | |
00be9182 | 243 | public static function unsetFilters(&$defaults) { |
6a488035 TO |
244 | static $unsetFlag = TRUE; |
245 | if ($unsetFlag) { | |
246 | foreach ($defaults as $field_name => $field_value) { | |
247 | $newstr = substr($field_name, strrpos($field_name, '_')); | |
248 | if ($newstr == '_value' || $newstr == '_op' || | |
249 | $newstr == '_min' || $newstr == '_max' || | |
250 | $newstr == '_from' || $newstr == '_to' || | |
251 | $newstr == '_relative' | |
252 | ) { | |
253 | unset($defaults[$field_name]); | |
254 | } | |
255 | } | |
256 | $unsetFlag = FALSE; | |
257 | } | |
258 | } | |
259 | ||
74cf4551 EM |
260 | /** |
261 | * @param $fieldGrp | |
262 | * @param $defaults | |
263 | */ | |
00be9182 | 264 | public static function processGroupBy(&$fieldGrp, &$defaults) { |
6a488035 TO |
265 | // process only group_bys for now |
266 | $flag = FALSE; | |
267 | ||
268 | if (is_array($fieldGrp)) { | |
269 | foreach ($fieldGrp as $tableName => $fields) { | |
270 | if ($groupBys = CRM_Utils_Array::value("gby", $_GET)) { | |
271 | $groupBys = explode(' ', $groupBys); | |
272 | if (!empty($groupBys)) { | |
273 | if (!$flag) { | |
274 | unset($defaults['group_bys']); | |
275 | $flag = TRUE; | |
276 | } | |
277 | foreach ($groupBys as $gby) { | |
278 | if (array_key_exists($gby, $fields)) { | |
279 | $defaults['group_bys'][$gby] = 1; | |
280 | } | |
281 | } | |
282 | } | |
283 | } | |
284 | } | |
285 | } | |
286 | } | |
287 | ||
74cf4551 EM |
288 | /** |
289 | * @param $reportFields | |
290 | * @param $defaults | |
291 | */ | |
00be9182 | 292 | public static function processFields(&$reportFields, &$defaults) { |
6a488035 TO |
293 | //add filters from url |
294 | if (is_array($reportFields)) { | |
295 | if ($urlFields = CRM_Utils_Array::value("fld", $_GET)) { | |
296 | $urlFields = explode(',', $urlFields); | |
297 | } | |
ae555e90 DS |
298 | if (CRM_Utils_Array::value("ufld", $_GET) == 1) { |
299 | // unset all display columns | |
300 | $defaults['fields'] = array(); | |
301 | } | |
6a488035 TO |
302 | if (!empty($urlFields)) { |
303 | foreach ($reportFields as $tableName => $fields) { | |
304 | foreach ($urlFields as $fld) { | |
305 | if (array_key_exists($fld, $fields)) { | |
306 | $defaults['fields'][$fld] = 1; | |
307 | } | |
308 | } | |
309 | } | |
310 | } | |
311 | } | |
312 | } | |
96025800 | 313 | |
6a488035 | 314 | } |