Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
6a488035 TO |
2 | /* |
3 | +--------------------------------------------------------------------+ | |
81621fee | 4 | | CiviCRM version 4.7 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
fa938177 | 6 | | Copyright CiviCRM LLC (c) 2004-2016 | |
6a488035 TO |
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 | /** | |
244bbdd8 | 29 | * This api exposes CiviCRM Activity records. |
6a488035 TO |
30 | * |
31 | * @package CiviCRM_APIv3 | |
6a488035 TO |
32 | */ |
33 | ||
34 | ||
35 | /** | |
61fe4988 | 36 | * Creates or updates an Activity. |
6a488035 | 37 | * |
cf470720 | 38 | * @param array $params |
c28e1768 | 39 | * Array per getfields documentation. |
6a488035 | 40 | * |
77b97be7 | 41 | * @throws API_Exception |
a6c01b45 | 42 | * @return array |
00f8641b | 43 | * API result array |
6a488035 TO |
44 | */ |
45 | function civicrm_api3_activity_create($params) { | |
46 | ||
a7488080 | 47 | if (empty($params['id'])) { |
6a488035 TO |
48 | // an update does not require any mandatory parameters |
49 | civicrm_api3_verify_one_mandatory($params, | |
50 | NULL, | |
51 | array( | |
7cdbcb16 TO |
52 | 'activity_name', |
53 | 'activity_type_id', | |
54 | 'activity_label', | |
6a488035 TO |
55 | ) |
56 | ); | |
57 | } | |
58 | ||
6a488035 TO |
59 | // check for various error and required conditions |
60 | // note that almost all the processing in there should be managed by the wrapper layer | |
61 | // & should be removed - needs testing | |
62 | $errors = _civicrm_api3_activity_check_params($params); | |
63 | ||
64 | // this should not be required as should throw exception rather than return errors - | |
65 | //needs testing | |
66 | if (!empty($errors)) { | |
67 | return $errors; | |
68 | } | |
69 | ||
6a488035 | 70 | // processing for custom data |
10114f2d | 71 | $values = $activityArray = array(); |
6a488035 TO |
72 | _civicrm_api3_custom_format_params($params, $values, 'Activity'); |
73 | ||
74 | if (!empty($values['custom'])) { | |
75 | $params['custom'] = $values['custom']; | |
76 | } | |
77 | ||
78 | // this should be set as a default rather than hard coded | |
79 | // needs testing | |
80 | $params['skipRecentView'] = TRUE; | |
81 | ||
82 | // If this is a case activity, see if there is an existing activity | |
83 | // and set it as an old revision. Also retrieve details we'll need. | |
84 | // this handling should all be moved to the BAO layer | |
7cdbcb16 TO |
85 | $case_id = ''; |
86 | $createRevision = FALSE; | |
6a488035 | 87 | $oldActivityValues = array(); |
e96d5fa3 CW |
88 | // Lookup case id if not supplied |
89 | if (!isset($params['case_id']) && !empty($params['id'])) { | |
90 | $params['case_id'] = CRM_Core_DAO::singleValueQuery("SELECT case_id FROM civicrm_case_activity WHERE activity_id = " . (int) $params['id']); | |
91 | } | |
a7488080 | 92 | if (!empty($params['case_id'])) { |
6a488035 | 93 | $case_id = $params['case_id']; |
a7488080 | 94 | if (!empty($params['id'])) { |
6a488035 TO |
95 | $oldActivityParams = array('id' => $params['id']); |
96 | if (!$oldActivityValues) { | |
97 | CRM_Activity_BAO_Activity::retrieve($oldActivityParams, $oldActivityValues); | |
98 | } | |
99 | if (empty($oldActivityValues)) { | |
10114f2d | 100 | throw new API_Exception(ts("Unable to locate existing activity.")); |
6a488035 TO |
101 | } |
102 | else { | |
103 | $activityDAO = new CRM_Activity_DAO_Activity(); | |
104 | $activityDAO->id = $params['id']; | |
105 | $activityDAO->is_current_revision = 0; | |
106 | if (!$activityDAO->save()) { | |
08007144 TO |
107 | if (is_object($activityDAO)) { |
108 | $activityDAO->free(); | |
109 | } | |
10114f2d | 110 | throw new API_Exception(ts("Unable to revision existing case activity.")); |
6a488035 TO |
111 | } |
112 | $createRevision = TRUE; | |
113 | } | |
114 | } | |
115 | } | |
116 | ||
117 | $deleteActivityAssignment = FALSE; | |
118 | if (isset($params['assignee_contact_id'])) { | |
119 | $deleteActivityAssignment = TRUE; | |
120 | } | |
121 | ||
122 | $deleteActivityTarget = FALSE; | |
123 | if (isset($params['target_contact_id'])) { | |
124 | $deleteActivityTarget = TRUE; | |
125 | } | |
126 | ||
127 | // this should all be handled at the BAO layer | |
128 | $params['deleteActivityAssignment'] = CRM_Utils_Array::value('deleteActivityAssignment', $params, $deleteActivityAssignment); | |
129 | $params['deleteActivityTarget'] = CRM_Utils_Array::value('deleteActivityTarget', $params, $deleteActivityTarget); | |
130 | ||
131 | if ($case_id && $createRevision) { | |
132 | // This is very similar to the copy-to-case action. | |
133 | if (!CRM_Utils_Array::crmIsEmptyArray($oldActivityValues['target_contact'])) { | |
134 | $oldActivityValues['targetContactIds'] = implode(',', array_unique($oldActivityValues['target_contact'])); | |
135 | } | |
136 | if (!CRM_Utils_Array::crmIsEmptyArray($oldActivityValues['assignee_contact'])) { | |
137 | $oldActivityValues['assigneeContactIds'] = implode(',', array_unique($oldActivityValues['assignee_contact'])); | |
138 | } | |
139 | $oldActivityValues['mode'] = 'copy'; | |
140 | $oldActivityValues['caseID'] = $case_id; | |
141 | $oldActivityValues['activityID'] = $oldActivityValues['id']; | |
142 | $oldActivityValues['contactID'] = $oldActivityValues['source_contact_id']; | |
143 | ||
144 | $copyToCase = CRM_Activity_Page_AJAX::_convertToCaseActivity($oldActivityValues); | |
145 | if (empty($copyToCase['error_msg'])) { | |
146 | // now fix some things that are different from copy-to-case | |
147 | // then fall through to the create below to update with the passed in params | |
148 | $params['id'] = $copyToCase['newId']; | |
149 | $params['is_auto'] = 0; | |
150 | $params['original_id'] = empty($oldActivityValues['original_id']) ? $oldActivityValues['id'] : $oldActivityValues['original_id']; | |
151 | } | |
152 | else { | |
10114f2d | 153 | throw new API_Exception(ts("Unable to create new revision of case activity.")); |
6a488035 TO |
154 | } |
155 | } | |
156 | ||
157 | // create activity | |
158 | $activityBAO = CRM_Activity_BAO_Activity::create($params); | |
159 | ||
160 | if (isset($activityBAO->id)) { | |
161 | if ($case_id && !$createRevision) { | |
162 | // If this is a brand new case activity we need to add this | |
163 | $caseActivityParams = array('activity_id' => $activityBAO->id, 'case_id' => $case_id); | |
164 | CRM_Case_BAO_Case::processCaseActivity($caseActivityParams); | |
165 | } | |
166 | ||
167 | _civicrm_api3_object_to_array($activityBAO, $activityArray[$activityBAO->id]); | |
244bbdd8 | 168 | return civicrm_api3_create_success($activityArray, $params, 'Activity', 'get', $activityBAO); |
6a488035 TO |
169 | } |
170 | } | |
11e09c59 TO |
171 | |
172 | /** | |
61fe4988 EM |
173 | * Specify Meta data for create. |
174 | * | |
175 | * Note that this data is retrievable via the getfields function and is used for pre-filling defaults and | |
176 | * ensuring mandatory requirements are met. | |
177 | * | |
cf470720 | 178 | * @param array $params |
c28e1768 | 179 | * Array of parameters determined by getfields. |
6a488035 TO |
180 | */ |
181 | function _civicrm_api3_activity_create_spec(&$params) { | |
182 | ||
61fe4988 | 183 | // Default for source_contact_id = currently logged in user. |
6a488035 TO |
184 | $params['source_contact_id']['api.default'] = 'user_contact_id'; |
185 | ||
67744c4e CW |
186 | $params['status_id']['api.aliases'] = array('activity_status'); |
187 | ||
6a488035 TO |
188 | $params['assignee_contact_id'] = array( |
189 | 'name' => 'assignee_id', | |
0a24dc9a CW |
190 | 'title' => 'Activity Assignee', |
191 | 'description' => 'Contact(s) assigned to this activity.', | |
6a488035 | 192 | 'type' => 1, |
7e61908b | 193 | 'FKClassName' => 'CRM_Contact_DAO_Contact', |
0a24dc9a | 194 | 'FKApiName' => 'Contact', |
6a488035 TO |
195 | ); |
196 | $params['target_contact_id'] = array( | |
197 | 'name' => 'target_id', | |
198 | 'title' => 'Activity Target', | |
0a24dc9a | 199 | 'description' => 'Contact(s) participating in this activity.', |
6a488035 | 200 | 'type' => 1, |
7e61908b | 201 | 'FKClassName' => 'CRM_Contact_DAO_Contact', |
0a24dc9a | 202 | 'FKApiName' => 'Contact', |
6a488035 | 203 | ); |
2f3d72cf | 204 | |
205 | $params['source_contact_id'] = array( | |
7cdbcb16 TO |
206 | 'name' => 'source_contact_id', |
207 | 'title' => 'Activity Source Contact', | |
0a24dc9a | 208 | 'description' => 'Person who created this activity. Defaults to current user.', |
7cdbcb16 | 209 | 'type' => 1, |
7e61908b | 210 | 'FKClassName' => 'CRM_Contact_DAO_Contact', |
7cdbcb16 | 211 | 'api.default' => 'user_contact_id', |
0a24dc9a CW |
212 | 'FKApiName' => 'Contact', |
213 | ); | |
214 | ||
215 | $params['case_id'] = array( | |
216 | 'name' => 'case_id', | |
217 | 'title' => 'Case ID', | |
218 | 'description' => 'For creating an activity as part of a case.', | |
219 | 'type' => 1, | |
220 | 'FKClassName' => 'CRM_Case_DAO_Case', | |
221 | 'FKApiName' => 'Case', | |
2f3d72cf | 222 | ); |
223 | ||
6a488035 TO |
224 | } |
225 | ||
226 | /** | |
61fe4988 | 227 | * Gets a CiviCRM activity according to parameters. |
6a488035 | 228 | * |
cf470720 | 229 | * @param array $params |
61fe4988 | 230 | * Array per getfields documentation. |
6a488035 TO |
231 | * |
232 | * @return array | |
00f8641b | 233 | * API result array |
6a488035 TO |
234 | */ |
235 | function civicrm_api3_activity_get($params) { | |
236 | if (!empty($params['contact_id'])) { | |
237 | $activities = CRM_Activity_BAO_Activity::getContactActivity($params['contact_id']); | |
61fe4988 EM |
238 | // BAO function doesn't actually return a contact ID - hack api for now & add to test so when api re-write |
239 | // happens it won't get missed. | |
6a488035 TO |
240 | foreach ($activities as $key => $activityArray) { |
241 | $activities[$key]['id'] = $key; | |
242 | } | |
243 | } | |
244 | else { | |
01c8287d | 245 | $sql = CRM_Utils_SQL_Select::fragment(); |
0298287b | 246 | $options = civicrm_api3('ActivityContact', 'getoptions', array('field' => 'record_type_id')); |
247 | $options = $options['values']; | |
248 | $activityContactOptions = array( | |
249 | 'target_contact_id' => array_search('Activity Targets', $options), | |
250 | 'source_contact_id' => array_search('Activity Source', $options), | |
251 | 'assignee_contact_id' => array_search('Activity Assignees', $options), | |
252 | ); | |
253 | foreach ($activityContactOptions as $activityContactName => $activityContactValue) { | |
254 | if (!empty($params[$activityContactName])) { | |
01c8287d TO |
255 | // If the intent is to have multiple joins -- one for each relation -- then you would |
256 | // need different table aliases. Consider replacing 'ac' and passing in a '!alias' param, | |
257 | // with a different value for each relation. | |
258 | $sql->join( | |
259 | 'activity_' . $activityContactName, | |
260 | 'LEFT JOIN civicrm_activity_contact ac ON a.id = ac.activity_id AND ac.record_type_id = #typeId', | |
261 | array('typeId' => $activityContactValue) | |
0298287b | 262 | ); |
01c8287d TO |
263 | $sql->where('ac.contact_id IN (#cid)', array( |
264 | 'cid' => $params[$activityContactName], | |
265 | )); | |
0298287b | 266 | } |
267 | } | |
01c8287d | 268 | $activities = _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params, FALSE, 'Activity', $sql); |
6a488035 | 269 | } |
244bbdd8 | 270 | $options = _civicrm_api3_get_options_from_params($params, FALSE, 'Activity', 'get'); |
22e263ad | 271 | if ($options['is_count']) { |
244bbdd8 | 272 | return civicrm_api3_create_success($activities, $params, 'Activity', 'get'); |
e2e3c1ce | 273 | } |
6a488035 | 274 | |
ab5fa8f2 TO |
275 | $activities = _civicrm_api3_activity_get_formatResult($params, $activities); |
276 | //legacy custom data get - so previous formatted response is still returned too | |
244bbdd8 | 277 | return civicrm_api3_create_success($activities, $params, 'Activity', 'get'); |
ab5fa8f2 TO |
278 | } |
279 | ||
280 | /** | |
61fe4988 | 281 | * Given a list of activities, append any extra data requested about the activities. |
ab5fa8f2 | 282 | * |
b081365f | 283 | * @note Called by civicrm-core and CiviHR |
ab5fa8f2 | 284 | * |
cf470720 TO |
285 | * @param array $params |
286 | * API request parameters. | |
ab5fa8f2 | 287 | * @param array $activities |
61fe4988 | 288 | * |
a6c01b45 | 289 | * @return array |
72b3a70c | 290 | * new activities list |
ab5fa8f2 TO |
291 | */ |
292 | function _civicrm_api3_activity_get_formatResult($params, $activities) { | |
6a488035 TO |
293 | $returns = CRM_Utils_Array::value('return', $params, array()); |
294 | if (!is_array($returns)) { | |
295 | $returns = str_replace(' ', '', $returns); | |
296 | $returns = explode(',', $returns); | |
297 | } | |
298 | $returns = array_fill_keys($returns, 1); | |
299 | ||
300 | foreach ($params as $n => $v) { | |
301 | if (substr($n, 0, 7) == 'return.') { | |
302 | $returnkey = substr($n, 7); | |
303 | $returns[$returnkey] = $v; | |
304 | } | |
305 | } | |
0298287b | 306 | |
2f3d72cf | 307 | $returns['source_contact_id'] = 1; |
6a488035 TO |
308 | foreach ($returns as $n => $v) { |
309 | switch ($n) { | |
310 | case 'assignee_contact_id': | |
311 | foreach ($activities as $key => $activityArray) { | |
312 | $activities[$key]['assignee_contact_id'] = CRM_Activity_BAO_ActivityAssignment::retrieveAssigneeIdsByActivityId($activityArray['id']); | |
313 | } | |
314 | break; | |
35671d00 | 315 | |
6a488035 TO |
316 | case 'target_contact_id': |
317 | foreach ($activities as $key => $activityArray) { | |
318 | $activities[$key]['target_contact_id'] = CRM_Activity_BAO_ActivityTarget::retrieveTargetIdsByActivityId($activityArray['id']); | |
319 | } | |
320 | break; | |
35671d00 | 321 | |
42d30b83 DL |
322 | case 'source_contact_id': |
323 | foreach ($activities as $key => $activityArray) { | |
324 | $activities[$key]['source_contact_id'] = CRM_Activity_BAO_Activity::getSourceContactID($activityArray['id']); | |
325 | } | |
326 | break; | |
35671d00 | 327 | |
6a488035 TO |
328 | default: |
329 | if (substr($n, 0, 6) == 'custom') { | |
330 | $returnProperties[$n] = $v; | |
331 | } | |
332 | } | |
333 | } | |
334 | if (!empty($activities) && (!empty($returnProperties) || !empty($params['contact_id']))) { | |
335 | foreach ($activities as $activityId => $values) { | |
10114f2d | 336 | //@todo - should possibly load activity type id if not loaded (update with id) |
e9ff5391 | 337 | _civicrm_api3_custom_data_get($activities[$activityId], CRM_Utils_Array::value('check_permissions', $params), 'Activity', $activityId, NULL, CRM_Utils_Array::value('activity_type_id', $values)); |
6a488035 TO |
338 | } |
339 | } | |
ab5fa8f2 | 340 | return $activities; |
6a488035 TO |
341 | } |
342 | ||
2f3d72cf | 343 | |
6a488035 TO |
344 | /** |
345 | * Delete a specified Activity. | |
346 | * | |
cf470720 TO |
347 | * @param array $params |
348 | * Array holding 'id' of activity to be deleted. | |
6a488035 | 349 | * |
10114f2d | 350 | * @throws API_Exception |
6a488035 | 351 | * |
61fe4988 | 352 | * @return array |
00f8641b | 353 | * API result array |
6a488035 TO |
354 | */ |
355 | function civicrm_api3_activity_delete($params) { | |
356 | ||
357 | if (CRM_Activity_BAO_Activity::deleteActivity($params)) { | |
244bbdd8 | 358 | return civicrm_api3_create_success(1, $params, 'Activity', 'delete'); |
6a488035 TO |
359 | } |
360 | else { | |
244bbdd8 | 361 | throw new API_Exception('Could not delete Activity'); |
6a488035 TO |
362 | } |
363 | } | |
364 | ||
365 | /** | |
61fe4988 | 366 | * Check for required params. |
6a488035 | 367 | * |
cf470720 TO |
368 | * @param array $params |
369 | * Associated array of fields. | |
10114f2d EM |
370 | * |
371 | * @throws API_Exception | |
372 | * @throws Exception | |
a6c01b45 | 373 | * @return array |
72b3a70c | 374 | * array with errors |
6a488035 TO |
375 | */ |
376 | function _civicrm_api3_activity_check_params(&$params) { | |
377 | ||
378 | $contactIDFields = array_intersect_key($params, | |
7cdbcb16 TO |
379 | array( |
380 | 'source_contact_id' => 1, | |
381 | 'assignee_contact_id' => 1, | |
382 | 'target_contact_id' => 1, | |
383 | ) | |
6a488035 | 384 | ); |
42d30b83 DL |
385 | |
386 | // this should be handled by wrapper layer & probably the api would already manage it | |
387 | //correctly by doing post validation - ie. a failure should result in a roll-back = an error | |
388 | // needs testing | |
6a488035 TO |
389 | if (!empty($contactIDFields)) { |
390 | $contactIds = array(); | |
391 | foreach ($contactIDFields as $fieldname => $contactfield) { | |
392 | if (empty($contactfield)) { | |
393 | continue; | |
394 | } | |
395 | if (is_array($contactfield)) { | |
396 | foreach ($contactfield as $contactkey => $contactvalue) { | |
397 | $contactIds[$contactvalue] = $contactvalue; | |
398 | } | |
399 | } | |
400 | else { | |
401 | $contactIds[$contactfield] = $contactfield; | |
402 | } | |
403 | } | |
404 | ||
6a488035 TO |
405 | $sql = ' |
406 | SELECT count(*) | |
407 | FROM civicrm_contact | |
408 | WHERE id IN (' . implode(', ', $contactIds) . ' )'; | |
409 | if (count($contactIds) != CRM_Core_DAO::singleValueQuery($sql)) { | |
61fe4988 | 410 | throw new API_Exception('Invalid Contact Id'); |
6a488035 TO |
411 | } |
412 | } | |
413 | ||
35671d00 | 414 | $activityIds = array( |
7cdbcb16 TO |
415 | 'activity' => CRM_Utils_Array::value('id', $params), |
416 | 'parent' => CRM_Utils_Array::value('parent_id', $params), | |
417 | 'original' => CRM_Utils_Array::value('original_id', $params), | |
6a488035 TO |
418 | ); |
419 | ||
420 | foreach ($activityIds as $id => $value) { | |
421 | if ($value && | |
422 | !CRM_Core_DAO::getFieldValue('CRM_Activity_DAO_Activity', $value, 'id') | |
423 | ) { | |
10114f2d | 424 | throw new API_Exception('Invalid ' . ucfirst($id) . ' Id'); |
6a488035 TO |
425 | } |
426 | } | |
427 | // this should be handled by wrapper layer & probably the api would already manage it | |
428 | //correctly by doing pseudoconstant validation | |
429 | // needs testing | |
a60ed840 | 430 | $activityTypes = CRM_Activity_BAO_Activity::buildOptions('activity_type_id', 'validate'); |
7cdbcb16 TO |
431 | $activityName = CRM_Utils_Array::value('activity_name', $params); |
432 | $activityName = ucfirst($activityName); | |
6a488035 TO |
433 | $activityLabel = CRM_Utils_Array::value('activity_label', $params); |
434 | if ($activityLabel) { | |
a60ed840 | 435 | $activityTypes = CRM_Activity_BAO_Activity::buildOptions('activity_type_id', 'create'); |
6a488035 TO |
436 | } |
437 | ||
438 | $activityTypeId = CRM_Utils_Array::value('activity_type_id', $params); | |
439 | ||
440 | if ($activityName || $activityLabel) { | |
441 | $activityTypeIdInList = array_search(($activityName ? $activityName : $activityLabel), $activityTypes); | |
442 | ||
443 | if (!$activityTypeIdInList) { | |
35671d00 | 444 | $errorString = $activityName ? "Invalid Activity Name : $activityName" : "Invalid Activity Type Label"; |
6a488035 TO |
445 | throw new Exception($errorString); |
446 | } | |
447 | elseif ($activityTypeId && ($activityTypeId != $activityTypeIdInList)) { | |
10114f2d | 448 | throw new API_Exception('Mismatch in Activity'); |
6a488035 TO |
449 | } |
450 | $params['activity_type_id'] = $activityTypeIdInList; | |
451 | } | |
452 | elseif ($activityTypeId && | |
453 | !array_key_exists($activityTypeId, $activityTypes) | |
454 | ) { | |
10114f2d | 455 | throw new API_Exception('Invalid Activity Type ID'); |
6a488035 TO |
456 | } |
457 | ||
6a488035 TO |
458 | // check for activity duration minutes |
459 | // this should be validated @ the wrapper layer not here | |
460 | // needs testing | |
461 | if (isset($params['duration_minutes']) && !is_numeric($params['duration_minutes'])) { | |
10114f2d | 462 | throw new API_Exception('Invalid Activity Duration (in minutes)'); |
6a488035 TO |
463 | } |
464 | ||
6a488035 TO |
465 | //if adding a new activity & date_time not set make it now |
466 | // this should be managed by the wrapper layer & setting ['api.default'] in speces | |
467 | // needs testing | |
8cc574cf | 468 | if (empty($params['id']) && empty($params['activity_date_time'])) { |
6a488035 TO |
469 | $params['activity_date_time'] = CRM_Utils_Date::processDate(date('Y-m-d H:i:s')); |
470 | } | |
471 | ||
472 | return NULL; | |
473 | } | |
474 | ||
dabf9814 | 475 | /** |
61fe4988 EM |
476 | * Get parameters for activity list. |
477 | * | |
7cdbcb16 | 478 | * @see _civicrm_api3_generic_getlist_params |
dabf9814 | 479 | * |
7cdbcb16 TO |
480 | * @param array $request |
481 | * API request. | |
dabf9814 CW |
482 | */ |
483 | function _civicrm_api3_activity_getlist_params(&$request) { | |
7cdbcb16 TO |
484 | $fieldsToReturn = array( |
485 | 'activity_date_time', | |
486 | 'activity_type_id', | |
487 | 'subject', | |
488 | 'source_contact_id', | |
489 | ); | |
dabf9814 CW |
490 | $request['params']['return'] = array_unique(array_merge($fieldsToReturn, $request['extra'])); |
491 | $request['params']['options']['sort'] = 'activity_date_time DESC'; | |
492 | $request['params'] += array( | |
493 | 'is_current_revision' => 1, | |
494 | 'is_deleted' => 0, | |
495 | ); | |
496 | } | |
497 | ||
498 | /** | |
61fe4988 EM |
499 | * Get output for activity list. |
500 | * | |
dabf9814 CW |
501 | * @see _civicrm_api3_generic_getlist_output |
502 | * | |
8c6b335b CW |
503 | * @param array $result |
504 | * @param array $request | |
dabf9814 CW |
505 | * |
506 | * @return array | |
507 | */ | |
508 | function _civicrm_api3_activity_getlist_output($result, $request) { | |
509 | $output = array(); | |
510 | if (!empty($result['values'])) { | |
511 | foreach ($result['values'] as $row) { | |
512 | $data = array( | |
513 | 'id' => $row[$request['id_field']], | |
514 | 'label' => $row[$request['label_field']] ? $row[$request['label_field']] : ts('(no subject)'), | |
7cdbcb16 TO |
515 | 'description' => array( |
516 | CRM_Core_Pseudoconstant::getLabel('CRM_Activity_BAO_Activity', 'activity_type_id', $row['activity_type_id']), | |
517 | ), | |
dabf9814 CW |
518 | ); |
519 | if (!empty($row['activity_date_time'])) { | |
520 | $data['description'][0] .= ': ' . CRM_Utils_Date::customFormat($row['activity_date_time']); | |
521 | } | |
522 | if (!empty($row['source_contact_id'])) { | |
7cdbcb16 TO |
523 | $data['description'][] = ts('By %1', array( |
524 | 1 => CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $row['source_contact_id'], 'display_name'), | |
525 | )); | |
dabf9814 | 526 | } |
8a938c69 CW |
527 | // Add repeating info |
528 | $repeat = CRM_Core_BAO_RecurringEntity::getPositionAndCount($row['id'], 'civicrm_activity'); | |
529 | $data['extra']['is_recur'] = FALSE; | |
530 | if ($repeat) { | |
531 | $data['suffix'] = ts('(%1 of %2)', array(1 => $repeat[0], 2 => $repeat[1])); | |
532 | $data['extra']['is_recur'] = TRUE; | |
533 | } | |
dabf9814 CW |
534 | $output[] = $data; |
535 | } | |
536 | } | |
537 | return $output; | |
538 | } |