CRM/Case/BAO/Query.php

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