3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2014
36 require_once 'CRM/Contact/Form/Search/Interface.php';
39 * Class org_civicrm_search_activityimplementsCRM_Contact_Form_Search_Interface
41 class org_civicrm_search_activityimplementsCRM_Contact_Form_Search_Interface
{
43 protected $_formValues;
48 function __construct(&$formValues) {
49 $this->_formValues
= $formValues;
52 * Define the columns for search result rows
54 $this->_columns
= array(
55 ts('Name') => 'sort_name',
56 ts('Status') => 'activity_status',
57 ts('Activity Type') => 'activity_type',
58 ts('Activity Subject') => 'activity_subject',
59 ts('Scheduled By') => 'source_contact',
60 ts('Scheduled Date') => 'activity_date',
61 ts(' ') => 'activity_id',
62 ts(' ') => 'activity_type_id',
64 ts('Location') => 'location',
65 ts('Duration') => 'duration',
66 ts('Details') => 'details',
67 ts('Assignee') => 'assignee',
70 $this->_groupId
= CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionGroup',
76 //Add custom fields to columns array for inclusion in export
77 require_once 'CRM/Core/BAO/CustomGroup.php';
78 $groupTree = &CRM_Core_BAO_CustomGroup
::getTree('Activity', $form, NULL,
83 //use simplified formatted groupTree
84 $groupTree = CRM_Core_BAO_CustomGroup
::formatGroupTree($groupTree, 1, $form);
86 //cycle through custom fields and assign to _columns array
87 foreach ($groupTree as $key) {
88 foreach ($key['fields'] as $field) {
89 $fieldlabel = $key['title'] . ": " . $field['label'];
90 $this->_columns
[$fieldlabel] = $field['column_name'];
99 function buildForm(&$form) {
102 * You can define a custom title for the search form
104 $this->setTitle('Find Latest Activities');
107 * Define the search form fields here
109 // Allow user to choose which type of contact to limit search on
110 $form->add('select', 'contact_type', ts('Find...'), CRM_Core_SelectValues
::contactType());
112 // Text box for Activity Subject
115 ts('Activity Subject')
118 // Select box for Activity Type
119 $activityType = array('' => ' - select activity - ') + CRM_Core_PseudoConstant
::activityType();
121 $form->add('select', 'activity_type_id', ts('Activity Type'),
126 // textbox for Activity Status
127 $activityStatus = array('' => ' - select status - ') + CRM_Core_PseudoConstant
::activityStatus();
129 $form->add('select', 'activity_status_id', ts('Activity Status'),
134 // Activity Date range
135 $form->addDate('start_date', ts('Activity Date From'), FALSE, array('formatType' => 'custom'));
136 $form->addDate('end_date', ts('...through'), FALSE, array('formatType' => 'custom'));
139 // Contact Name field
140 $form->add('text', 'sort_name', ts('Contact Name'));
143 * If you are using the sample template, this array tells the template fields to render
144 * for the search form.
146 $form->assign('elements', array('contact_type', 'activity_subject', 'activity_type_id',
147 'activity_status_id', 'start_date', 'end_date', 'sort_name',
152 * Define the smarty template used to layout the search form and results listings.
154 function templateFile() {
155 return 'ActivitySearch.tpl';
159 * Construct the search query
161 function all($offset = 0, $rowcount = 0, $sort = NULL,
162 $includeContactIDs = FALSE, $onlyIDs = FALSE
165 // SELECT clause must include contact_id as an alias for civicrm_contact.id
167 $select = 'contact_a.id as contact_id';
171 contact_a.id as contact_id,
172 contact_a.sort_name as sort_name,
173 contact_a.contact_type as contact_type,
174 activity.id as activity_id,
175 activity.activity_type_id as activity_type_id,
176 contact_b.sort_name as source_contact,
177 ov1.label as activity_type,
178 activity.subject as activity_subject,
179 activity.activity_date_time as activity_date,
180 ov2.label as activity_status,
181 cca.case_id as case_id,
182 activity.location as location,
183 activity.duration as duration,
184 activity.details as details,
185 assignment.activity_id as assignment_activity,
186 contact_c.display_name as assignee
190 $from = $this->from();
192 $where = $this->where($includeContactIDs);
194 if (!empty($where)) {
195 $where = "WHERE $where";
198 // add custom group fields to SELECT and FROM clause
199 require_once 'CRM/Core/BAO/CustomGroup.php';
200 $groupTree = &CRM_Core_BAO_CustomGroup
::getTree('Activity', $form, NULL, NULL, '', NULL);
202 foreach ($groupTree as $key) {
203 if ($key['extends'] == 'Activity') {
204 $select .= ", " . $key['table_name'] . ".*";
205 $from .= " LEFT JOIN " . $key['table_name'] . " ON " . $key['table_name'] . ".entity_id = activity.id";
208 // end custom groups add
210 $sql = " SELECT $select FROM $from $where ";
212 //no need to add order when only contact Ids.
214 // Define ORDER BY for query in $sort, with default value
216 if (is_string($sort)) {
217 $sql .= " ORDER BY $sort ";
220 $sql .= ' ORDER BY ' . trim($sort->orderBy());
224 $sql .= 'ORDER BY contact_a.sort_name, activity.activity_date_time DESC, activity.activity_type_id, activity.status_id, activity.subject';
228 if ($rowcount > 0 && $offset >= 0) {
229 $sql .= " LIMIT $offset, $rowcount ";
234 // Alters the date display in the Activity Date Column. We do this after we already have
235 // the result so that sorting on the date column stays pertinent to the numeric date value
239 function alterRow(&$row) {
240 $row['activity_date'] = CRM_Utils_Date
::customFormat($row['activity_date'], '%B %E%f, %Y %l:%M %P');
243 // Regular JOIN statements here to limit results to contacts who have activities.
249 civicrm_contact contact_a
250 JOIN civicrm_activity activity
251 ON contact_a.id = activity.source_contact_id
252 JOIN civicrm_option_value ov1
253 ON activity.activity_type_id = ov1.value AND ov1.option_group_id = 2
254 JOIN civicrm_option_value ov2
255 ON activity.status_id = ov2.value AND ov2.option_group_id = {$this->_groupId}
256 JOIN civicrm_contact contact_b
257 ON activity.source_contact_id = contact_b.id
258 LEFT JOIN civicrm_case_activity cca
259 ON activity.id = cca.activity_id
260 LEFT JOIN civicrm_activity_assignment assignment
261 ON activity.id = assignment.activity_id
262 LEFT JOIN civicrm_contact contact_c
263 ON assignment.assignee_contact_id = contact_c.id ";
267 * WHERE clause is an array built from any required JOINS plus conditional filters based on search criteria field values
271 * @param bool $includeContactIDs
275 function where($includeContactIDs = FALSE) {
278 // add contact name search; search on primary name, source contact, assignee
279 $contactname = $this->_formValues
['sort_name'];
280 if (!empty($contactname)) {
281 $dao = new CRM_Core_DAO();
282 $contactname = $dao->escape($contactname);
283 $clauses[] = "(contact_a.sort_name LIKE '%{$contactname}%' OR
284 contact_b.sort_name LIKE '%{$contactname}%' OR
285 contact_c.display_name LIKE '%{$contactname}%')";
288 $subject = $this->_formValues
['activity_subject'];
290 if (!empty($this->_formValues
['contact_type'])) {
291 $clauses[] = "contact_a.contact_type LIKE '%{$this->_formValues['contact_type']}%'";
294 if (!empty($subject)) {
295 $dao = new CRM_Core_DAO();
296 $subject = $dao->escape($subject);
297 $clauses[] = "activity.subject LIKE '%{$subject}%'";
300 if (!empty($this->_formValues
['activity_status_id'])) {
301 $clauses[] = "activity.status_id = {$this->_formValues['activity_status_id']}";
304 if (!empty($this->_formValues
['activity_type_id'])) {
305 $clauses[] = "activity.activity_type_id = {$this->_formValues['activity_type_id']}";
308 $startDate = $this->_formValues
['start_date'];
309 if (!empty($startDate)) {
310 $startDate .= '00:00:00';
311 $startDateFormatted = CRM_Utils_Date
::processDate($startDate);
312 if ($startDateFormatted) {
313 $clauses[] = "activity.activity_date_time >= $startDateFormatted";
317 $endDate = $this->_formValues
['end_date'];
318 if (!empty($endDate)) {
319 $endDate .= '23:59:59';
320 $endDateFormatted = CRM_Utils_Date
::processDate($endDate);
321 if ($endDateFormatted) {
322 $clauses[] = "activity.activity_date_time <= $endDateFormatted";
326 if ($includeContactIDs) {
327 $contactIDs = array();
328 foreach ($this->_formValues
as $id => $value) {
330 substr($id, 0, CRM_Core_Form
::CB_PREFIX_LEN
) == CRM_Core_Form
::CB_PREFIX
332 $contactIDs[] = substr($id, CRM_Core_Form
::CB_PREFIX_LEN
);
336 if (!empty($contactIDs)) {
337 $contactIDs = implode(', ', $contactIDs);
338 $clauses[] = "contact_a.id IN ( $contactIDs )";
342 return implode(' AND ', $clauses);
346 * Functions below generally don't need to be modified
354 $dao = CRM_Core_DAO
::executeQuery($sql,
355 CRM_Core_DAO
::$_nullArray
362 * @param int $rowcount
367 function contactIDs($offset = 0, $rowcount = 0, $sort = NULL) {
368 return $this->all($offset, $rowcount, $sort, FALSE, TRUE);
374 function &columns() {
375 return $this->_columns
;
381 function setTitle($title) {
383 CRM_Utils_System
::setTitle($title);
386 CRM_Utils_System
::setTitle(ts('Search'));