CRM/Case/BAO/Query.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.5                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   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  +--------------------------------------------------------------------+
  26 */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2014
  32  * $Id$
  33  *
  34  */
  35 class CRM_Case_BAO_Query {
  36
  37   /**
  38    * @param bool $excludeActivityFields
  39    *
  40    * @return array
  41    */
  42   static function &getFields($excludeActivityFields = FALSE) {
  43     $fields = array();
  44     $fields = CRM_Case_BAO_Case::exportableFields();
  45
  46     // add activity related fields
  47     if (!$excludeActivityFields) {
  48       $fields = array_merge($fields, CRM_Activity_BAO_Activity::exportableFields('Case'));
  49     }
  50
  51     return $fields;
  52   }
  53
  54   /**
  55    * build select for Case
  56    *
  57    * @param $query
  58    *
  59    * @return void
  60    * @access public
  61    */
  62   static function select(&$query) {
  63     if (($query->_mode & CRM_Contact_BAO_Query::MODE_CASE) || !empty($query->_returnProperties['case_id'])) {
  64       $query->_select['case_id'] = "civicrm_case.id as case_id";
  65       $query->_element['case_id'] = 1;
  66       $query->_tables['civicrm_case'] = $query->_whereTables['civicrm_case'] = 1;
  67       $query->_tables['civicrm_case_contact'] = $query->_whereTables['civicrm_case_contact'] = 1;
  68     }
  69
  70     if (!empty($query->_returnProperties['case_type_id'])) {
  71       $query->_select['case_type_id'] = "civicrm_case_type.id as case_type_id";
  72       $query->_element['case_type_id'] = 1;
  73       $query->_tables['case_type'] = $query->_whereTables['case_type'] = 1;
  74       $query->_tables['civicrm_case'] = $query->_whereTables['civicrm_case'] = 1;
  75     }
  76
  77     if (!empty($query->_returnProperties['case_type'])) {
  78       $query->_select['case_type'] = "civicrm_case_type.title as case_type";
  79       $query->_element['case_type'] = 1;
  80       $query->_tables['case_type'] = $query->_whereTables['case_type'] = 1;
  81       $query->_tables['civicrm_case'] = $query->_whereTables['civicrm_case'] = 1;
  82     }
  83
  84     if (!empty($query->_returnProperties['case_start_date'])) {
  85       $query->_select['case_start_date'] = "civicrm_case.start_date as case_start_date";
  86       $query->_element['case_start_date'] = 1;
  87       $query->_tables['civicrm_case'] = 1;
  88     }
  89
  90     if (!empty($query->_returnProperties['case_end_date'])) {
  91       $query->_select['case_end_date'] = "civicrm_case.end_date as case_end_date";
  92       $query->_element['case_end_date'] = 1;
  93       $query->_tables['civicrm_case'] = 1;
  94     }
  95
  96     if (!empty($query->_returnProperties['case_status_id'])) {
  97       $query->_select['case_status_id'] = "case_status.id as case_status_id";
  98       $query->_element['case_status_id'] = 1;
  99       $query->_tables['case_status_id'] = $query->_whereTables['case_status_id'] = 1;
 100       $query->_tables['civicrm_case'] = $query->_whereTables['civicrm_case'] = 1;
 101     }
 102
 103     if (!empty($query->_returnProperties['case_status'])) {
 104       $query->_select['case_status'] = "case_status.label as case_status";
 105       $query->_element['case_status'] = 1;
 106       $query->_tables['case_status_id'] = $query->_whereTables['case_status_id'] = 1;
 107       $query->_tables['civicrm_case'] = $query->_whereTables['civicrm_case'] = 1;
 108     }
 109
 110     if (!empty($query->_returnProperties['case_deleted'])) {
 111       $query->_select['case_deleted'] = "civicrm_case.is_deleted as case_deleted";
 112       $query->_element['case_deleted'] = 1;
 113       $query->_tables['civicrm_case'] = $query->_whereTables['civicrm_case'] = 1;
 114     }
 115
 116     if (!empty($query->_returnProperties['case_role'])) {
 117       $query->_select['case_role'] = "case_relation_type.label_b_a as case_role";
 118       $query->_element['case_role'] = 1;
 119       $query->_tables['case_relationship'] = $query->_whereTables['case_relationship'] = 1;
 120       $query->_tables['case_relation_type'] = $query->_whereTables['case_relation_type'] = 1;
 121     }
 122
 123     if (!empty($query->_returnProperties['case_recent_activity_date'])) {
 124       $query->_select['case_recent_activity_date'] = "case_activity.activity_date_time as case_recent_activity_date";
 125       $query->_element['case_recent_activity_date'] = 1;
 126       $query->_tables['case_activity'] = $query->_whereTables['case_activity'] = 1;
 127     }
 128
 129     if (!empty($query->_returnProperties['case_activity_subject'])) {
 130       $query->_select['case_activity_subject'] = "case_activity.subject as case_activity_subject";
 131       $query->_element['case_activity_subject'] = 1;
 132       $query->_tables['case_activity'] = 1;
 133       $query->_tables['civicrm_case_contact'] = 1;
 134       $query->_tables['civicrm_case'] = 1;
 135     }
 136
 137     if (!empty($query->_returnProperties['case_subject'])) {
 138       $query->_select['case_subject'] = "civicrm_case.subject as case_subject";
 139       $query->_element['case_subject'] = 1;
 140       $query->_tables['civicrm_case_contact'] = 1;
 141       $query->_tables['civicrm_case'] = 1;
 142     }
 143
 144     if (!empty($query->_returnProperties['case_source_contact_id'])) {
 145       $query->_select['case_source_contact_id'] = "civicrm_case_reporter.sort_name as case_source_contact_id";
 146       $query->_element['case_source_contact_id'] = 1;
 147       $query->_tables['civicrm_case_reporter'] = 1;
 148       $query->_tables['case_activity'] = 1;
 149       $query->_tables['civicrm_case_contact'] = 1;
 150       $query->_tables['civicrm_case'] = 1;
 151     }
 152
 153     if (!empty($query->_returnProperties['case_activity_status_id'])) {
 154       $query->_select['case_activity_status_id'] = "rec_activity_status.id as case_activity_status_id";
 155       $query->_element['case_activity_status_id'] = 1;
 156       $query->_tables['case_activity'] = 1;
 157       $query->_tables['recent_activity_status'] = 1;
 158       $query->_tables['civicrm_case_contact'] = 1;
 159       $query->_tables['civicrm_case'] = 1;
 160     }
 161
 162     if (!empty($query->_returnProperties['case_activity_status'])) {
 163       $query->_select['case_activity_status'] = "rec_activity_status.label as case_activity_status";
 164       $query->_element['case_activity_status'] = 1;
 165       $query->_tables['case_activity'] = 1;
 166       $query->_tables['recent_activity_status'] = 1;
 167       $query->_tables['civicrm_case_contact'] = 1;
 168       $query->_tables['civicrm_case'] = 1;
 169     }
 170
 171     if (!empty($query->_returnProperties['case_activity_duration'])) {
 172       $query->_select['case_activity_duration'] = "case_activity.duration as case_activity_duration";
 173       $query->_element['case_activity_duration'] = 1;
 174       $query->_tables['case_activity'] = 1;
 175       $query->_tables['civicrm_case_contact'] = 1;
 176       $query->_tables['civicrm_case'] = 1;
 177     }
 178
 179     if (!empty($query->_returnProperties['case_activity_medium_id'])) {
 180       $query->_select['case_activity_medium_id'] = "recent_activity_medium.label as case_activity_medium_id";
 181       $query->_element['case_activity_medium_id'] = 1;
 182       $query->_tables['case_activity'] = 1;
 183       $query->_tables['case_activity_medium'] = 1;
 184       $query->_tables['civicrm_case_contact'] = 1;
 185       $query->_tables['civicrm_case'] = 1;
 186     }
 187
 188     if (!empty($query->_returnProperties['case_activity_details'])) {
 189       $query->_select['case_activity_details'] = "case_activity.details as case_activity_details";
 190       $query->_element['case_activity_details'] = 1;
 191       $query->_tables['case_activity'] = 1;
 192       $query->_tables['civicrm_case_contact'] = 1;
 193       $query->_tables['civicrm_case'] = 1;
 194     }
 195
 196     if (!empty($query->_returnProperties['case_activity_is_auto'])) {
 197       $query->_select['case_activity_is_auto'] = "case_activity.is_auto as case_activity_is_auto";
 198       $query->_element['case_activity_is_auto'] = 1;
 199       $query->_tables['case_activity'] = 1;
 200       $query->_tables['civicrm_case_contact'] = 1;
 201       $query->_tables['civicrm_case'] = 1;
 202     }
 203
 204     if (!empty($query->_returnProperties['case_scheduled_activity_date'])) {
 205       $query->_select['case_scheduled_activity_date'] = "case_activity.activity_date_time as case_scheduled_activity_date";
 206       $query->_element['case_scheduled_activity_date'] = 1;
 207       $query->_tables['case_activity'] = 1;
 208       $query->_tables['civicrm_case_contact'] = 1;
 209       $query->_tables['civicrm_case'] = 1;
 210     }
 211     if (!empty($query->_returnProperties['case_recent_activity_type'])) {
 212       $query->_select['case_recent_activity_type'] = "rec_activity_type.label as case_recent_activity_type";
 213       $query->_element['case_recent_activity_type'] = 1;
 214       $query->_tables['case_activity'] = 1;
 215       $query->_tables['case_activity_type'] = 1;
 216       $query->_tables['civicrm_case_contact'] = 1;
 217       $query->_tables['civicrm_case'] = 1;
 218     }
 219   }
 220
 221   /**
 222    * Given a list of conditions in query generate the required
 223    * where clause
 224    *
 225    * @param $query
 226    *
 227    * @return void
 228    * @access public
 229    */
 230   static function where(&$query) {
 231     foreach ($query->_params as $id => $values) {
 232       if (!is_array($values) || count($values) != 5) {
 233         continue;
 234       }
 235
 236       if (substr($query->_params[$id][0], 0, 5) == 'case_') {
 237         if ($query->_mode == CRM_Contact_BAO_Query::MODE_CONTACTS) {
 238           $query->_useDistinct = TRUE;
 239         }
 240         $grouping = $query->_params[$id][3];
 241         self::whereClauseSingle($query->_params[$id], $query);
 242       }
 243     }
 244   }
 245
 246   /**
 247    * where clause for a single field
 248    *
 249    * @param $values
 250    * @param $query
 251    *
 252    * @return void
 253    * @access public
 254    */
 255   static function whereClauseSingle(&$values, &$query) {
 256     list($name, $op, $value, $grouping, $wildcard) = $values;
 257     $val = $names = array();
 258     switch ($name) {
 259       case 'case_status':
 260       case 'case_status_id':
 261         $statuses = CRM_Case_PseudoConstant::caseStatus();
 262         // Standardize input from checkboxes or single value
 263         if (is_array($value)) {
 264           $value = array_keys($value, 1);
 265         }
 266         foreach ((array) $value as $k) {
 267           if ($k && isset($statuses[$k])) {
 268             $val[$k] = $k;
 269             $names[] = $statuses[$k];
 270           }
 271           elseif ($k && ($v = CRM_Utils_Array::key($k, $statuses))) {
 272             $val[$v] = $v;
 273             $names[] = $k;
 274           }
 275         }
 276         if ($val) {
 277           $query->_where[$grouping][] = "civicrm_case.status_id IN (" . implode(',', $val) . ")";
 278           $query->_qill[$grouping][] = ts('Case Status is %1', array(1 => implode(' ' . ts('or') . ' ', $names)));
 279           $query->_tables['civicrm_case'] = $query->_whereTables['civicrm_case'] = 1;
 280         }
 281         return;
 282
 283       case 'case_type_id':
 284         $caseTypes = CRM_Case_PseudoConstant::caseType('title', FALSE);
 285
 286         if (is_array($value)) {
 287           foreach ($value as $k => $v) {
 288             if ($v) {
 289               $val[$k] = $k;
 290               $names[] = $caseTypes[$k];
 291             }
 292           }
 293         }
 294         elseif (is_numeric($value)) {
 295           $val[$value] = $value;
 296           $names[] = $value;
 297         }
 298         elseif ($caseTypeId = CRM_Utils_Array::key($value, $caseTypes)) {
 299           $val[$caseTypeId] = $caseTypeId;
 300           $names[] = $caseTypes[$caseTypeId];
 301         }
 302
 303         $query->_where[$grouping][] = "(civicrm_case.case_type_id IN (" . implode(',', $val) . "))";
 304
 305         $query->_qill[$grouping][] = ts('Case Type is %1', array(1 => implode(' ' . ts('or') . ' ', $names)));
 306         $query->_tables['civicrm_case'] = $query->_whereTables['civicrm_case'] = 1;
 307         return;
 308
 309       case 'case_id':
 310         $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_case.id", $op, $value, 'Int');
 311         $query->_tables['civicrm_case'] = $query->_whereTables['civicrm_case'] = 1;
 312         return;
 313
 314       case 'case_owner':
 315       case 'case_mycases':
 316         if (!empty($value)) {
 317           if ($value == 2) {
 318             $session = CRM_Core_Session::singleton();
 319             $userID = $session->get('userID');
 320             $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("case_relationship.contact_id_b", $op, $userID, 'Int');
 321             $query->_qill[$grouping][] = ts('Case %1 My Cases', array(1 => $op));
 322             $query->_tables['case_relationship'] = $query->_whereTables['case_relationship'] = 1;
 323           }
 324           elseif ($value == 1) {
 325             $query->_qill[$grouping][] = ts('Case %1 All Cases', array(1 => $op));
 326             $query->_where[$grouping][] = "civicrm_case_contact.contact_id = contact_a.id";
 327           }
 328           $query->_tables['civicrm_case'] = $query->_whereTables['civicrm_case'] = 1;
 329           $query->_tables['civicrm_case_contact'] = $query->_whereTables['civicrm_case_contact'] = 1;
 330         }
 331         return;
 332
 333       case 'case_deleted':
 334         $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_case.is_deleted", $op, $value, 'Boolean');
 335         if ($value) {
 336           $query->_qill[$grouping][] = ts("Find Deleted Cases");
 337         }
 338         $query->_tables['civicrm_case'] = $query->_whereTables['civicrm_case'] = 1;
 339         return;
 340
 341       case 'case_activity_subject':
 342         $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("case_activity.subject", $op, $value, 'String');
 343         $query->_qill[$grouping][] = ts("Activity Subject %1 '%2'", array(1 => $op, 2 => $value));
 344         $query->_tables['case_activity'] = $query->_whereTables['case_activity'] = 1;
 345         $query->_tables['civicrm_case'] = $query->_whereTables['civicrm_case'] = 1;
 346         $query->_tables['civicrm_case_contact'] = $query->_whereTables['civicrm_case_contact'] = 1;
 347         return;
 348
 349       case 'case_subject':
 350         $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_case.subject", $op, $value, 'String');
 351         $query->_qill[$grouping][] = ts("Case Subject %1 '%2'", array(1 => $op, 2 => $value));
 352         $query->_tables['civicrm_case'] = $query->_whereTables['civicrm_case'] = 1;
 353         $query->_tables['civicrm_case_contact'] = $query->_whereTables['civicrm_case_contact'] = 1;
 354         return;
 355
 356       case 'case_source_contact_id':
 357         $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_case_reporter.sort_name", $op, $value, 'String');
 358         $query->_qill[$grouping][] = ts("Activity Reporter %1 '%2'", array(1 => $op, 2 => $value));
 359         $query->_tables['case_activity'] = $query->_whereTables['case_activity'] = 1;
 360         $query->_tables['civicrm_case_reporter'] = $query->_whereTables['civicrm_case_reporter'] = 1;
 361         $query->_tables['civicrm_case'] = $query->_whereTables['civicrm_case'] = 1;
 362         $query->_tables['civicrm_case_contact'] = $query->_whereTables['civicrm_case_contact'] = 1;
 363         return;
 364
 365       case 'case_recent_activity_date':
 366         $date = CRM_Utils_Date::format($value);
 367         $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("case_activity.activity_date_time", $op, $date, 'Date');
 368         if ($date) {
 369           $date = CRM_Utils_Date::customFormat($date);
 370           $query->_qill[$grouping][] = ts("Activity Actual Date %1 %2", array(1 => $op, 2 => $date));
 371         }
 372         $query->_tables['case_activity'] = $query->_whereTables['case_activity'] = 1;
 373         $query->_tables['civicrm_case'] = $query->_whereTables['civicrm_case'] = 1;
 374         $query->_tables['civicrm_case_contact'] = $query->_whereTables['civicrm_case_contact'] = 1;
 375         return;
 376
 377       case 'case_scheduled_activity_date':
 378         $date = CRM_Utils_Date::format($value);
 379         $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("case_activity.activity_date_time", $op, $date, 'Date');
 380         if ($date) {
 381           $date = CRM_Utils_Date::customFormat($date);
 382           $query->_qill[$grouping][] = ts("Activity Schedule Date %1 %2", array(1 => $op, 2 => $date));
 383         }
 384         $query->_tables['case_activity'] = $query->_whereTables['case_activity'] = 1;
 385         $query->_tables['civicrm_case'] = $query->_whereTables['civicrm_case'] = 1;
 386         $query->_tables['civicrm_case_contact'] = $query->_whereTables['civicrm_case_contact'] = 1;
 387         return;
 388
 389       case 'case_recent_activity_type':
 390         $names = $value;
 391         if ($activityType = CRM_Core_OptionGroup::getLabel('activity_type', $value, 'value')) {
 392           $names = $activityType;
 393         }
 394
 395         $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("case_activity.activity_type_id", $op, $value, 'Int');
 396         $query->_qill[$grouping][] = ts("Activity Type %1 %2", array(1 => $op, 2 => $names));
 397         $query->_tables['case_activity'] = $query->_whereTables['case_activity'] = 1;
 398         $query->_tables['civicrm_case'] = $query->_whereTables['civicrm_case'] = 1;
 399         $query->_tables['case_activity_type'] = 1;
 400         $query->_tables['civicrm_case_contact'] = $query->_whereTables['civicrm_case_contact'] = 1;
 401         return;
 402
 403       case 'case_activity_status_id':
 404         $names = $value;
 405         if ($activityStatus = CRM_Core_OptionGroup::getLabel('activity_status', $value, 'value')) {
 406           $names = $activityStatus;
 407         }
 408
 409         $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("case_activity.status_id", $op, $value, 'Int');
 410         $query->_qill[$grouping][] = ts("Activity Type %1 %2", array(1 => $op, 2 => $names));
 411         $query->_tables['case_activity'] = $query->_whereTables['case_activity'] = 1;
 412         $query->_tables['civicrm_case'] = $query->_whereTables['civicrm_case'] = 1;
 413         $query->_tables['case_activity_status'] = 1;
 414         $query->_tables['civicrm_case_contact'] = $query->_whereTables['civicrm_case_contact'] = 1;
 415         return;
 416
 417       case 'case_activity_duration':
 418         $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("case_activity.duration", $op, $value, 'Int');
 419         $query->_qill[$grouping][] = ts("Activity Duration %1 %2", array(1 => $op, 2 => $value));
 420         $query->_tables['case_activity'] = $query->_whereTables['case_activity'] = 1;
 421         $query->_tables['civicrm_case'] = $query->_whereTables['civicrm_case'] = 1;
 422         $query->_tables['civicrm_case_contact'] = $query->_whereTables['civicrm_case_contact'] = 1;
 423         return;
 424
 425       case 'case_activity_medium_id':
 426         $names = $value;
 427         if ($activityMedium = CRM_Core_OptionGroup::getLabel('encounter_medium', $value, 'value')) {
 428           $names = $activityMedium;
 429         }
 430
 431         $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("case_activity.medium_id", $op, $value, 'Int');
 432         $query->_qill[$grouping][] = ts("Activity Medium %1 %2", array(1 => $op, 2 => $names));
 433         $query->_tables['case_activity'] = $query->_whereTables['case_activity'] = 1;
 434         $query->_tables['civicrm_case'] = $query->_whereTables['civicrm_case'] = 1;
 435         $query->_tables['case_activity_medium'] = 1;
 436         $query->_tables['civicrm_case_contact'] = $query->_whereTables['civicrm_case_contact'] = 1;
 437         return;
 438
 439       case 'case_activity_details':
 440         $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("case_activity.details", $op, $value, 'String');
 441         $query->_qill[$grouping][] = ts("Activity Details %1 '%2'", array(1 => $op, 2 => $value));
 442         $query->_tables['case_activity'] = $query->_whereTables['case_activity'] = 1;
 443         $query->_tables['civicrm_case'] = $query->_whereTables['civicrm_case'] = 1;
 444         $query->_tables['civicrm_case_contact'] = $query->_whereTables['civicrm_case_contact'] = 1;
 445         return;
 446
 447       case 'case_activity_is_auto':
 448         $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("case_activity.is_auto", $op, $value, 'Boolean');
 449         $query->_qill[$grouping][] = ts("Activity Auto Genrated %1 '%2'", array(1 => $op, 2 => $value));
 450         $query->_tables['case_activity'] = $query->_whereTables['case_activity'] = 1;
 451         $query->_tables['civicrm_case'] = $query->_whereTables['civicrm_case'] = 1;
 452         $query->_tables['civicrm_case_contact'] = $query->_whereTables['civicrm_case_contact'] = 1;
 453         return;
 454
 455       // adding where clause for case_role
 456
 457       case 'case_role':
 458         $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("case_relation_type.name_b_a", $op, $value, 'String');
 459         $query->_qill[$grouping][] = ts("Role in Case  %1 '%2'", array(1 => $op, 2 => $value));
 460         $query->_tables['case_relation_type'] = $query->_whereTables['case_relationship_type'] = 1;
 461         $query->_tables['civicrm_case'] = $query->_whereTables['civicrm_case'] = 1;
 462         $query->_tables['civicrm_case_contact'] = $query->_whereTables['civicrm_case_contact'] = 1;
 463         return;
 464
 465       case 'case_from_start_date_low':
 466       case 'case_from_start_date_high':
 467         $query->dateQueryBuilder($values,
 468           'civicrm_case', 'case_from_start_date', 'start_date', 'Start Date'
 469         );
 470         return;
 471
 472       case 'case_to_end_date_low':
 473       case 'case_to_end_date_high':
 474         $query->dateQueryBuilder($values,
 475           'civicrm_case', 'case_to_end_date', 'end_date', 'End Date'
 476         );
 477         return;
 478
 479       case 'case_start_date':
 480         $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_case.start_date", $op, $value, 'Int');
 481         $query->_tables['civicrm_case'] = $query->_whereTables['civicrm_case'] = 1;
 482         return;
 483
 484       case 'case_end_date':
 485         $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_case.end_date", $op, $value, 'Int');
 486         $query->_tables['civicrm_case'] = $query->_whereTables['civicrm_case'] = 1;
 487         return;
 488
 489       case 'case_taglist':
 490         $taglist = $value;
 491         $value = array();
 492         foreach ($taglist as $val) {
 493           if ($val) {
 494             $val = explode(',', $val);
 495             foreach ($val as $tId) {
 496               if (is_numeric($tId)) {
 497                 $value[$tId] = 1;
 498               }
 499             }
 500           }
 501         }
 502       case 'case_tags':
 503         $tags = CRM_Core_PseudoConstant::get('CRM_Core_DAO_EntityTag', 'tag_id', array('onlyActive' => FALSE));
 504
 505         if (is_array($value)) {
 506           foreach ($value as $k => $v) {
 507             if ($v) {
 508               $val[$k] = $k;
 509               $names[] = $tags[$k];
 510             }
 511           }
 512         }
 513
 514         $query->_where[$grouping][] = " civicrm_case_tag.tag_id IN (" . implode(',', $val) . " )";
 515         $query->_qill[$grouping][] = ts('Case Tags %1', array(1 => $op)) . ' ' . implode(' ' . ts('or') . ' ', $names);
 516         $query->_tables['civicrm_case'] = $query->_whereTables['civicrm_case'] = 1;
 517         $query->_tables['civicrm_case_contact'] = $query->_whereTables['civicrm_case_contact'] = 1;
 518         $query->_tables['civicrm_case_tag'] = $query->_whereTables['civicrm_case_tag'] = 1;
 519         return;
 520     }
 521   }
 522
 523   /**
 524    * @param $name
 525    * @param $mode
 526    * @param $side
 527    *
 528    * @return string
 529    */
 530   static function from($name, $mode, $side) {
 531     $from = "";
 532
 533     switch ($name) {
 534       case 'civicrm_case_contact':
 535         $from .= " $side JOIN civicrm_case_contact ON civicrm_case_contact.contact_id = contact_a.id ";
 536         break;
 537
 538       case 'civicrm_case_reporter':
 539         $activityContacts = CRM_Core_OptionGroup::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
 540         $sourceID = CRM_Utils_Array::key('Activity Source', $activityContacts);
 541         $from .= " $side JOIN civicrm_activity_contact as case_activity_contact ON (case_activity.id = case_activity_contact.activity_id AND  case_activity_contact.record_type_id = {$sourceID} ) ";
 542         $from .= " $side JOIN civicrm_contact as civicrm_case_reporter ON case_activity_contact.contact_id = civicrm_case_reporter.id ";
 543         break;
 544
 545       case 'civicrm_case':
 546         $from .= " INNER JOIN civicrm_case ON civicrm_case_contact.case_id = civicrm_case.id";
 547         break;
 548
 549       case 'case_status_id':
 550         $from .= " $side JOIN civicrm_option_group option_group_case_status ON (option_group_case_status.name = 'case_status')";
 551         $from .= " $side JOIN civicrm_option_value case_status ON (civicrm_case.status_id = case_status.value AND option_group_case_status.id = case_status.option_group_id ) ";
 552         break;
 553
 554       case 'case_type':
 555         $from .= " $side JOIN civicrm_case_type ON civicrm_case.case_type_id = civicrm_case_type.id ";
 556         break;
 557
 558       case 'case_activity_type':
 559         $from .= " $side JOIN civicrm_option_group option_group_activity_type ON (option_group_activity_type.name = 'activity_type')";
 560         $from .= " $side JOIN civicrm_option_value rec_activity_type ON (case_activity.activity_type_id = rec_activity_type.value AND option_group_activity_type.id = rec_activity_type.option_group_id ) ";
 561         break;
 562
 563       case 'recent_activity_status':
 564         $from .= " $side JOIN civicrm_option_group option_group_activity_status ON (option_group_activity_status.name = 'activity_status')";
 565         $from .= " $side JOIN civicrm_option_value rec_activity_status ON (case_activity.status_id = rec_activity_status.value AND option_group_activity_status.id = rec_activity_status.option_group_id ) ";
 566         break;
 567
 568       case 'case_relationship':
 569         $session = CRM_Core_Session::singleton();
 570         $userID  = $session->get('userID');
 571         $from   .= " $side JOIN civicrm_relationship case_relationship ON ( case_relationship.contact_id_a = civicrm_case_contact.contact_id AND case_relationship.contact_id_b = {$userID} AND case_relationship.case_id = civicrm_case.id )";
 572         break;
 573
 574       case 'case_relation_type':
 575         $from .= " $side JOIN civicrm_relationship_type case_relation_type ON ( case_relation_type.id = case_relationship.relationship_type_id AND
 576 case_relation_type.id = case_relationship.relationship_type_id )";
 577         break;
 578
 579       case 'case_activity_medium':
 580         $from .= " $side JOIN civicrm_option_group option_group_activity_medium ON (option_group_activity_medium.name = 'encounter_medium')";
 581         $from .= " $side JOIN civicrm_option_value recent_activity_medium ON (case_activity.medium_id = recent_activity_medium.value AND option_group_activity_medium.id = recent_activity_medium.option_group_id ) ";
 582         break;
 583
 584       case 'case_activity':
 585         $from .= " INNER JOIN civicrm_case_activity ON civicrm_case_activity.case_id = civicrm_case.id ";
 586         $from .= " INNER JOIN civicrm_activity case_activity ON ( civicrm_case_activity.activity_id = case_activity.id
 587                                                                 AND case_activity.is_current_revision = 1 )";
 588         break;
 589
 590       case 'civicrm_case_tag':
 591         $from .= " $side JOIN civicrm_entity_tag as civicrm_case_tag ON ( civicrm_case_tag.entity_table = 'civicrm_case' AND civicrm_case_tag.entity_id = civicrm_case.id ) ";
 592         break;
 593     }
 594     return $from;
 595   }
 596
 597   /**
 598    * getter for the qill object
 599    *
 600    * @return string
 601    * @access public
 602    */
 603   function qill() {
 604     return (isset($this->_qill)) ? $this->_qill : "";
 605   }
 606
 607   /**
 608    * @param $mode
 609    * @param bool $includeCustomFields
 610    *
 611    * @return array|null
 612    */
 613   static function defaultReturnProperties($mode,
 614     $includeCustomFields = TRUE
 615   ) {
 616
 617     $properties = NULL;
 618
 619     if ($mode & CRM_Contact_BAO_Query::MODE_CASE) {
 620       $properties = array(
 621         'contact_type' => 1,
 622         'contact_sub_type' => 1,
 623         'contact_id' => 1,
 624         'sort_name' => 1,
 625         'display_name' => 1,
 626         'case_id' => 1,
 627         'case_activity_subject' => 1,
 628         'case_subject' => 1,
 629         'case_status' => 1,
 630         'case_type' => 1,
 631         'case_role' => 1,
 632         'case_deleted' => 1,
 633         'case_recent_activity_date' => 1,
 634         'case_recent_activity_type' => 1,
 635         'case_scheduled_activity_date' => 1,
 636         'phone' => 1,
 637         // 'case_scheduled_activity_type'=>      1
 638       );
 639
 640       if ($includeCustomFields) {
 641         // also get all the custom case properties
 642         $fields = CRM_Core_BAO_CustomField::getFieldsForImport('Case');
 643         if (!empty($fields)) {
 644           foreach ($fields as $name => $dontCare) {
 645             $properties[$name] = 1;
 646           }
 647         }
 648       }
 649     }
 650
 651     return $properties;
 652   }
 653
 654   /**
 655    * This includes any extra fields that might need for export etc
 656    */
 657   static function extraReturnProperties($mode) {
 658     $properties = NULL;
 659
 660     if ($mode & CRM_Contact_BAO_Query::MODE_CASE) {
 661       $properties = array(
 662         'case_start_date' => 1,
 663         'case_end_date' => 1,
 664         'case_subject' => 1,
 665         'case_source_contact_id' => 1,
 666         'case_activity_status' => 1,
 667         'case_activity_duration' => 1,
 668         'case_activity_medium_id' => 1,
 669         'case_activity_details' => 1,
 670         'case_activity_is_auto' => 1,
 671       );
 672     }
 673     return $properties;
 674   }
 675
 676   /**
 677    * @param $tables
 678    */
 679   static function tableNames(&$tables) {
 680     if (!empty($tables['civicrm_case'])) {
 681       $tables = array_merge(array('civicrm_case_contact' => 1), $tables);
 682     }
 683
 684     if (!empty($tables['case_relation_type'])) {
 685       $tables = array_merge(array('case_relationship' => 1), $tables);
 686     }
 687   }
 688
 689   /**
 690    * add all the elements shared between case search and advanaced search
 691    *
 692    * @access public
 693    *
 694    * @param $form
 695    *
 696    * @return void
 697    * @static
 698    */
 699   static function buildSearchForm(&$form) {
 700     $config = CRM_Core_Config::singleton();
 701
 702     //validate case configuration.
 703     $configured = CRM_Case_BAO_Case::isCaseConfigured();
 704     $form->assign('notConfigured', !$configured['configured']);
 705
 706     $caseTypes = CRM_Case_PseudoConstant::caseType('title', FALSE);
 707     foreach ($caseTypes as $id => $name) {
 708       $form->addElement('checkbox', "case_type_id[$id]", NULL, $name);
 709     }
 710
 711     $statuses = CRM_Case_PseudoConstant::caseStatus('label', FALSE);
 712     foreach ($statuses as $id => $name) {
 713       $form->addElement('checkbox', "case_status_id[$id]", NULL, $name);
 714     }
 715
 716     CRM_Core_Form_Date::buildDateRange($form, 'case_from', 1, '_start_date_low', '_start_date_high', ts('From'), FALSE);
 717     CRM_Core_Form_Date::buildDateRange($form, 'case_to',   1, '_end_date_low',   '_end_date_high',   ts('From'), FALSE);
 718
 719     $form->assign('validCiviCase', TRUE);
 720
 721     //give options when all cases are accessible.
 722     $accessAllCases = FALSE;
 723     if (CRM_Core_Permission::check('access all cases and activities')) {
 724       $accessAllCases = TRUE;
 725       $caseOwner = array(1 => ts('Search All Cases'), 2 => ts('Only My Cases'));
 726       $form->addRadio('case_owner', ts('Cases'), $caseOwner);
 727     }
 728     $form->assign('accessAllCases', $accessAllCases);
 729
 730     $caseTags = CRM_Core_BAO_Tag::getTags('civicrm_case');
 731
 732     if ($caseTags) {
 733       foreach ($caseTags as $tagID => $tagName) {
 734         $form->_tagElement = &$form->addElement('checkbox', "case_tags[$tagID]", NULL, $tagName);
 735       }
 736     }
 737
 738     $parentNames = CRM_Core_BAO_Tag::getTagSet('civicrm_case');
 739     CRM_Core_Form_Tag::buildQuickForm($form, $parentNames, 'civicrm_case', NULL, TRUE, FALSE);
 740
 741     if (CRM_Core_Permission::check('administer CiviCRM')) {
 742       $form->addElement('checkbox', 'case_deleted', ts('Deleted Cases'));
 743     }
 744
 745     // add all the custom  searchable fields
 746     $extends = array('Case');
 747     $groupDetails = CRM_Core_BAO_CustomGroup::getGroupDetail(NULL, TRUE, $extends);
 748     if ($groupDetails) {
 749       $form->assign('caseGroupTree', $groupDetails);
 750       foreach ($groupDetails as $group) {
 751         foreach ($group['fields'] as $field) {
 752           $fieldId = $field['id'];
 753           $elementName = 'custom_' . $fieldId;
 754           CRM_Core_BAO_CustomField::addQuickFormElement($form,
 755             $elementName,
 756             $fieldId,
 757             FALSE, FALSE, TRUE
 758           );
 759         }
 760       }
 761     }
 762     $form->setDefaults(array('case_owner' => 1));
 763   }
 764
 765   /**
 766    * @param $row
 767    * @param $id
 768    */
 769   static function searchAction(&$row, $id) {}
 770 }
 771