CRM/Report/Utils/Get.php

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