Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
4 | | CiviCRM version 4.3 | | |
5 | +--------------------------------------------------------------------+ | |
6 | | Copyright CiviCRM LLC (c) 2004-2013 | | |
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-2013 | |
32 | * $Id$ | |
33 | * | |
34 | */ | |
35 | class CRM_Contact_Form_Search_Custom_ActivitySearch implements CRM_Contact_Form_Search_Interface { | |
36 | ||
430ae6dd TO |
37 | protected $_formValues; |
38 | ||
39 | function __construct(&$formValues) { | |
6a488035 TO |
40 | $this->_formValues = $formValues; |
41 | ||
42 | /** | |
43 | * Define the columns for search result rows | |
44 | */ | |
45 | $this->_columns = array( | |
46 | ts('Name') => 'sort_name', | |
47 | ts('Status') => 'activity_status', | |
48 | ts('Activity Type') => 'activity_type', | |
49 | ts('Activity Subject') => 'activity_subject', | |
50 | ts('Scheduled By') => 'source_contact', | |
51 | ts('Scheduled Date') => 'activity_date', | |
52 | ts(' ') => 'activity_id', | |
53 | ts(' ') => 'activity_type_id', | |
54 | ts(' ') => 'case_id', | |
55 | ts('Location') => 'location', | |
56 | ts('Duration') => 'duration', | |
57 | ts('Details') => 'details', | |
58 | ts('Assignee') => 'assignee', | |
59 | ); | |
60 | ||
61 | $this->_groupId = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionGroup', | |
62 | 'activity_status', | |
63 | 'id', | |
64 | 'name' | |
65 | ); | |
66 | ||
67 | //Add custom fields to columns array for inclusion in export | |
68 | $groupTree = &CRM_Core_BAO_CustomGroup::getTree('Activity', $form, NULL, | |
69 | NULL, '', NULL | |
70 | ); | |
71 | ||
72 | ||
73 | //use simplified formatted groupTree | |
74 | $groupTree = CRM_Core_BAO_CustomGroup::formatGroupTree($groupTree, 1, $form); | |
75 | ||
76 | //cycle through custom fields and assign to _columns array | |
77 | foreach ($groupTree as $key) { | |
78 | foreach ($key['fields'] as $field) { | |
79 | $fieldlabel = $key['title'] . ": " . $field['label']; | |
80 | $this->_columns[$fieldlabel] = $field['column_name']; | |
81 | } | |
82 | } | |
83 | //end custom fields | |
84 | } | |
85 | ||
86 | function buildForm(&$form) { | |
87 | ||
88 | /** | |
89 | * You can define a custom title for the search form | |
90 | */ | |
91 | $this->setTitle('Find Latest Activities'); | |
92 | ||
93 | /** | |
94 | * Define the search form fields here | |
95 | */ | |
96 | // Allow user to choose which type of contact to limit search on | |
97 | $form->add('select', 'contact_type', ts('Find...'), CRM_Core_SelectValues::contactType()); | |
98 | ||
99 | // Text box for Activity Subject | |
100 | $form->add('text', | |
101 | 'activity_subject', | |
102 | ts('Activity Subject') | |
103 | ); | |
104 | ||
105 | // Select box for Activity Type | |
106 | $activityType = array('' => ' - select activity - ') + CRM_Core_PseudoConstant::activityType(); | |
107 | ||
108 | $form->add('select', 'activity_type_id', ts('Activity Type'), | |
109 | $activityType, | |
110 | FALSE | |
111 | ); | |
112 | ||
113 | // textbox for Activity Status | |
114 | $activityStatus = array('' => ' - select status - ') + CRM_Core_PseudoConstant::activityStatus(); | |
115 | ||
116 | $form->add('select', 'activity_status_id', ts('Activity Status'), | |
117 | $activityStatus, | |
118 | FALSE | |
119 | ); | |
120 | ||
121 | // Activity Date range | |
122 | $form->addDate('start_date', ts('Activity Date From'), FALSE, array('formatType' => 'custom')); | |
123 | $form->addDate('end_date', ts('...through'), FALSE, array('formatType' => 'custom')); | |
124 | ||
125 | ||
126 | // Contact Name field | |
127 | $form->add('text', 'sort_name', ts('Contact Name')); | |
128 | ||
129 | /** | |
130 | * If you are using the sample template, this array tells the template fields to render | |
131 | * for the search form. | |
132 | */ | |
133 | $form->assign('elements', array( | |
134 | 'contact_type', 'activity_subject', 'activity_type_id', | |
135 | 'activity_status_id', 'start_date', 'end_date', 'sort_name', | |
136 | )); | |
137 | } | |
138 | ||
139 | /** | |
140 | * Define the smarty template used to layout the search form and results listings. | |
141 | */ | |
142 | function templateFile() { | |
143 | return 'CRM/Contact/Form/Search/Custom/ActivitySearch.tpl'; | |
144 | } | |
145 | ||
146 | /** | |
147 | * Construct the search query | |
148 | */ | |
149 | function all($offset = 0, $rowcount = 0, $sort = NULL, | |
150 | $includeContactIDs = FALSE, $justIDs = FALSE | |
151 | ) { | |
152 | ||
153 | // SELECT clause must include contact_id as an alias for civicrm_contact.id | |
154 | if ($justIDs) { | |
155 | $select = 'contact_a.id as contact_id'; | |
156 | } | |
157 | else { | |
158 | $select = ' | |
159 | contact_a.id as contact_id, | |
160 | contact_a.sort_name as sort_name, | |
161 | contact_a.contact_type as contact_type, | |
162 | activity.id as activity_id, | |
163 | activity.activity_type_id as activity_type_id, | |
164 | contact_b.sort_name as source_contact, | |
165 | ov1.label as activity_type, | |
166 | activity.subject as activity_subject, | |
167 | activity.activity_date_time as activity_date, | |
168 | ov2.label as activity_status, | |
169 | cca.case_id as case_id, | |
170 | activity.location as location, | |
171 | activity.duration as duration, | |
172 | activity.details as details, | |
173 | assignment.activity_id as assignment_activity, | |
174 | contact_c.display_name as assignee | |
175 | '; | |
176 | } | |
177 | ||
178 | $from = $this->from(); | |
179 | ||
180 | $where = $this->where($includeContactIDs); | |
181 | ||
182 | if (!empty($where)) { | |
183 | $where = "WHERE $where"; | |
184 | } | |
185 | ||
186 | // add custom group fields to SELECT and FROM clause | |
187 | $groupTree = CRM_Core_BAO_CustomGroup::getTree('Activity', $form, NULL, NULL, '', NULL); | |
188 | ||
189 | foreach ($groupTree as $key) { | |
190 | if ($key['extends'] == 'Activity') { | |
191 | $select .= ", " . $key['table_name'] . ".*"; | |
192 | $from .= " LEFT JOIN " . $key['table_name'] . " ON " . $key['table_name'] . ".entity_id = activity.id"; | |
193 | } | |
194 | } | |
195 | // end custom groups add | |
196 | ||
197 | $sql = " SELECT $select FROM $from $where "; | |
198 | ||
199 | //no need to add order when only contact Ids. | |
200 | if (!$justIDs) { | |
201 | // Define ORDER BY for query in $sort, with default value | |
202 | if (!empty($sort)) { | |
203 | if (is_string($sort)) { | |
204 | $sql .= " ORDER BY $sort "; | |
205 | } | |
206 | else { | |
207 | $sql .= ' ORDER BY ' . trim($sort->orderBy()); | |
208 | } | |
209 | } | |
210 | else { | |
211 | $sql .= 'ORDER BY contact_a.sort_name, activity.activity_date_time DESC, activity.activity_type_id, activity.status_id, activity.subject'; | |
212 | } | |
213 | } | |
214 | ||
215 | if ($rowcount > 0 && $offset >= 0) { | |
bf00d1b6 DL |
216 | $offset = CRM_Utils_Type::escape($offset, 'Int'); |
217 | $rowCount = CRM_Utils_Type::escape($rowCount, 'Int'); | |
6a488035 TO |
218 | $sql .= " LIMIT $offset, $rowcount "; |
219 | } | |
220 | return $sql; | |
221 | } | |
222 | ||
223 | // Alters the date display in the Activity Date Column. We do this after we already have | |
224 | // the result so that sorting on the date column stays pertinent to the numeric date value | |
225 | function alterRow(&$row) { | |
226 | $row['activity_date'] = CRM_Utils_Date::customFormat($row['activity_date'], '%B %E%f, %Y %l:%M %P'); | |
227 | } | |
228 | ||
229 | // Regular JOIN statements here to limit results to contacts who have activities. | |
230 | function from() { | |
231 | return " | |
232 | civicrm_contact contact_a | |
233 | JOIN civicrm_activity activity | |
234 | ON contact_a.id = activity.source_contact_id | |
235 | JOIN civicrm_option_value ov1 | |
236 | ON activity.activity_type_id = ov1.value AND ov1.option_group_id = 2 | |
237 | JOIN civicrm_option_value ov2 | |
238 | ON activity.status_id = ov2.value AND ov2.option_group_id = {$this->_groupId} | |
239 | JOIN civicrm_contact contact_b | |
240 | ON activity.source_contact_id = contact_b.id | |
241 | LEFT JOIN civicrm_case_activity cca | |
242 | ON activity.id = cca.activity_id | |
243 | LEFT JOIN civicrm_activity_assignment assignment | |
244 | ON activity.id = assignment.activity_id | |
245 | LEFT JOIN civicrm_contact contact_c | |
246 | ON assignment.assignee_contact_id = contact_c.id "; | |
247 | } | |
248 | ||
249 | /* | |
250 | * WHERE clause is an array built from any required JOINS plus conditional filters based on search criteria field values | |
251 | * | |
252 | */ | |
253 | function where($includeContactIDs = FALSE) { | |
254 | $clauses = array(); | |
255 | ||
256 | // add contact name search; search on primary name, source contact, assignee | |
257 | $contactname = $this->_formValues['sort_name']; | |
258 | if (!empty($contactname)) { | |
259 | $dao = new CRM_Core_DAO(); | |
260 | $contactname = $dao->escape($contactname); | |
261 | $clauses[] = "(contact_a.sort_name LIKE '%{$contactname}%' OR | |
262 | contact_b.sort_name LIKE '%{$contactname}%' OR | |
263 | contact_c.display_name LIKE '%{$contactname}%')"; | |
264 | } | |
265 | ||
266 | $subject = $this->_formValues['activity_subject']; | |
267 | ||
268 | if (!empty($this->_formValues['contact_type'])) { | |
269 | $clauses[] = "contact_a.contact_type LIKE '%{$this->_formValues['contact_type']}%'"; | |
270 | } | |
271 | ||
272 | if (!empty($subject)) { | |
273 | $dao = new CRM_Core_DAO(); | |
274 | $subject = $dao->escape($subject); | |
275 | $clauses[] = "activity.subject LIKE '%{$subject}%'"; | |
276 | } | |
277 | ||
278 | if (!empty($this->_formValues['activity_status_id'])) { | |
279 | $clauses[] = "activity.status_id = {$this->_formValues['activity_status_id']}"; | |
280 | } | |
281 | ||
282 | if (!empty($this->_formValues['activity_type_id'])) { | |
283 | $clauses[] = "activity.activity_type_id = {$this->_formValues['activity_type_id']}"; | |
284 | } | |
285 | ||
286 | $startDate = $this->_formValues['start_date']; | |
287 | if (!empty($startDate)) { | |
288 | $startDate .= '00:00:00'; | |
289 | $startDateFormatted = CRM_Utils_Date::processDate($startDate); | |
290 | if ($startDateFormatted) { | |
291 | $clauses[] = "activity.activity_date_time >= $startDateFormatted"; | |
292 | } | |
293 | } | |
294 | ||
295 | $endDate = $this->_formValues['end_date']; | |
296 | if (!empty($endDate)) { | |
297 | $endDate .= '23:59:59'; | |
298 | $endDateFormatted = CRM_Utils_Date::processDate($endDate); | |
299 | if ($endDateFormatted) { | |
300 | $clauses[] = "activity.activity_date_time <= $endDateFormatted"; | |
301 | } | |
302 | } | |
303 | ||
304 | if ($includeContactIDs) { | |
305 | $contactIDs = array(); | |
306 | foreach ($this->_formValues as $id => $value) { | |
307 | if ($value && | |
308 | substr($id, 0, CRM_Core_Form::CB_PREFIX_LEN) == CRM_Core_Form::CB_PREFIX | |
309 | ) { | |
310 | $contactIDs[] = substr($id, CRM_Core_Form::CB_PREFIX_LEN); | |
311 | } | |
312 | } | |
313 | ||
314 | if (!empty($contactIDs)) { | |
315 | $contactIDs = implode(', ', $contactIDs); | |
316 | $clauses[] = "contact_a.id IN ( $contactIDs )"; | |
317 | } | |
318 | } | |
319 | ||
320 | return implode(' AND ', $clauses); | |
321 | } | |
322 | ||
323 | /* | |
324 | * Functions below generally don't need to be modified | |
325 | */ | |
326 | function count() { | |
327 | $sql = $this->all(); | |
328 | ||
329 | $dao = CRM_Core_DAO::executeQuery($sql, | |
330 | CRM_Core_DAO::$_nullArray | |
331 | ); | |
332 | return $dao->N; | |
333 | } | |
334 | ||
335 | function contactIDs($offset = 0, $rowcount = 0, $sort = NULL) { | |
336 | return $this->all($offset, $rowcount, $sort, FALSE, TRUE); | |
337 | } | |
338 | ||
339 | function &columns() { | |
340 | return $this->_columns; | |
341 | } | |
342 | ||
343 | function setTitle($title) { | |
344 | if ($title) { | |
345 | CRM_Utils_System::setTitle($title); | |
346 | } | |
347 | else { | |
348 | CRM_Utils_System::setTitle(ts('Search')); | |
349 | } | |
350 | } | |
351 | ||
352 | function summary() { | |
353 | return NULL; | |
354 | } | |
355 | } | |
356 |