3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2015 |
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-2015
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 = CRM_Utils_Array
::value("{$fieldName}_relative", $_GET);
71 list($from, $to) = CRM_Report_Form
::getFromTo($relative, NULL, NULL);
72 $from = substr($from, 0, 8);
73 $to = substr($to, 0, 8);
76 if (!($from ||
$to)) {
81 $dateFrom = CRM_Utils_Date
::setDateDefaults($from);
82 if ($dateFrom !== NULL &&
85 $defaults["{$fieldName}_from"] = $dateFrom[0];
90 $dateTo = CRM_Utils_Date
::setDateDefaults($to);
91 if ($dateTo !== NULL &&
94 $defaults["{$fieldName}_to"] = $dateTo[0];
100 * @param string $fieldName
104 public static function stringParam($fieldName, &$field, &$defaults) {
105 $fieldOP = CRM_Utils_Array
::value("{$fieldName}_op", $_GET, 'like');
114 $value = self
::getTypedValue("{$fieldName}_value", CRM_Utils_Array
::value('type', $field));
115 if ($value !== NULL) {
116 $defaults["{$fieldName}_value"] = $value;
117 $defaults["{$fieldName}_op"] = $fieldOP;
123 $defaults["{$fieldName}_op"] = $fieldOP;
129 $value = self
::getTypedValue("{$fieldName}_value", CRM_Utils_Type
::T_STRING
);
130 if ($value !== NULL) {
131 $defaults["{$fieldName}_value"] = explode(",", $value);
132 $defaults["{$fieldName}_op"] = $fieldOP;
139 * @param string $fieldName
143 public static function intParam($fieldName, &$field, &$defaults) {
144 $fieldOP = CRM_Utils_Array
::value("{$fieldName}_op", $_GET, 'eq');
153 $value = self
::getTypedValue("{$fieldName}_value", $field['type']);
154 if ($value !== NULL) {
155 $defaults["{$fieldName}_value"] = $value;
156 $defaults["{$fieldName}_op"] = $fieldOP;
162 $minValue = self
::getTypedValue("{$fieldName}_min", $field['type']);
163 $maxValue = self
::getTypedValue("{$fieldName}_max", $field['type']);
164 if ($minValue !== NULL ||
167 if ($minValue !== NULL) {
168 $defaults["{$fieldName}_min"] = $minValue;
170 if ($maxValue !== NULL) {
171 $defaults["{$fieldName}_max"] = $maxValue;
173 $defaults["{$fieldName}_op"] = $fieldOP;
179 // send the type as string so that multiple values can also be retrieved from url.
180 // for e.g url like - "memtype_in=in&memtype_value=1,2,3"
181 $value = self
::getTypedValue("{$fieldName}_value", CRM_Utils_Type
::T_STRING
);
182 if (!preg_match('/^(\d+)(,\d+){0,14}$/', $value)) {
183 // extra check. Also put a limit of 15 max values.
186 if ($value !== NULL) {
187 $defaults["{$fieldName}_value"] = explode(",", $value);
188 $defaults["{$fieldName}_op"] = $fieldOP;
197 public static function processChart(&$defaults) {
198 $chartType = CRM_Utils_Array
::value("charts", $_GET);
199 if (in_array($chartType, array(
203 $defaults["charts"] = $chartType;
211 public static function processFilter(&$fieldGrp, &$defaults) {
212 // process only filters for now
213 foreach ($fieldGrp as $tableName => $fields) {
214 foreach ($fields as $fieldName => $field) {
215 switch (CRM_Utils_Array
::value('type', $field)) {
216 case CRM_Utils_Type
::T_INT
:
217 case CRM_Utils_Type
::T_FLOAT
:
218 case CRM_Utils_Type
::T_MONEY
:
219 self
::intParam($fieldName, $field, $defaults);
222 case CRM_Utils_Type
::T_DATE
:
223 case CRM_Utils_Type
::T_DATE | CRM_Utils_Type
::T_TIME
:
224 self
::dateParam($fieldName, $field, $defaults);
227 case CRM_Utils_Type
::T_STRING
:
229 self
::stringParam($fieldName, $field, $defaults);
237 * unset default filters.
240 public static function unsetFilters(&$defaults) {
241 static $unsetFlag = TRUE;
243 foreach ($defaults as $field_name => $field_value) {
244 $newstr = substr($field_name, strrpos($field_name, '_'));
245 if ($newstr == '_value' ||
$newstr == '_op' ||
246 $newstr == '_min' ||
$newstr == '_max' ||
247 $newstr == '_from' ||
$newstr == '_to' ||
248 $newstr == '_relative'
250 unset($defaults[$field_name]);
261 public static function processGroupBy(&$fieldGrp, &$defaults) {
262 // process only group_bys for now
265 if (is_array($fieldGrp)) {
266 foreach ($fieldGrp as $tableName => $fields) {
267 if ($groupBys = CRM_Utils_Array
::value("gby", $_GET)) {
268 $groupBys = explode(' ', $groupBys);
269 if (!empty($groupBys)) {
271 unset($defaults['group_bys']);
274 foreach ($groupBys as $gby) {
275 if (array_key_exists($gby, $fields)) {
276 $defaults['group_bys'][$gby] = 1;
286 * @param $reportFields
289 public static function processFields(&$reportFields, &$defaults) {
290 //add filters from url
291 if (is_array($reportFields)) {
292 if ($urlFields = CRM_Utils_Array
::value("fld", $_GET)) {
293 $urlFields = explode(',', $urlFields);
295 if (CRM_Utils_Array
::value("ufld", $_GET) == 1) {
296 // unset all display columns
297 $defaults['fields'] = array();
299 if (!empty($urlFields)) {
300 foreach ($reportFields as $tableName => $fields) {
301 foreach ($urlFields as $fld) {
302 if (array_key_exists($fld, $fields)) {
303 $defaults['fields'][$fld] = 1;