crm.fsf.org/20131203/files/sites/all/modules-new/civicrm/CRM/Case/BAO/Query.php

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