CRM/Activity/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_Activity_BAO_Query {
  18
  19   /**
  20    * Build select for Case.
  21    *
  22    * @param CRM_Contact_BAO_Query $query
  23    */
  24   public static function select(&$query) {
  25     if (!empty($query->_returnProperties['activity_id'])) {
  26       $query->_select['activity_id'] = 'civicrm_activity.id as activity_id';
  27       $query->_element['activity_id'] = 1;
  28       $query->_tables['civicrm_activity'] = $query->_whereTables['civicrm_activity'] = 1;
  29     }
  30
  31     if (!empty($query->_returnProperties['activity_type_id'])) {
  32       $query->_select['activity_type_id'] = 'activity_type.value as activity_type_id';
  33       $query->_element['activity_type_id'] = 1;
  34       $query->_tables['civicrm_activity'] = 1;
  35       $query->_tables['activity_type'] = 1;
  36       $query->_whereTables['civicrm_activity'] = 1;
  37       $query->_whereTables['activity_type'] = 1;
  38     }
  39
  40     if (!empty($query->_returnProperties['activity_type'])) {
  41       $query->_select['activity_type'] = 'activity_type.label as activity_type';
  42       $query->_element['activity_type'] = 1;
  43       $query->_tables['civicrm_activity'] = 1;
  44       $query->_tables['activity_type'] = 1;
  45       $query->_whereTables['civicrm_activity'] = 1;
  46       $query->_whereTables['activity_type'] = 1;
  47     }
  48
  49     if (!empty($query->_returnProperties['activity_subject'])) {
  50       $query->_select['activity_subject'] = 'civicrm_activity.subject as activity_subject';
  51       $query->_element['activity_subject'] = 1;
  52       $query->_tables['civicrm_activity'] = $query->_whereTables['civicrm_activity'] = 1;
  53     }
  54
  55     if (!empty($query->_returnProperties['activity_date_time'])) {
  56       $query->_select['activity_date_time'] = 'civicrm_activity.activity_date_time as activity_date_time';
  57       $query->_element['activity_date_time'] = 1;
  58       $query->_tables['civicrm_activity'] = $query->_whereTables['civicrm_activity'] = 1;
  59     }
  60
  61     if (!empty($query->_returnProperties['activity_status_id'])) {
  62       $query->_select['activity_status_id'] = 'civicrm_activity.status_id as activity_status_id';
  63       $query->_element['activity_status_id'] = 1;
  64       $query->_tables['civicrm_activity'] = 1;
  65       $query->_whereTables['civicrm_activity'] = 1;
  66     }
  67
  68     if (!empty($query->_returnProperties['activity_status'])) {
  69       $query->_select['activity_status'] = 'activity_status.label as activity_status,
  70       civicrm_activity.status_id as status_id';
  71       $query->_element['activity_status'] = 1;
  72       $query->_tables['civicrm_activity'] = 1;
  73       $query->_tables['activity_status'] = 1;
  74       $query->_whereTables['civicrm_activity'] = 1;
  75       $query->_whereTables['activity_status'] = 1;
  76     }
  77
  78     if (!empty($query->_returnProperties['activity_duration'])) {
  79       $query->_select['activity_duration'] = 'civicrm_activity.duration as activity_duration';
  80       $query->_element['activity_duration'] = 1;
  81       $query->_tables['civicrm_activity'] = $query->_whereTables['civicrm_activity'] = 1;
  82     }
  83
  84     if (!empty($query->_returnProperties['activity_location'])) {
  85       $query->_select['activity_location'] = 'civicrm_activity.location as activity_location';
  86       $query->_element['activity_location'] = 1;
  87       $query->_tables['civicrm_activity'] = $query->_whereTables['civicrm_activity'] = 1;
  88     }
  89
  90     if (!empty($query->_returnProperties['activity_details'])) {
  91       $query->_select['activity_details'] = 'civicrm_activity.details as activity_details';
  92       $query->_element['activity_details'] = 1;
  93       $query->_tables['civicrm_activity'] = $query->_whereTables['civicrm_activity'] = 1;
  94     }
  95
  96     if (!empty($query->_returnProperties['source_record_id'])) {
  97       $query->_select['source_record_id'] = 'civicrm_activity.source_record_id as source_record_id';
  98       $query->_element['source_record_id'] = 1;
  99       $query->_tables['civicrm_activity'] = $query->_whereTables['civicrm_activity'] = 1;
 100     }
 101
 102     if (!empty($query->_returnProperties['activity_is_test'])) {
 103       $query->_select['activity_is_test'] = 'civicrm_activity.is_test as activity_is_test';
 104       $query->_element['activity_is_test'] = 1;
 105       $query->_tables['civicrm_activity'] = $query->_whereTables['civicrm_activity'] = 1;
 106     }
 107
 108     if (!empty($query->_returnProperties['activity_campaign_id'])) {
 109       $query->_select['activity_campaign_id'] = 'civicrm_activity.campaign_id as activity_campaign_id';
 110       $query->_element['activity_campaign_id'] = 1;
 111       $query->_tables['civicrm_activity'] = $query->_whereTables['civicrm_activity'] = 1;
 112     }
 113
 114     if (!empty($query->_returnProperties['activity_engagement_level'])) {
 115       $query->_select['activity_engagement_level'] = 'civicrm_activity.engagement_level as activity_engagement_level';
 116       $query->_element['activity_engagement_level'] = 1;
 117       $query->_tables['civicrm_activity'] = $query->_whereTables['civicrm_activity'] = 1;
 118     }
 119
 120     if (!empty($query->_returnProperties['source_contact'])) {
 121       $query->_select['source_contact'] = 'source_contact.sort_name as source_contact';
 122       $query->_element['source_contact'] = 1;
 123       $query->_tables['civicrm_activity'] = $query->_tables['source_contact'] = $query->_whereTables['source_contact'] = 1;
 124     }
 125
 126     if (!empty($query->_returnProperties['source_contact_id'])) {
 127       $query->_select['source_contact_id'] = 'source_contact.id as source_contact_id';
 128       $query->_element['source_contact_id'] = 1;
 129       $query->_tables['civicrm_activity'] = $query->_tables['source_contact'] = $query->_whereTables['source_contact'] = 1;
 130     }
 131
 132     if (!empty($query->_returnProperties['activity_result'])) {
 133       $query->_select['activity_result'] = 'civicrm_activity.result as activity_result';
 134       $query->_element['result'] = 1;
 135       $query->_tables['civicrm_activity'] = $query->_whereTables['civicrm_activity'] = 1;
 136     }
 137
 138     if (CRM_Utils_Array::value('parent_id', $query->_returnProperties)) {
 139       $query->_tables['parent_id'] = 1;
 140       $query->_whereTables['parent_id'] = 1;
 141       $query->_element['parent_id'] = 1;
 142     }
 143
 144     if (!empty($query->_returnProperties['activity_priority'])) {
 145       $query->_select['activity_priority'] = 'activity_priority.label as activity_priority,
 146       civicrm_activity.priority_id as priority_id';
 147       $query->_element['activity_priority'] = 1;
 148       $query->_tables['activity_priority'] = 1;
 149       $query->_whereTables['activity_priority'] = 1;
 150       $query->_tables['civicrm_activity'] = $query->_whereTables['civicrm_activity'] = 1;
 151     }
 152   }
 153
 154   /**
 155    * Given a list of conditions in query generate the required where clause.
 156    *
 157    * @param $query
 158    */
 159   public static function where(&$query) {
 160     foreach (array_keys($query->_params) as $id) {
 161       if (substr($query->_params[$id][0], 0, 9) == 'activity_') {
 162         if ($query->_mode == CRM_Contact_BAO_Query::MODE_CONTACTS) {
 163           $query->_useDistinct = TRUE;
 164         }
 165         $query->_params[$id][3];
 166         self::whereClauseSingle($query->_params[$id], $query);
 167       }
 168     }
 169   }
 170
 171   /**
 172    * Where clause for a single field.
 173    *
 174    * @param array $values
 175    * @param CRM_Contact_BAO_Query $query
 176    */
 177   public static function whereClauseSingle(&$values, &$query) {
 178     list($name, $op, $value, $grouping) = $values;
 179
 180     $fields = CRM_Activity_BAO_Activity::exportableFields();
 181     $query->_tables['civicrm_activity'] = $query->_whereTables['civicrm_activity'] = 1;
 182     if ($query->_mode & CRM_Contact_BAO_Query::MODE_ACTIVITY) {
 183       $query->_skipDeleteClause = TRUE;
 184     }
 185
 186     switch ($name) {
 187       case 'activity_type_id':
 188       case 'activity_status_id':
 189       case 'activity_engagement_level':
 190       case 'activity_id':
 191       case 'activity_campaign_id':
 192       case 'activity_priority_id':
 193         // We no longer expect "subject" as a specific criteria (as of CRM-19447),
 194         // but we still use activity_subject in Activity.Get API
 195       case 'activity_subject':
 196
 197         $qillName = $name;
 198         if (in_array($name, ['activity_engagement_level', 'activity_id'])) {
 199           $name = $qillName = str_replace('activity_', '', $name);
 200         }
 201         if (in_array($name, [
 202           'activity_status_id',
 203           'activity_subject',
 204           'activity_priority_id',
 205         ])) {
 206           $name = str_replace('activity_', '', $name);
 207           $qillName = str_replace('_id', '', $qillName);
 208         }
 209         if ($name == 'activity_campaign_id') {
 210           $name = 'campaign_id';
 211         }
 212
 213         $dataType = !empty($fields[$qillName]['type']) ? CRM_Utils_Type::typeToString($fields[$qillName]['type']) : 'String';
 214
 215         $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_activity.$name", $op, $value, $dataType);
 216         list($op, $value) = CRM_Contact_BAO_Query::buildQillForFieldValue('CRM_Activity_DAO_Activity', $name, $value, $op);
 217         $query->_qill[$grouping][] = ts('%1 %2 %3', [
 218           1 => $fields[$qillName]['title'],
 219           2 => $op,
 220           3 => $value,
 221         ]);
 222         break;
 223
 224       case 'activity_text':
 225         self::whereClauseSingleActivityText($values, $query);
 226         break;
 227
 228       case 'activity_type':
 229       case 'activity_status':
 230       case 'activity_priority':
 231         $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("$name.label", $op, $value, 'String');
 232         list($op, $value) = CRM_Contact_BAO_Query::buildQillForFieldValue('CRM_Activity_DAO_Activity', $name, $value, $op);
 233         $query->_qill[$grouping][] = ts('%1 %2 %3', [
 234           1 => $fields[$name]['title'],
 235           2 => $op,
 236           3 => $value,
 237         ]);
 238         $query->_tables[$name] = $query->_whereTables[$name] = 1;
 239         break;
 240
 241       case 'activity_survey_id':
 242         if (!$value) {
 243           break;
 244         }
 245         $value = CRM_Utils_Type::escape($value, 'Integer');
 246         $query->_where[$grouping][] = " civicrm_activity.source_record_id = $value";
 247         $query->_qill[$grouping][] = ts('Survey') . ' - ' . CRM_Core_DAO::getFieldValue('CRM_Campaign_DAO_Survey', $value, 'title');
 248         break;
 249
 250       case 'activity_role':
 251         CRM_Contact_BAO_Query::$_activityRole = $values[2];
 252         $activityContacts = CRM_Activity_BAO_ActivityContact::buildOptions('record_type_id', 'validate');
 253         $sourceID = CRM_Utils_Array::key('Activity Source', $activityContacts);
 254         $assigneeID = CRM_Utils_Array::key('Activity Assignees', $activityContacts);
 255         $targetID = CRM_Utils_Array::key('Activity Targets', $activityContacts);
 256
 257         if ($values[2]) {
 258           $query->_tables['civicrm_activity_contact'] = $query->_whereTables['civicrm_activity_contact'] = 1;
 259           if ($values[2] == 1) {
 260             $query->_where[$grouping][] = " civicrm_activity_contact.record_type_id = $sourceID";
 261             $query->_qill[$grouping][] = ts('Activity created by');
 262           }
 263           elseif ($values[2] == 2) {
 264             $query->_where[$grouping][] = " civicrm_activity_contact.record_type_id = $assigneeID";
 265             $query->_qill[$grouping][] = ts('Activity assigned to');
 266           }
 267           elseif ($values[2] == 3) {
 268             $query->_where[$grouping][] = " civicrm_activity_contact.record_type_id = $targetID";
 269             $query->_qill[$grouping][] = ts('Activity targeted to');
 270           }
 271         }
 272         break;
 273
 274       case 'activity_test':
 275         // We don't want to include all tests for sql OR CRM-7827
 276         if (!$value || $query->getOperator() != 'OR') {
 277           $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_activity.is_test", $op, $value, "Boolean");
 278           if ($value) {
 279             $query->_qill[$grouping][] = ts('Activity is a Test');
 280           }
 281         }
 282         break;
 283
 284       case 'activity_date':
 285       case 'activity_date_low':
 286       case 'activity_date_high':
 287       case 'activity_date_time_low':
 288       case 'activity_date_time_high':
 289         $query->dateQueryBuilder($values,
 290           'civicrm_activity', str_replace([
 291             '_high',
 292             '_low',
 293           ], '', $name), 'activity_date_time', ts('Activity Date')
 294         );
 295         break;
 296
 297       case 'activity_taglist':
 298         $taglist = $value;
 299         $value = [];
 300         foreach ($taglist as $val) {
 301           if ($val) {
 302             $val = explode(',', $val);
 303             foreach ($val as $tId) {
 304               if (is_numeric($tId)) {
 305                 $value[$tId] = 1;
 306               }
 307             }
 308           }
 309         }
 310
 311       case 'activity_tags':
 312         $activityTags = CRM_Core_PseudoConstant::get('CRM_Core_DAO_EntityTag', 'tag_id', ['onlyActive' => FALSE]);
 313
 314         if (!is_array($value)) {
 315           $value = explode(',', $value);
 316         }
 317
 318         $names = [];
 319         foreach ($value as $k => $v) {
 320           $names[] = $activityTags[$v];
 321         }
 322
 323         $query->_where[$grouping][] = "civicrm_activity_tag.tag_id IN (" . implode(",", $value) . ")";
 324         $query->_qill[$grouping][] = ts('Activity Tag %1', [1 => $op]) . ' ' . implode(' ' . ts('OR') . ' ', $names);
 325         $query->_tables['civicrm_activity_tag'] = $query->_whereTables['civicrm_activity_tag'] = 1;
 326         break;
 327
 328       case 'activity_result':
 329         if (is_array($value)) {
 330           $safe = [];
 331           foreach ($value as $id => $k) {
 332             $safe[] = "'" . CRM_Utils_Type::escape($k, 'String') . "'";
 333           }
 334           $query->_where[$grouping][] = "civicrm_activity.result IN (" . implode(',', $safe) . ")";
 335           $query->_qill[$grouping][] = ts("Activity Result - %1", [1 => implode(' or ', $safe)]);
 336         }
 337         break;
 338
 339       case 'parent_id':
 340         if ($value == 1) {
 341           $query->_where[$grouping][] = "civicrm_activity.parent_id IS NOT NULL";
 342           $query->_qill[$grouping][] = ts('Activities which have Followup Activities');
 343         }
 344         elseif ($value == 2) {
 345           $query->_where[$grouping][] = "civicrm_activity.parent_id IS NULL";
 346           $query->_qill[$grouping][] = ts('Activities without Followup Activities');
 347         }
 348         break;
 349
 350       case 'followup_parent_id':
 351         if ($value == 1) {
 352           $query->_where[$grouping][] = "civicrm_activity.parent_id IS NOT NULL";
 353           $query->_qill[$grouping][] = ts('Activities which are Followup Activities');
 354         }
 355         elseif ($value == 2) {
 356           $query->_where[$grouping][] = "civicrm_activity.parent_id IS NULL";
 357           $query->_qill[$grouping][] = ts('Activities which are not Followup Activities');
 358         }
 359         break;
 360
 361       case 'source_contact':
 362       case 'source_contact_id':
 363         $columnName = strstr($name, '_id') ? 'id' : 'sort_name';
 364         $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("source_contact.{$columnName}", $op, $value, CRM_Utils_Type::typeToString($fields[$name]['type']));
 365         list($op, $value) = CRM_Contact_BAO_Query::buildQillForFieldValue('CRM_Contact_DAO_Contact', $columnName, $value, $op);
 366         $query->_qill[$grouping][] = ts('%1 %2 %3', [
 367           1 => $fields[$name]['title'],
 368           2 => $op,
 369           3 => $value,
 370         ]);
 371         break;
 372     }
 373   }
 374
 375   /**
 376    * @param string $name
 377    * @param $mode
 378    * @param $side
 379    *
 380    * @return null|string
 381    */
 382   public static function from($name, $mode, $side) {
 383     $from = NULL;
 384     switch ($name) {
 385       case 'civicrm_activity':
 386         //CRM-7480 we are going to civicrm_activity table either
 387         //from civicrm_activity_target or civicrm_activity_assignment.
 388         //as component specific activities does not have entry in
 389         //activity target table so lets consider civicrm_activity_assignment.
 390         $from .= " $side JOIN civicrm_activity_contact
 391                       ON ( civicrm_activity_contact.contact_id = contact_a.id ) ";
 392         $from .= " $side JOIN civicrm_activity
 393                       ON ( civicrm_activity.id = civicrm_activity_contact.activity_id
 394                       AND civicrm_activity.is_deleted = 0 AND civicrm_activity.is_current_revision = 1 )";
 395         // Do not show deleted contact's activity
 396         $from .= " INNER JOIN civicrm_contact
 397                       ON ( civicrm_activity_contact.contact_id = civicrm_contact.id and civicrm_contact.is_deleted != 1 )";
 398         break;
 399
 400       case 'activity_status':
 401         $from .= " $side JOIN civicrm_option_group option_group_activity_status ON (option_group_activity_status.name = 'activity_status')";
 402         $from .= " $side JOIN civicrm_option_value activity_status ON (civicrm_activity.status_id = activity_status.value
 403                                AND option_group_activity_status.id = activity_status.option_group_id ) ";
 404         break;
 405
 406       case 'activity_type':
 407         $from .= " $side JOIN civicrm_option_group option_group_activity_type ON (option_group_activity_type.name = 'activity_type')";
 408         $from .= " $side JOIN civicrm_option_value activity_type ON (civicrm_activity.activity_type_id = activity_type.value
 409                                AND option_group_activity_type.id = activity_type.option_group_id ) ";
 410         break;
 411
 412       case 'activity_priority':
 413         $from .= " $side JOIN civicrm_option_group option_group_activity_priority ON (option_group_activity_priority.name = 'priority')";
 414         $from .= " $side JOIN civicrm_option_value activity_priority ON (civicrm_activity.priority_id = activity_priority.value
 415                               AND option_group_activity_priority.id = activity_priority.option_group_id ) ";
 416         break;
 417
 418       case 'civicrm_activity_tag':
 419         $from .= " $side JOIN civicrm_entity_tag as civicrm_activity_tag ON ( civicrm_activity_tag.entity_table = 'civicrm_activity' AND civicrm_activity_tag.entity_id = civicrm_activity.id ) ";
 420         break;
 421
 422       case 'source_contact':
 423         $sourceID = CRM_Core_PseudoConstant::getKey(
 424           'CRM_Activity_BAO_ActivityContact',
 425           'record_type_id',
 426           'Activity Source'
 427         );
 428         $from = "
 429           LEFT JOIN civicrm_activity_contact source_activity
 430             ON (source_activity.activity_id = civicrm_activity_contact.activity_id
 431               AND source_activity.record_type_id = {$sourceID})
 432           LEFT JOIN civicrm_contact source_contact ON (source_activity.contact_id = source_contact.id)";
 433         break;
 434
 435       case 'parent_id':
 436         $from = "$side JOIN civicrm_activity AS parent_id ON civicrm_activity.id = parent_id.parent_id";
 437         break;
 438     }
 439
 440     return $from;
 441   }
 442
 443   /**
 444    * Get the metadata for fields to be included on the activity search form.
 445    *
 446    * @todo ideally this would be a trait included on the activity search & advanced search
 447    * rather than a static function.
 448    */
 449   public static function getSearchFieldMetadata() {
 450     $fields = ['activity_type_id', 'activity_date_time', 'priority_id', 'activity_location'];
 451     $metadata = civicrm_api3('Activity', 'getfields', [])['values'];
 452     $metadata = array_intersect_key($metadata, array_flip($fields));
 453     $metadata['activity_text'] = [
 454       'title' => ts('Activity Text'),
 455       'type' => CRM_Utils_Type::T_STRING,
 456       'is_pseudofield' => TRUE,
 457     ];
 458     return $metadata;
 459   }
 460
 461   /**
 462    * Add all the elements shared between case activity search and advanced search.
 463    *
 464    * @param CRM_Core_Form_Search $form
 465    */
 466   public static function buildSearchForm(&$form) {
 467     $form->addSearchFieldMetadata(['Activity' => self::getSearchFieldMetadata()]);
 468     $form->addFormFieldsFromMetadata();
 469
 470     $followUpActivity = [
 471       1 => ts('Yes'),
 472       2 => ts('No'),
 473     ];
 474     $form->addRadio('parent_id', NULL, $followUpActivity, ['allowClear' => TRUE]);
 475     $form->addRadio('followup_parent_id', NULL, $followUpActivity, ['allowClear' => TRUE]);
 476     $activityRoles = [
 477       3 => ts('With'),
 478       2 => ts('Assigned to'),
 479       1 => ts('Added by'),
 480     ];
 481     $form->addRadio('activity_role', NULL, $activityRoles, ['allowClear' => TRUE]);
 482     $form->setDefaults(['activity_role' => 3]);
 483     $activityStatus = CRM_Core_PseudoConstant::get('CRM_Activity_DAO_Activity', 'status_id', [
 484       'flip' => 1,
 485       'labelColumn' => 'name',
 486     ]);
 487     $form->addSelect('status_id',
 488       [
 489         'entity' => 'activity',
 490         'multiple' => 'multiple',
 491         'option_url' => NULL,
 492         'placeholder' => ts('- any -'),
 493       ]
 494     );
 495     $ssID = $form->get('ssID');
 496     $status = [$activityStatus['Completed'], $activityStatus['Scheduled']];
 497     //If status is saved in smart group.
 498     if (!empty($ssID) && !empty($form->_formValues['activity_status_id'])) {
 499       $status = $form->_formValues['activity_status_id'];
 500     }
 501     $form->setDefaults(['status_id' => $status]);
 502
 503     $form->addElement('text', 'activity_text', ts('Activity Text'), CRM_Core_DAO::getAttribute('CRM_Contact_DAO_Contact', 'sort_name'));
 504
 505     $form->addRadio('activity_option', '', CRM_Core_SelectValues::activityTextOptions());
 506     $form->setDefaults(['activity_option' => 'both']);
 507
 508     $form->addYesNo('activity_test', ts('Activity is a Test?'));
 509     $activity_tags = CRM_Core_BAO_Tag::getColorTags('civicrm_activity');
 510
 511     if ($activity_tags) {
 512       $form->add('select2', 'activity_tags', ts('Activity Tag(s)'),
 513         $activity_tags, FALSE, [
 514           'id' => 'activity_tags',
 515           'multiple' =>
 516           'multiple',
 517           'class' => 'crm-select2',
 518           'placeholder' => ts('- select -'),
 519         ]
 520       );
 521     }
 522
 523     $parentNames = CRM_Core_BAO_Tag::getTagSet('civicrm_activity');
 524     CRM_Core_Form_Tag::buildQuickForm($form, $parentNames, 'civicrm_activity', NULL, TRUE, TRUE);
 525
 526     $surveys = CRM_Campaign_BAO_Survey::getSurveys(TRUE, FALSE, FALSE, TRUE);
 527     if ($surveys) {
 528       $form->add('select', 'activity_survey_id', ts('Survey / Petition'),
 529         ['' => ts('- none -')] + $surveys, FALSE,
 530         ['class' => 'crm-select2']
 531       );
 532     }
 533
 534     CRM_Core_BAO_Query::addCustomFormFields($form, ['Activity']);
 535
 536     CRM_Campaign_BAO_Campaign::addCampaignInComponentSearch($form, 'activity_campaign_id');
 537
 538     // Add engagement level CRM-7775.
 539     $buildEngagementLevel = FALSE;
 540     $buildSurveyResult = FALSE;
 541     if (CRM_Campaign_BAO_Campaign::isCampaignEnable() &&
 542       CRM_Campaign_BAO_Campaign::accessCampaign()
 543     ) {
 544       $buildEngagementLevel = TRUE;
 545       $form->addSelect('activity_engagement_level', [
 546         'entity' => 'activity',
 547         'context' => 'search',
 548       ]);
 549
 550       // Add survey result field.
 551       $optionGroups = CRM_Campaign_BAO_Survey::getResultSets('name');
 552       $resultOptions = [];
 553       foreach ($optionGroups as $gid => $name) {
 554         if ($name) {
 555           $value = CRM_Core_OptionGroup::values($name);
 556           if (!empty($value)) {
 557             foreach ($value as $k => $v) {
 558               $resultOptions[$v] = $v;
 559             }
 560           }
 561         }
 562       }
 563       // If no survey result options have been created, don't build
 564       // the field to avoid clutter.
 565       if (count($resultOptions) > 0) {
 566         $buildSurveyResult = TRUE;
 567         asort($resultOptions);
 568         $form->add('select', 'activity_result', ts("Survey Result"),
 569           $resultOptions, FALSE,
 570           [
 571             'id' => 'activity_result',
 572             'multiple' => 'multiple',
 573             'class' => 'crm-select2',
 574           ]
 575         );
 576       }
 577     }
 578
 579     $form->assign('buildEngagementLevel', $buildEngagementLevel);
 580     $form->assign('buildSurveyResult', $buildSurveyResult);
 581     $form->setDefaults(['activity_test' => 0]);
 582   }
 583
 584   /**
 585    * @param $mode
 586    * @param bool $includeCustomFields
 587    *
 588    * @return array|null
 589    */
 590   public static function defaultReturnProperties($mode, $includeCustomFields = TRUE) {
 591     $properties = NULL;
 592     if ($mode & CRM_Contact_BAO_Query::MODE_ACTIVITY) {
 593       $properties = [
 594         'activity_id' => 1,
 595         'contact_type' => 1,
 596         'contact_sub_type' => 1,
 597         'sort_name' => 1,
 598         'display_name' => 1,
 599         'activity_type' => 1,
 600         'activity_type_id' => 1,
 601         'activity_subject' => 1,
 602         'activity_date_time' => 1,
 603         'activity_duration' => 1,
 604         'activity_location' => 1,
 605         'activity_details' => 1,
 606         'activity_status' => 1,
 607         'activity_priority' => 1,
 608         'source_contact' => 1,
 609         'source_record_id' => 1,
 610         'activity_is_test' => 1,
 611         'activity_campaign_id' => 1,
 612         'result' => 1,
 613         'activity_engagement_level' => 1,
 614         'parent_id' => 1,
 615       ];
 616
 617       if ($includeCustomFields) {
 618         // also get all the custom activity properties
 619         $fields = CRM_Core_BAO_CustomField::getFieldsForImport('Activity');
 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    * Get the list of fields required to populate the selector.
 633    *
 634    * The default return properties array returns far too many fields for 'everyday use. Every field you add to this array
 635    * kills a small kitten so add carefully.
 636    */
 637   public static function selectorReturnProperties() {
 638     $properties = [
 639       'activity_id' => 1,
 640       'contact_type' => 1,
 641       'contact_sub_type' => 1,
 642       'sort_name' => 1,
 643       'display_name' => 1,
 644       'activity_type_id' => 1,
 645       'activity_subject' => 1,
 646       'activity_date_time' => 1,
 647       'activity_status_id' => 1,
 648       'source_contact' => 1,
 649       'source_record_id' => 1,
 650       'activity_is_test' => 1,
 651       'activity_campaign_id' => 1,
 652       'activity_engagement_level' => 1,
 653     ];
 654
 655     return $properties;
 656   }
 657
 658   /**
 659    * Where/qill clause for notes
 660    *
 661    * @param array $values
 662    * @param CRM_Contact_BAO_Query $query
 663    *
 664    * @throws \CRM_Core_Exception
 665    */
 666   public static function whereClauseSingleActivityText(&$values, &$query) {
 667     list($name, $op, $value, $grouping, $wildcard) = $values;
 668     $activityOptionValues = $query->getWhereValues('activity_option', $grouping);
 669     $activityOption = CRM_Utils_Array::value(2, $activityOptionValues, 6);
 670
 671     $query->_useDistinct = TRUE;
 672
 673     $label = ts('Activity Text (%1)', [1 => CRM_Utils_Array::value($activityOption, CRM_Core_SelectValues::activityTextOptions())]);
 674     $clauses = [];
 675     if ($activityOption % 2 == 0) {
 676       $clauses[] = $query->buildClause('civicrm_activity.details', $op, $value, 'String');
 677     }
 678     if ($activityOption % 3 == 0) {
 679       $clauses[] = $query->buildClause('civicrm_activity.subject', $op, $value, 'String');
 680     }
 681
 682     $query->_where[$grouping][] = "( " . implode(' OR ', $clauses) . " )";
 683     list($qillOp, $qillVal) = $query->buildQillForFieldValue(NULL, $name, $value, $op);
 684     $query->_qill[$grouping][] = ts("%1 %2 '%3'", [
 685       1 => $label,
 686       2 => $qillOp,
 687       3 => $qillVal,
 688     ]);
 689   }
 690
 691 }