3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
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-2014
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
59 public static function dateParam($fieldName, &$field, &$defaults) {
60 // type = 12 (datetime) is not recognized by Utils_Type::escape() method,
61 // and therefore the below hack
64 $from = self
::getTypedValue("{$fieldName}_from", $type);
65 $to = self
::getTypedValue("{$fieldName}_to", $type);
67 $relative = CRM_Utils_Array
::value("{$fieldName}_relative", $_GET);
69 list($from, $to) = CRM_Report_Form
::getFromTo($relative, NULL, NULL);
70 $from = substr($from, 0, 8);
71 $to = substr($to, 0, 8);
74 if (!($from ||
$to)) {
79 $dateFrom = CRM_Utils_Date
::setDateDefaults($from);
80 if ($dateFrom !== NULL &&
83 $defaults["{$fieldName}_from"] = $dateFrom[0];
88 $dateTo = CRM_Utils_Date
::setDateDefaults($to);
89 if ($dateTo !== NULL &&
92 $defaults["{$fieldName}_to"] = $dateTo[0];
98 * @param string $fieldName
102 public static function stringParam($fieldName, &$field, &$defaults) {
103 $fieldOP = CRM_Utils_Array
::value("{$fieldName}_op", $_GET, 'like');
112 $value = self
::getTypedValue("{$fieldName}_value", CRM_Utils_Array
::value('type', $field));
113 if ($value !== NULL) {
114 $defaults["{$fieldName}_value"] = $value;
115 $defaults["{$fieldName}_op"] = $fieldOP;
121 $defaults["{$fieldName}_op"] = $fieldOP;
127 $value = self
::getTypedValue("{$fieldName}_value", CRM_Utils_Type
::T_STRING
);
128 if ($value !== NULL) {
129 $defaults["{$fieldName}_value"] = explode(",", $value);
130 $defaults["{$fieldName}_op"] = $fieldOP;
137 * @param string $fieldName
141 public static function intParam($fieldName, &$field, &$defaults) {
142 $fieldOP = CRM_Utils_Array
::value("{$fieldName}_op", $_GET, 'eq');
151 $value = self
::getTypedValue("{$fieldName}_value", $field['type']);
152 if ($value !== NULL) {
153 $defaults["{$fieldName}_value"] = $value;
154 $defaults["{$fieldName}_op"] = $fieldOP;
160 $minValue = self
::getTypedValue("{$fieldName}_min", $field['type']);
161 $maxValue = self
::getTypedValue("{$fieldName}_max", $field['type']);
162 if ($minValue !== NULL ||
165 if ($minValue !== NULL) {
166 $defaults["{$fieldName}_min"] = $minValue;
168 if ($maxValue !== NULL) {
169 $defaults["{$fieldName}_max"] = $maxValue;
171 $defaults["{$fieldName}_op"] = $fieldOP;
177 // send the type as string so that multiple values can also be retrieved from url.
178 // for e.g url like - "memtype_in=in&memtype_value=1,2,3"
179 $value = self
::getTypedValue("{$fieldName}_value", CRM_Utils_Type
::T_STRING
);
180 if (!preg_match('/^(\d+)(,\d+){0,14}$/', $value)) {
181 // extra check. Also put a limit of 15 max values.
184 if ($value !== NULL) {
185 $defaults["{$fieldName}_value"] = explode(",", $value);
186 $defaults["{$fieldName}_op"] = $fieldOP;
195 public static function processChart(&$defaults) {
196 $chartType = CRM_Utils_Array
::value("charts", $_GET);
197 if (in_array($chartType, array(
201 $defaults["charts"] = $chartType;
209 public static function processFilter(&$fieldGrp, &$defaults) {
210 // process only filters for now
211 foreach ($fieldGrp as $tableName => $fields) {
212 foreach ($fields as $fieldName => $field) {
213 switch (CRM_Utils_Array
::value('type', $field)) {
214 case CRM_Utils_Type
::T_INT
:
215 case CRM_Utils_Type
::T_FLOAT
:
216 case CRM_Utils_Type
::T_MONEY
:
217 self
::intParam($fieldName, $field, $defaults);
220 case CRM_Utils_Type
::T_DATE
:
221 case CRM_Utils_Type
::T_DATE | CRM_Utils_Type
::T_TIME
:
222 self
::dateParam($fieldName, $field, $defaults);
225 case CRM_Utils_Type
::T_STRING
:
227 self
::stringParam($fieldName, $field, $defaults);
235 * unset default filters
238 public static function unsetFilters(&$defaults) {
239 static $unsetFlag = TRUE;
241 foreach ($defaults as $field_name => $field_value) {
242 $newstr = substr($field_name, strrpos($field_name, '_'));
243 if ($newstr == '_value' ||
$newstr == '_op' ||
244 $newstr == '_min' ||
$newstr == '_max' ||
245 $newstr == '_from' ||
$newstr == '_to' ||
246 $newstr == '_relative'
248 unset($defaults[$field_name]);
259 public static function processGroupBy(&$fieldGrp, &$defaults) {
260 // process only group_bys for now
263 if (is_array($fieldGrp)) {
264 foreach ($fieldGrp as $tableName => $fields) {
265 if ($groupBys = CRM_Utils_Array
::value("gby", $_GET)) {
266 $groupBys = explode(' ', $groupBys);
267 if (!empty($groupBys)) {
269 unset($defaults['group_bys']);
272 foreach ($groupBys as $gby) {
273 if (array_key_exists($gby, $fields)) {
274 $defaults['group_bys'][$gby] = 1;
284 * @param $reportFields
287 public static function processFields(&$reportFields, &$defaults) {
288 //add filters from url
289 if (is_array($reportFields)) {
290 if ($urlFields = CRM_Utils_Array
::value("fld", $_GET)) {
291 $urlFields = explode(',', $urlFields);
293 if (CRM_Utils_Array
::value("ufld", $_GET) == 1) {
294 // unset all display columns
295 $defaults['fields'] = array();
297 if (!empty($urlFields)) {
298 foreach ($reportFields as $tableName => $fields) {
299 foreach ($urlFields as $fld) {
300 if (array_key_exists($fld, $fields)) {
301 $defaults['fields'][$fld] = 1;