4 +--------------------------------------------------------------------+
5 | CiviCRM version 4.4 |
6 +--------------------------------------------------------------------+
7 | Copyright CiviCRM LLC (c) 2004-2013 |
8 +--------------------------------------------------------------------+
9 | This file is a part of CiviCRM. |
11 | CiviCRM is free software; you can copy, modify, and distribute it |
12 | under the terms of the GNU Affero General Public License |
13 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
15 | CiviCRM is distributed in the hope that it will be useful, but |
16 | WITHOUT ANY WARRANTY; without even the implied warranty of |
17 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
18 | See the GNU Affero General Public License for more details. |
20 | You should have received a copy of the GNU Affero General Public |
21 | License and the CiviCRM Licensing Exception along |
22 | with this program; if not, contact CiviCRM LLC |
23 | at info[AT]civicrm[DOT]org. If you have questions about the |
24 | GNU Affero General Public License or the licensing of CiviCRM, |
25 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
26 +--------------------------------------------------------------------+
32 * @copyright CiviCRM LLC (c) 2004-2013
36 class CRM_Activity_BAO_Query
{
39 * build select for Case
44 static function select(&$query) {
45 if (!empty($query->_returnProperties
['activity_id'])) {
46 $query->_select
['activity_id'] = "civicrm_activity.id as activity_id";
47 $query->_element
['activity_id'] = 1;
48 $query->_tables
['civicrm_activity'] = $query->_whereTables
['civicrm_activity'] = 1;
51 if (!empty($query->_returnProperties
['activity_type_id'])) {
52 $query->_select
['activity_type_id'] = "activity_type.id as activity_type_id";
53 $query->_element
['activity_type_id'] = 1;
54 $query->_tables
['civicrm_activity'] = 1;
55 $query->_tables
['activity_type'] = 1;
56 $query->_whereTables
['civicrm_activity'] = 1;
57 $query->_whereTables
['activity_type'] = 1;
60 if (!empty($query->_returnProperties
['activity_type'])) {
61 $query->_select
['activity_type'] = "activity_type.label as activity_type";
62 $query->_element
['activity_type'] = 1;
63 $query->_tables
['civicrm_activity'] = 1;
64 $query->_tables
['activity_type'] = 1;
65 $query->_whereTables
['civicrm_activity'] = 1;
66 $query->_whereTables
['activity_type'] = 1;
69 if (!empty($query->_returnProperties
['activity_subject'])) {
70 $query->_select
['activity_subject'] = "civicrm_activity.subject as activity_subject";
71 $query->_element
['activity_subject'] = 1;
72 $query->_tables
['civicrm_activity'] = $query->_whereTables
['civicrm_activity'] = 1;
75 if (!empty($query->_returnProperties
['activity_date_time'])) {
76 $query->_select
['activity_date_time'] = "civicrm_activity.activity_date_time as activity_date_time";
77 $query->_element
['activity_date_time'] = 1;
78 $query->_tables
['civicrm_activity'] = $query->_whereTables
['civicrm_activity'] = 1;
81 if (!empty($query->_returnProperties
['activity_status_id'])) {
82 $query->_select
['activity_status_id'] = "activity_status.value as activity_status_id";
83 $query->_element
['activity_status_id'] = 1;
84 $query->_tables
['civicrm_activity'] = 1;
85 $query->_tables
['activity_status'] = 1;
86 $query->_whereTables
['civicrm_activity'] = 1;
87 $query->_whereTables
['activity_status'] = 1;
90 if (!empty($query->_returnProperties
['activity_status'])) {
91 $query->_select
['activity_status'] = "activity_status.label as activity_status";
92 $query->_element
['activity_status'] = 1;
93 $query->_tables
['civicrm_activity'] = 1;
94 $query->_tables
['activity_status'] = 1;
95 $query->_whereTables
['civicrm_activity'] = 1;
96 $query->_whereTables
['activity_status'] = 1;
99 if (!empty($query->_returnProperties
['activity_duration'])) {
100 $query->_select
['activity_duration'] = "civicrm_activity.duration as activity_duration";
101 $query->_element
['activity_duration'] = 1;
102 $query->_tables
['civicrm_activity'] = $query->_whereTables
['civicrm_activity'] = 1;
105 if (!empty($query->_returnProperties
['activity_location'])) {
106 $query->_select
['activity_location'] = "civicrm_activity.location as activity_location";
107 $query->_element
['activity_location'] = 1;
108 $query->_tables
['civicrm_activity'] = $query->_whereTables
['civicrm_activity'] = 1;
111 if (!empty($query->_returnProperties
['activity_details'])) {
112 $query->_select
['activity_details'] = "civicrm_activity.details as activity_details";
113 $query->_element
['activity_details'] = 1;
114 $query->_tables
['civicrm_activity'] = $query->_whereTables
['civicrm_activity'] = 1;
117 if (!empty($query->_returnProperties
['source_record_id'])) {
118 $query->_select
['source_record_id'] = "civicrm_activity.source_record_id as source_record_id";
119 $query->_element
['source_record_id'] = 1;
120 $query->_tables
['civicrm_activity'] = $query->_whereTables
['civicrm_activity'] = 1;
123 if (!empty($query->_returnProperties
['activity_is_test'])) {
124 $query->_select
['activity_is_test'] = "civicrm_activity.is_test as activity_is_test";
125 $query->_element
['activity_is_test'] = 1;
126 $query->_tables
['civicrm_activity'] = $query->_whereTables
['civicrm_activity'] = 1;
129 if (!empty($query->_returnProperties
['activity_campaign_id'])) {
130 $query->_select
['activity_campaign_id'] = 'civicrm_activity.campaign_id as activity_campaign_id';
131 $query->_element
['activity_campaign_id'] = 1;
132 $query->_tables
['civicrm_activity'] = $query->_whereTables
['civicrm_activity'] = 1;
135 if (!empty($query->_returnProperties
['activity_engagement_level'])) {
136 $query->_select
['activity_engagement_level'] = 'civicrm_activity.engagement_level as activity_engagement_level';
137 $query->_element
['activity_engagement_level'] = 1;
138 $query->_tables
['civicrm_activity'] = $query->_whereTables
['civicrm_activity'] = 1;
141 if (!empty($query->_returnProperties
['source_contact'])) {
142 $query->_select
['source_contact'] = 'source_contact.sort_name as source_contact';
143 $query->_element
['source_contact'] = 1;
144 $query->_tables
['source_contact'] = $query->_whereTables
['source_contact'] = 1;
147 if (!empty($query->_returnProperties
['activity_result'])) {
148 $query->_select
['activity_result'] = 'civicrm_activity.result as activity_result';
149 $query->_element
['result'] = 1;
150 $query->_tables
['civicrm_activity'] = $query->_whereTables
['civicrm_activity'] = 1;
155 * Given a list of conditions in query generate the required
161 static function where(&$query) {
163 foreach (array_keys($query->_params
) as $id) {
164 if (substr($query->_params
[$id][0], 0, 9) == 'activity_') {
165 if ($query->_mode
== CRM_Contact_BAO_QUERY
::MODE_CONTACTS
) {
166 $query->_useDistinct
= TRUE;
168 $grouping = $query->_params
[$id][3];
169 self
::whereClauseSingle($query->_params
[$id], $query);
175 * where clause for a single field
180 static function whereClauseSingle(&$values, &$query) {
181 list($name, $op, $value, $grouping, $wildcard) = $values;
183 $strtolower = function_exists('mb_strtolower') ?
'mb_strtolower' : 'strtolower';
184 $query->_tables
['civicrm_activity'] = $query->_whereTables
['civicrm_activity'] = 1;
185 if ($query->_mode
& CRM_Contact_BAO_Query
::MODE_ACTIVITY
) {
186 $query->_skipDeleteClause
= TRUE;
190 case 'activity_type_id':
191 $types = CRM_Core_PseudoConstant
::activityType(TRUE, TRUE, FALSE, 'label', TRUE);
193 //get the component activity types.
194 $compActTypes = CRM_Core_PseudoConstant
::activityType(TRUE, TRUE, FALSE, 'label', TRUE, TRUE);
197 if (is_array($value)) {
198 foreach ($value as $id => $dontCare) {
199 if (array_key_exists($id, $types) && $dontCare) {
200 $clause[] = "'" . CRM_Utils_Type
::escape($types[$id], 'String') . "'";
201 if (array_key_exists($id, $compActTypes)) {
202 CRM_Contact_BAO_Query
::$_considerCompActivities = TRUE;
206 $activityTypes = implode(',', array_keys($value));
209 $clause[] = "'" . CRM_Utils_Type
::escape($value, 'String') . "'";
210 $activityTypes = $value;
211 if (array_key_exists($value, $compActTypes)) {
212 CRM_Contact_BAO_Query
::$_considerCompActivities = TRUE;
215 $query->_where
[$grouping][] = ' civicrm_activity.activity_type_id IN (' . $activityTypes . ')';
216 $query->_qill
[$grouping][] = ts('Activity Type') . ' ' . implode(' ' . ts('or') . ' ', $clause);
219 case 'activity_survey_id':
223 $value = CRM_Utils_Type
::escape($value, 'Integer');
224 $query->_where
[$grouping][] = " source_record_id = $value";
225 $query->_qill
[$grouping][] = ts('Survey') . ' - ' . CRM_Core_DAO
::getFieldValue('CRM_Campaign_DAO_Survey', $value, 'title');
228 case 'activity_engagement_level':
233 $value = CRM_Utils_Type
::escape($value, 'Integer');
234 $query->_where
[$grouping][] = " engagement_level = $value";
235 $query->_qill
[$grouping][] = ts('Engagement Index') . ' - ' . CRM_Core_OptionGroup
::getLabel('engagement_index', $value);
238 case 'activity_role':
239 CRM_Contact_BAO_Query
::$_activityRole = $values[2];
240 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
241 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
242 $assigneeID = CRM_Utils_Array
::key('Activity Assignees', $activityContacts);
243 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
246 $query->_tables
['civicrm_activity_contact'] = $query->_whereTables
['civicrm_activity_contact'] = 1;
247 if ($values[2] == 1) {
248 $query->_where
[$grouping][] = " civicrm_activity_contact.record_type_id = $sourceID";
249 $query->_qill
[$grouping][] = ts('Activity created by');
251 else if ($values[2] == 2) {
252 $query->_where
[$grouping][] = " civicrm_activity_contact.record_type_id = $assigneeID";
253 $query->_qill
[$grouping][] = ts('Activity assigned to');
255 else if ($values[2] == 3) {
256 $query->_where
[$grouping][] = " civicrm_activity_contact.record_type_id = $targetID";
257 $query->_qill
[$grouping][] = ts('Activity targeted to');
262 case 'activity_status':
263 $status = CRM_Core_PseudoConstant
::activityStatus();
265 if (is_array($value)) {
266 foreach ($value as $k => $v) {
268 $clause[] = "'" . CRM_Utils_Type
::escape($status[$k], 'String') . "'";
273 $clause[] = "'" . CRM_Utils_Type
::escape($value, 'String') . "'";
275 $query->_where
[$grouping][] = ' civicrm_activity.status_id IN (' . implode(',', array_keys($value)) . ')';
276 $query->_qill
[$grouping][] = ts('Activity Status') . ' - ' . implode(' ' . ts('or') . ' ', $clause);
279 case 'activity_subject':
281 $value = strtolower(CRM_Core_DAO
::escapeString($n));
283 if (strpos($value, '%') !== FALSE) {
284 // only add wild card if not there
288 $value = "'%$value%'";
295 $wc = ($op != 'LIKE') ?
"LOWER(civicrm_activity.subject)" : "civicrm_activity.subject";
296 $query->_where
[$grouping][] = " $wc $op $value";
297 $query->_qill
[$grouping][] = ts('Subject') . " $op - '$n'";
300 case 'activity_test':
301 // We dont want to include all tests for sql OR CRM-7827
302 if (!$value ||
$query->getOperator() != 'OR') {
303 $query->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause("civicrm_activity.is_test", $op, $value, "Boolean");
305 $query->_qill
[$grouping][] = ts('Activity is a Test');
310 case 'activity_date':
311 case 'activity_date_low':
312 case 'activity_date_high':
313 $query->dateQueryBuilder($values,
314 'civicrm_activity', 'activity_date', 'activity_date_time', ts('Activity Date')
323 if (is_array($value)) {
324 foreach ($value as $k => $v) {
325 $value[$k] = CRM_Utils_Type
::escape($v, 'Integer');
329 $value = array(CRM_Utils_Type
::escape($value, 'Integer'));
331 $query->_where
[$grouping][] = "civicrm_activity.id IN (" . implode(",", $value) . ")";
332 $query->_qill
[$grouping][] = ts('Activity Id(s) %1', array(1 => implode($value)));
335 case 'activity_taglist':
338 foreach ($taglist as $val) {
340 $val = explode(',', $val);
341 foreach ($val as $tId) {
342 if (is_numeric($tId)) {
349 case 'activity_tags':
350 $value = array_keys($value);
351 $activityTags = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_EntityTag', 'tag_id', array('onlyActive' => FALSE));
355 if (is_array($value)) {
356 foreach ($value as $k => $v) {
357 $names[] = $activityTags[$v];
360 $query->_where
[$grouping][] = "civicrm_activity_tag.tag_id IN (" . implode(",", $value) . ")";
361 $query->_qill
[$grouping][] = ts('Activity Tag %1', array(1 => $op)) . ' ' . implode(' ' . ts('OR') . ' ', $names);
362 $query->_tables
['civicrm_activity_tag'] = $query->_whereTables
['civicrm_activity_tag'] = 1;
365 case 'activity_campaign_id':
368 'campaign' => $value,
369 'grouping' => $grouping,
370 'tableName' => 'civicrm_activity',
372 CRM_Campaign_BAO_Query
::componentSearchClause($campParams, $query);
374 case 'activity_result':
375 if(is_array($value)) {
377 while(list(,$k) = each($value)) {
378 $safe[] = "'" . CRM_Utils_Type
::escape($k, 'String') . "'";
380 $query->_where
[$grouping][] = "civicrm_activity.result IN (" . implode(',', $safe) . ")";
381 $query->_qill
[$grouping][] = ts("Activity Result - %1", array(1 => implode(' or ', $safe)));
387 static function from($name, $mode, $side) {
390 case 'civicrm_activity':
391 //CRM-7480 we are going to civicrm_activity table either
392 //from civicrm_activity_target or civicrm_activity_assignment.
393 //as component specific activities does not have entry in
394 //activity target table so lets consider civicrm_activity_assignment.
395 $from .= " INNER JOIN civicrm_activity_contact
396 ON ( civicrm_activity_contact.contact_id = contact_a.id ) ";
397 $from .= " INNER JOIN civicrm_activity
398 ON ( civicrm_activity.id = civicrm_activity_contact.activity_id
399 AND civicrm_activity.is_deleted = 0 AND civicrm_activity.is_current_revision = 1 )";
401 $activityRole = CRM_Contact_BAO_Query
::$_activityRole;
404 case 'activity_status':
405 $from .= " $side JOIN civicrm_option_group option_group_activity_status ON (option_group_activity_status.name = 'activity_status')";
406 $from .= " $side JOIN civicrm_option_value activity_status ON (civicrm_activity.status_id = activity_status.value
407 AND option_group_activity_status.id = activity_status.option_group_id ) ";
410 case 'activity_type':
411 $from .= " $side JOIN civicrm_option_group option_group_activity_type ON (option_group_activity_type.name = 'activity_type')";
412 $from .= " $side JOIN civicrm_option_value activity_type ON (civicrm_activity.activity_type_id = activity_type.value
413 AND option_group_activity_type.id = activity_type.option_group_id ) ";
416 case 'civicrm_activity_tag':
417 $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 case 'source_contact':
421 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
422 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
424 LEFT JOIN civicrm_activity_contact ac
425 ON ( ac.activity_id = civicrm_activity_contact.activity_id AND ac.record_type_id = {$sourceID})
426 INNER JOIN civicrm_contact source_contact ON (ac.contact_id = source_contact.id)";
434 * getter for the qill object
440 return (isset($this->_qill
)) ?
$this->_qill
: "";
444 * add all the elements shared between case activity search and advanaced search
451 static function buildSearchForm(&$form) {
452 $activityOptions = CRM_Core_PseudoConstant
::activityType(TRUE, TRUE, FALSE, 'label', TRUE);
453 asort($activityOptions);
454 foreach ($activityOptions as $activityID => $activity) {
455 $form->_activityElement
=&
458 "activity_type_id[$activityID]",
461 array('onClick' => 'showCustomData( this.id );')
465 CRM_Core_Form_Date
::buildDateRange($form, 'activity_date', 1, '_low', '_high', ts('From'), FALSE, FALSE);
467 $activityRoles = array(
469 2 => ts('Assigned to'),
472 $form->addRadio('activity_role', NULL, $activityRoles);
473 $form->setDefaults(array('activity_role' => 3));
474 $activityStatus = CRM_Core_PseudoConstant
::activityStatus();
475 foreach ($activityStatus as $activityStatusID => $activityStatusName) {
476 $activity_status[] = $form->createElement('checkbox', $activityStatusID, NULL, $activityStatusName);
478 $form->addGroup($activity_status, 'activity_status', ts('Activity Status'));
479 $form->setDefaults(array('activity_status[1]' => 1, 'activity_status[2]' => 1));
480 $form->addElement('text', 'activity_subject', ts('Subject'), CRM_Core_DAO
::getAttribute('CRM_Contact_DAO_Contact', 'sort_name'));
481 $form->addYesNo('activity_test', ts('Activity is a Test?'));
482 $activity_tags = CRM_Core_BAO_Tag
::getTags('civicrm_activity');
483 if ($activity_tags) {
484 foreach ($activity_tags as $tagID => $tagName) {
485 $form->_tagElement
= &$form->addElement('checkbox', "activity_tags[$tagID]",
491 $parentNames = CRM_Core_BAO_Tag
::getTagSet('civicrm_activity');
492 CRM_Core_Form_Tag
::buildQuickForm($form, $parentNames, 'civicrm_activity', NULL, TRUE, FALSE, TRUE);
494 $surveys = CRM_Campaign_BAO_Survey
::getSurveys(TRUE, FALSE, FALSE, TRUE);
495 if ($surveys) $form->add('select', 'activity_survey_id', ts('Survey / Petition'),
497 '' => ts('- none -')) +
$surveys, FALSE
500 $extends = array('Activity');
501 $groupDetails = CRM_Core_BAO_CustomGroup
::getGroupDetail(NULL, TRUE, $extends);
503 $form->assign('activityGroupTree', $groupDetails);
504 foreach ($groupDetails as $group) {
505 foreach ($group['fields'] as $field) {
506 $fieldId = $field['id'];
507 $elementName = 'custom_' . $fieldId;
508 CRM_Core_BAO_CustomField
::addQuickFormElement($form, $elementName, $fieldId, FALSE, FALSE, TRUE);
513 CRM_Campaign_BAO_Campaign
::addCampaignInComponentSearch($form, 'activity_campaign_id');
515 //add engagement level CRM-7775
516 $buildEngagementLevel = FALSE;
517 $buildSurveyResult = FALSE;
518 if (CRM_Campaign_BAO_Campaign
::isCampaignEnable() &&
519 CRM_Campaign_BAO_Campaign
::accessCampaign()
521 $buildEngagementLevel = TRUE;
522 $form->add('select', 'activity_engagement_level',
523 ts('Engagement Index'),
524 array('' => ts('- any -')) + CRM_Campaign_PseudoConstant
::engagementLevel()
527 // Add survey result field.
528 $optionGroups = CRM_Campaign_BAO_Survey
::getResultSets( 'name' );
529 $resultOptions = array();
530 foreach ( $optionGroups as $gid => $name ) {
533 $value = CRM_Core_OptionGroup
::values($name);
534 if (!empty($value)) {
535 while(list($k,$v) = each($value)) {
536 $resultOptions[$v] = $v;
541 // If no survey result options have been created, don't build
542 // the field to avoid clutter.
543 if(count($resultOptions) > 0) {
544 $buildSurveyResult = TRUE;
545 asort($resultOptions);
546 $form->add('select', 'activity_result', ts("Survey Result"),
547 $resultOptions, FALSE,
548 array('id' => 'activity_result', 'multiple' => 'multiple', 'title' => ts('- select -'))
553 $form->assign('buildEngagementLevel', $buildEngagementLevel);
554 $form->assign('buildSurveyResult', $buildSurveyResult);
555 $form->setDefaults(array('activity_test' => 0));
558 static function defaultReturnProperties($mode, $includeCustomFields = TRUE) {
560 if ($mode & CRM_Contact_BAO_Query
::MODE_ACTIVITY
) {
564 'contact_sub_type' => 1,
567 'activity_type' => 1,
568 'activity_subject' => 1,
569 'activity_date_time' => 1,
570 'activity_duration' => 1,
571 'activity_location' => 1,
572 'activity_details' => 1,
573 'activity_status' => 1,
574 'source_contact' => 1,
575 'source_record_id' => 1,
576 'activity_is_test' => 1,
577 'activity_campaign_id' => 1,
579 'activity_engagement_level' => 1,
582 if ($includeCustomFields) {
583 // also get all the custom activity properties
584 $fields = CRM_Core_BAO_CustomField
::getFieldsForImport('Activity');
585 if (!empty($fields)) {
586 foreach ($fields as $name => $dontCare) {
587 $properties[$name] = 1;