CRM/Activity/BAO/Query.php

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