3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2018 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2018
35 class CRM_Report_Utils_Get
{
43 public static function getTypedValue($name, $type) {
44 $value = CRM_Utils_Array
::value($name, $_GET);
45 if ($value === NULL) {
48 return CRM_Utils_Type
::escape($value,
49 CRM_Utils_Type
::typeToString($type),
55 * @param string $fieldName
61 public static function dateParam($fieldName, &$field, &$defaults) {
62 // type = 12 (datetime) is not recognized by Utils_Type::escape() method,
63 // and therefore the below hack
66 $from = self
::getTypedValue("{$fieldName}_from", $type);
67 $to = self
::getTypedValue("{$fieldName}_to", $type);
69 $relative = self
::getTypedValue("{$fieldName}_relative", CRM_Utils_Type
::T_STRING
);
70 if ($relative !== NULL) {
71 $defaults["{$fieldName}_relative"] = $relative;
74 list($from, $to) = CRM_Utils_Date
::getFromTo($relative, NULL, NULL);
75 $from = substr($from, 0, 8);
76 $to = substr($to, 0, 8);
79 if (!($from ||
$to)) {
84 $dateFrom = CRM_Utils_Date
::setDateDefaults($from);
85 if ($dateFrom !== NULL &&
88 $defaults["{$fieldName}_from"] = $dateFrom[0];
93 $dateTo = CRM_Utils_Date
::setDateDefaults($to);
94 if ($dateTo !== NULL &&
97 $defaults["{$fieldName}_to"] = $dateTo[0];
103 * @param string $fieldName
107 public static function stringParam($fieldName, &$field, &$defaults) {
108 $fieldOP = CRM_Utils_Array
::value("{$fieldName}_op", $_GET, 'like');
118 $value = self
::getTypedValue("{$fieldName}_value", CRM_Utils_Array
::value('type', $field));
119 if ($value !== NULL) {
120 $defaults["{$fieldName}_value"] = $value;
121 $defaults["{$fieldName}_op"] = $fieldOP;
127 $defaults["{$fieldName}_op"] = $fieldOP;
133 $value = self
::getTypedValue("{$fieldName}_value", CRM_Utils_Type
::T_STRING
);
134 if ($value !== NULL) {
135 $defaults["{$fieldName}_value"] = explode(",", $value);
136 $defaults["{$fieldName}_op"] = $fieldOP;
143 * @param string $fieldName
147 public static function intParam($fieldName, &$field, &$defaults) {
148 $fieldOP = CRM_Utils_Array
::value("{$fieldName}_op", $_GET, 'eq');
157 $value = self
::getTypedValue("{$fieldName}_value", $field['type']);
158 if ($value !== NULL) {
159 $defaults["{$fieldName}_value"] = $value;
160 $defaults["{$fieldName}_op"] = $fieldOP;
166 $minValue = self
::getTypedValue("{$fieldName}_min", $field['type']);
167 $maxValue = self
::getTypedValue("{$fieldName}_max", $field['type']);
168 if ($minValue !== NULL ||
171 if ($minValue !== NULL) {
172 $defaults["{$fieldName}_min"] = $minValue;
174 if ($maxValue !== NULL) {
175 $defaults["{$fieldName}_max"] = $maxValue;
177 $defaults["{$fieldName}_op"] = $fieldOP;
183 // send the type as string so that multiple values can also be retrieved from url.
184 // for e.g url like - "memtype_in=in&memtype_value=1,2,3"
185 $value = self
::getTypedValue("{$fieldName}_value", CRM_Utils_Type
::T_STRING
);
186 if (!preg_match('/^(\d+)(,\d+){0,14}$/', $value)) {
187 // extra check. Also put a limit of 15 max values.
190 if ($value !== NULL) {
191 $defaults["{$fieldName}_value"] = explode(",", $value);
192 $defaults["{$fieldName}_op"] = $fieldOP;
201 public static function processChart(&$defaults) {
202 $chartType = CRM_Utils_Array
::value("charts", $_GET);
203 if (in_array($chartType, array(
207 $defaults["charts"] = $chartType;
215 public static function processFilter(&$fieldGrp, &$defaults) {
216 // process only filters for now
217 foreach ($fieldGrp as $tableName => $fields) {
218 foreach ($fields as $fieldName => $field) {
219 switch (CRM_Utils_Array
::value('type', $field)) {
220 case CRM_Utils_Type
::T_INT
:
221 case CRM_Utils_Type
::T_FLOAT
:
222 case CRM_Utils_Type
::T_MONEY
:
223 self
::intParam($fieldName, $field, $defaults);
226 case CRM_Utils_Type
::T_DATE
:
227 case CRM_Utils_Type
::T_DATE | CRM_Utils_Type
::T_TIME
:
228 self
::dateParam($fieldName, $field, $defaults);
231 case CRM_Utils_Type
::T_STRING
:
233 self
::stringParam($fieldName, $field, $defaults);
241 * unset default filters.
244 public static function unsetFilters(&$defaults) {
245 static $unsetFlag = TRUE;
247 foreach ($defaults as $field_name => $field_value) {
248 $newstr = substr($field_name, strrpos($field_name, '_'));
249 if ($newstr == '_value' ||
$newstr == '_op' ||
250 $newstr == '_min' ||
$newstr == '_max' ||
251 $newstr == '_from' ||
$newstr == '_to' ||
252 $newstr == '_relative'
254 unset($defaults[$field_name]);
265 public static function processGroupBy(&$fieldGrp, &$defaults) {
266 // process only group_bys for now
269 if (is_array($fieldGrp)) {
270 foreach ($fieldGrp as $tableName => $fields) {
271 if ($groupBys = CRM_Utils_Array
::value("gby", $_GET)) {
272 $groupBys = explode(' ', $groupBys);
273 if (!empty($groupBys)) {
275 unset($defaults['group_bys']);
278 foreach ($groupBys as $gby) {
279 if (array_key_exists($gby, $fields)) {
280 $defaults['group_bys'][$gby] = 1;
290 * @param $reportFields
293 public static function processFields(&$reportFields, &$defaults) {
294 //add filters from url
295 if (is_array($reportFields)) {
296 if ($urlFields = CRM_Utils_Array
::value("fld", $_GET)) {
297 $urlFields = explode(',', $urlFields);
299 if (CRM_Utils_Array
::value("ufld", $_GET) == 1) {
300 // unset all display columns
301 $defaults['fields'] = array();
303 if (!empty($urlFields)) {
304 foreach ($reportFields as $tableName => $fields) {
305 foreach ($urlFields as $fld) {
306 if (array_key_exists($fld, $fields)) {
307 $defaults['fields'][$fld] = 1;