3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2017 |
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 +--------------------------------------------------------------------+
29 * This api exposes CiviCRM Activity records.
31 * @package CiviCRM_APIv3
36 * Creates or updates an Activity.
38 * @param array $params
39 * Array per getfields documentation.
41 * @throws API_Exception
45 function civicrm_api3_activity_create($params) {
46 $isNew = empty($params['id']);
48 if (empty($params['id'])) {
49 // an update does not require any mandatory parameters
50 civicrm_api3_verify_one_mandatory($params,
60 // check for various error and required conditions
61 // note that almost all the processing in there should be managed by the wrapper layer
62 // & should be removed - needs testing
63 $errors = _civicrm_api3_activity_check_params($params);
65 // this should not be required as should throw exception rather than return errors -
67 if (!empty($errors)) {
71 // processing for custom data
72 $values = $activityArray = array();
73 _civicrm_api3_custom_format_params($params, $values, 'Activity');
75 if (!empty($values['custom'])) {
76 $params['custom'] = $values['custom'];
79 // this should be set as a default rather than hard coded
81 $params['skipRecentView'] = TRUE;
83 // If this is a case activity, see if there is an existing activity
84 // and set it as an old revision. Also retrieve details we'll need.
85 // this handling should all be moved to the BAO layer
87 $createRevision = FALSE;
88 $oldActivityValues = array();
89 // Lookup case id if not supplied
90 if (!isset($params['case_id']) && !empty($params['id'])) {
91 $params['case_id'] = CRM_Core_DAO
::singleValueQuery("SELECT case_id FROM civicrm_case_activity WHERE activity_id = " . (int) $params['id']);
93 if (!empty($params['case_id'])) {
94 $case_id = $params['case_id'];
95 if (!empty($params['id']) && Civi
::settings()->get('civicaseActivityRevisions')) {
96 $oldActivityParams = array('id' => $params['id']);
97 if (!$oldActivityValues) {
98 CRM_Activity_BAO_Activity
::retrieve($oldActivityParams, $oldActivityValues);
100 if (empty($oldActivityValues)) {
101 throw new API_Exception(ts("Unable to locate existing activity."));
104 $activityDAO = new CRM_Activity_DAO_Activity();
105 $activityDAO->id
= $params['id'];
106 $activityDAO->is_current_revision
= 0;
107 if (!$activityDAO->save()) {
108 if (is_object($activityDAO)) {
109 $activityDAO->free();
111 throw new API_Exception(ts("Unable to revision existing case activity."));
113 $createRevision = TRUE;
118 $deleteActivityAssignment = FALSE;
119 if (isset($params['assignee_contact_id'])) {
120 $deleteActivityAssignment = TRUE;
123 $deleteActivityTarget = FALSE;
124 if (isset($params['target_contact_id'])) {
125 $deleteActivityTarget = TRUE;
128 // this should all be handled at the BAO layer
129 $params['deleteActivityAssignment'] = CRM_Utils_Array
::value('deleteActivityAssignment', $params, $deleteActivityAssignment);
130 $params['deleteActivityTarget'] = CRM_Utils_Array
::value('deleteActivityTarget', $params, $deleteActivityTarget);
132 if ($case_id && $createRevision) {
133 // This is very similar to the copy-to-case action.
134 if (!CRM_Utils_Array
::crmIsEmptyArray($oldActivityValues['target_contact'])) {
135 $oldActivityValues['targetContactIds'] = implode(',', array_unique($oldActivityValues['target_contact']));
137 if (!CRM_Utils_Array
::crmIsEmptyArray($oldActivityValues['assignee_contact'])) {
138 $oldActivityValues['assigneeContactIds'] = implode(',', array_unique($oldActivityValues['assignee_contact']));
140 $oldActivityValues['mode'] = 'copy';
141 $oldActivityValues['caseID'] = $case_id;
142 $oldActivityValues['activityID'] = $oldActivityValues['id'];
143 $oldActivityValues['contactID'] = $oldActivityValues['source_contact_id'];
145 $copyToCase = CRM_Activity_Page_AJAX
::_convertToCaseActivity($oldActivityValues);
146 if (empty($copyToCase['error_msg'])) {
147 // now fix some things that are different from copy-to-case
148 // then fall through to the create below to update with the passed in params
149 $params['id'] = $copyToCase['newId'];
150 $params['is_auto'] = 0;
151 $params['original_id'] = empty($oldActivityValues['original_id']) ?
$oldActivityValues['id'] : $oldActivityValues['original_id'];
154 throw new API_Exception(ts("Unable to create new revision of case activity."));
159 $activityBAO = CRM_Activity_BAO_Activity
::create($params);
161 if (isset($activityBAO->id
)) {
162 if ($case_id && $isNew && !$createRevision) {
163 // If this is a brand new case activity, add to case(s)
164 foreach ((array) $case_id as $singleCaseId) {
165 $caseActivityParams = array('activity_id' => $activityBAO->id
, 'case_id' => $singleCaseId);
166 CRM_Case_BAO_Case
::processCaseActivity($caseActivityParams);
170 _civicrm_api3_object_to_array($activityBAO, $activityArray[$activityBAO->id
]);
171 return civicrm_api3_create_success($activityArray, $params, 'Activity', 'get', $activityBAO);
176 * Specify Meta data for create.
178 * Note that this data is retrievable via the getfields function and is used for pre-filling defaults and
179 * ensuring mandatory requirements are met.
181 * @param array $params
182 * Array of parameters determined by getfields.
184 function _civicrm_api3_activity_create_spec(&$params) {
186 $params['status_id']['api.aliases'] = array('activity_status');
188 $params['assignee_contact_id'] = array(
189 'name' => 'assignee_id',
190 'title' => 'Activity Assignee',
191 'description' => 'Contact(s) assigned to this activity.',
193 'FKClassName' => 'CRM_Contact_DAO_Contact',
194 'FKApiName' => 'Contact',
196 $params['target_contact_id'] = array(
197 'name' => 'target_id',
198 'title' => 'Activity Target',
199 'description' => 'Contact(s) participating in this activity.',
201 'FKClassName' => 'CRM_Contact_DAO_Contact',
202 'FKApiName' => 'Contact',
205 $params['source_contact_id'] = array(
206 'name' => 'source_contact_id',
207 'title' => 'Activity Source Contact',
208 'description' => 'Person who created this activity. Defaults to current user.',
210 'FKClassName' => 'CRM_Contact_DAO_Contact',
211 'api.default' => 'user_contact_id',
212 'FKApiName' => 'Contact',
213 'api.required' => TRUE,
216 $params['case_id'] = array(
218 'title' => 'Case ID',
219 'description' => 'For creating an activity as part of a case.',
221 'FKClassName' => 'CRM_Case_DAO_Case',
222 'FKApiName' => 'Case',
228 * Specify Metadata for get.
230 * @param array $params
232 function _civicrm_api3_activity_get_spec(&$params) {
233 $params['tag_id'] = array(
235 'description' => 'Find activities with specified tags.',
236 'type' => CRM_Utils_Type
::T_INT
,
237 'FKClassName' => 'CRM_Core_DAO_Tag',
238 'FKApiName' => 'Tag',
239 'supports_joins' => TRUE,
241 $params['file_id'] = array(
242 'title' => 'Attached Files',
243 'description' => 'Find activities with attached files.',
244 'type' => CRM_Utils_Type
::T_INT
,
245 'FKClassName' => 'CRM_Core_DAO_File',
246 'FKApiName' => 'File',
248 $params['case_id'] = array(
250 'description' => 'Find activities within specified cases.',
251 'type' => CRM_Utils_Type
::T_INT
,
252 'FKClassName' => 'CRM_Case_DAO_Case',
253 'FKApiName' => 'Case',
255 $params['contact_id'] = array(
256 'title' => 'Activity Contact ID',
257 'description' => 'Find activities involving this contact (as target, source, OR assignee).',
258 'type' => CRM_Utils_Type
::T_INT
,
259 'FKClassName' => 'CRM_Contact_DAO_Contact',
260 'FKApiName' => 'Contact',
262 $params['target_contact_id'] = array(
263 'title' => 'Target Contact ID',
264 'description' => 'Find activities with specified target contact.',
265 'type' => CRM_Utils_Type
::T_INT
,
266 'FKClassName' => 'CRM_Contact_DAO_Contact',
267 'FKApiName' => 'Contact',
269 $params['source_contact_id'] = array(
270 'title' => 'Source Contact ID',
271 'description' => 'Find activities with specified source contact.',
272 'type' => CRM_Utils_Type
::T_INT
,
273 'FKClassName' => 'CRM_Contact_DAO_Contact',
274 'FKApiName' => 'Contact',
276 $params['assignee_contact_id'] = array(
277 'title' => 'Assignee Contact ID',
278 'description' => 'Find activities with specified assignee contact.',
279 'type' => CRM_Utils_Type
::T_INT
,
280 'FKClassName' => 'CRM_Contact_DAO_Contact',
281 'FKApiName' => 'Contact',
283 $params['is_overdue'] = array(
284 'title' => 'Is Activity Overdue',
285 'description' => 'Incomplete activities with a past date.',
286 'type' => CRM_Utils_Type
::T_BOOLEAN
,
291 * Gets a CiviCRM activity according to parameters.
293 * @param array $params
294 * Array per getfields documentation.
296 * @return array API result array
299 * @throws \API_Exception
300 * @throws \CiviCRM_API3_Exception
301 * @throws \Civi\API\Exception\UnauthorizedException
303 function civicrm_api3_activity_get($params) {
304 $options = _civicrm_api3_get_options_from_params($params, FALSE, 'Activity', 'get');
305 $sql = CRM_Utils_SQL_Select
::fragment();
307 if (empty($params['target_contact_id']) && empty($params['source_contact_id'])
308 && empty($params['assignee_contact_id']) &&
309 !empty($params['check_permissions']) && !CRM_Core_Permission
::check('view all activities')
310 && !CRM_Core_Permission
::check('view all contacts')
312 // Force join on the activity contact table.
313 // @todo get this & other acl filters to work, remove check further down.
314 //$params['contact_id'] = array('IS NOT NULL' => TRUE);
317 _civicrm_api3_activity_get_extraFilters($params, $sql);
319 // Handle is_overdue sort
320 if (!empty($options['sort'])) {
321 $sort = explode(', ', $options['sort']);
323 foreach ($sort as $index => &$sortString) {
324 // Get sort field and direction
325 list($sortField, $dir) = array_pad(explode(' ', $sortString), 2, 'ASC');
326 if ($sortField == 'is_overdue') {
327 $incomplete = implode(',', array_keys(CRM_Activity_BAO_Activity
::getStatusesByType(CRM_Activity_BAO_Activity
::INCOMPLETE
)));
328 $sql->orderBy("IF((a.activity_date_time >= NOW() OR a.status_id NOT IN ($incomplete)), 0, 1) $dir", NULL, $index);
329 // Replace the sort with a placeholder which will be ignored by sql
333 $params['options']['sort'] = implode(', ', $sort);
336 // Ensure there's enough data for calculating is_overdue
337 if (!empty($options['return']['is_overdue']) && (empty($options['return']['status_id']) ||
empty($options['return']['activity_date_time']))) {
338 $options['return']['status_id'] = $options['return']['activity_date_time'] = 1;
339 $params['return'] = array_keys($options['return']);
342 $activities = _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params, FALSE, 'Activity', $sql);
343 if (!empty($params['check_permissions']) && !CRM_Core_Permission
::check('view all activities')) {
344 // @todo get this to work at the query level - see contact_id join above.
345 foreach ($activities as $activity) {
346 if (!CRM_Activity_BAO_Activity
::checkPermission($activity['id'], CRM_Core_Action
::VIEW
)) {
347 unset($activities[$activity['id']]);
351 if ($options['is_count']) {
352 return civicrm_api3_create_success($activities, $params, 'Activity', 'get');
355 $activities = _civicrm_api3_activity_get_formatResult($params, $activities, $options);
356 //legacy custom data get - so previous formatted response is still returned too
357 return civicrm_api3_create_success($activities, $params, 'Activity', 'get');
361 * Support filters beyond what basic_get can do.
363 * @param array $params
364 * @param CRM_Utils_SQL_Select $sql
365 * @throws \CiviCRM_API3_Exception
368 function _civicrm_api3_activity_get_extraFilters(&$params, &$sql) {
369 // Filter by activity contacts
370 $recordTypes = civicrm_api3('ActivityContact', 'getoptions', array('field' => 'record_type_id'));
371 $recordTypes = $recordTypes['values'];
372 $activityContactOptions = array(
373 'contact_id' => NULL,
374 'target_contact_id' => array_search('Activity Targets', $recordTypes),
375 'source_contact_id' => array_search('Activity Source', $recordTypes),
376 'assignee_contact_id' => array_search('Activity Assignees', $recordTypes),
378 foreach ($activityContactOptions as $activityContactName => $activityContactValue) {
379 if (!empty($params[$activityContactName])) {
380 if (!is_array($params[$activityContactName])) {
381 $params[$activityContactName] = array('=' => $params[$activityContactName]);
383 $clause = \CRM_Core_DAO
::createSQLFilter('contact_id', $params[$activityContactName]);
384 $typeClause = $activityContactValue ?
'record_type_id = #typeId AND ' : '';
385 $sql->where("a.id IN (SELECT activity_id FROM civicrm_activity_contact WHERE $typeClause !clause)",
386 array('#typeId' => $activityContactValue, '!clause' => $clause)
391 // Handle is_overdue filter
392 // Boolean calculated field - does not support operators
393 if (isset($params['is_overdue'])) {
394 $incomplete = implode(',', array_keys(CRM_Activity_BAO_Activity
::getStatusesByType(CRM_Activity_BAO_Activity
::INCOMPLETE
)));
395 if ($params['is_overdue']) {
396 $sql->where('a.activity_date_time < NOW()');
397 $sql->where("a.status_id IN ($incomplete)");
400 $sql->where("(a.activity_date_time >= NOW() OR a.status_id NOT IN ($incomplete))");
404 // Define how to handle filters on some related entities.
405 // Subqueries are nice in (a) avoiding duplicates and (b) when the result
406 // list is expected to be bite-sized. Joins are nice (a) with larger
407 // datasets and (b) checking for non-existent relations.
410 'subquery' => 'a.id IN (SELECT entity_id FROM civicrm_entity_tag WHERE entity_table = "civicrm_activity" AND !clause)',
411 'join' => '!joinType civicrm_entity_tag !alias ON (!alias.entity_table = "civicrm_activity" AND !alias.entity_id = a.id)',
412 'column' => 'tag_id',
415 'subquery' => 'a.id IN (SELECT entity_id FROM civicrm_entity_file WHERE entity_table = "civicrm_activity" AND !clause)',
416 'join' => '!joinType civicrm_entity_file !alias ON (!alias.entity_table = "civicrm_activity" AND !alias.entity_id = a.id)',
417 'column' => 'file_id',
420 'subquery' => 'a.id IN (SELECT activity_id FROM civicrm_case_activity WHERE !clause)',
421 'join' => '!joinType civicrm_case_activity !alias ON (!alias.activity_id = a.id)',
422 'column' => 'case_id',
425 foreach ($rels as $filter => $relSpec) {
426 if (!empty($params[$filter])) {
427 if (!is_array($params[$filter])) {
428 $params[$filter] = array('=' => $params[$filter]);
430 // $mode is one of ('LEFT JOIN', 'INNER JOIN', 'SUBQUERY')
431 $mode = isset($params[$filter]['IS NULL']) ?
'LEFT JOIN' : 'SUBQUERY';
432 if ($mode === 'SUBQUERY') {
433 $clause = \CRM_Core_DAO
::createSQLFilter($relSpec['column'], $params[$filter]);
435 $sql->where($relSpec['subquery'], array('!clause' => $clause));
439 $alias = 'actjoin_' . $filter;
440 $clause = \CRM_Core_DAO
::createSQLFilter($alias . "." . $relSpec['column'], $params[$filter]);
442 $sql->join($alias, $relSpec['join'], array('!alias' => $alias, 'joinType' => $mode));
443 $sql->where($clause);
451 * Given a list of activities, append any extra data requested about the activities.
453 * @note Called by civicrm-core and CiviHR
455 * @param array $params
456 * API request parameters.
457 * @param array $activities
460 * new activities list
462 function _civicrm_api3_activity_get_formatResult($params, $activities, $options) {
467 $returns = $options['return'];
468 foreach ($params as $n => $v) {
469 if (substr($n, 0, 7) == 'return.') {
470 $returnkey = substr($n, 7);
471 $returns[$returnkey] = $v;
475 $returns['source_contact_id'] = 1;
476 if (!empty($returns['target_contact_name'])) {
477 $returns['target_contact_id'] = 1;
479 if (!empty($returns['assignee_contact_name'])) {
480 $returns['assignee_contact_id'] = 1;
483 $tagGet = array('tag_id', 'entity_id');
484 foreach (array_keys($returns) as $key) {
485 if (strpos($key, 'tag_id.') === 0) {
487 $returns['tag_id'] = 1;
491 foreach ($returns as $n => $v) {
493 case 'assignee_contact_id':
494 foreach ($activities as $key => $activityArray) {
495 $cids = $activities[$key]['assignee_contact_id'] = CRM_Activity_BAO_ActivityAssignment
::retrieveAssigneeIdsByActivityId($activityArray['id']);
496 if ($cids && !empty($returns['assignee_contact_name'])) {
497 foreach ($cids as $cid) {
498 $activities[$key]['assignee_contact_name'][$cid] = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $cid, 'display_name');
504 case 'target_contact_id':
505 foreach ($activities as $key => $activityArray) {
506 $cids = $activities[$key]['target_contact_id'] = CRM_Activity_BAO_ActivityTarget
::retrieveTargetIdsByActivityId($activityArray['id']);
507 if ($cids && !empty($returns['target_contact_name'])) {
508 foreach ($cids as $cid) {
509 $activities[$key]['target_contact_name'][$cid] = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $cid, 'display_name');
515 case 'source_contact_id':
516 foreach ($activities as $key => $activityArray) {
517 $cid = $activities[$key]['source_contact_id'] = CRM_Activity_BAO_Activity
::getSourceContactID($activityArray['id']);
518 if ($cid && !empty($returns['source_contact_name'])) {
519 $activities[$key]['source_contact_name'] = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $cid, 'display_name');
525 $tags = civicrm_api3('EntityTag', 'get', array(
526 'entity_table' => 'civicrm_activity',
527 'entity_id' => array('IN' => array_keys($activities)),
529 'options' => array('limit' => 0),
531 foreach ($tags['values'] as $tag) {
532 $key = (int) $tag['entity_id'];
533 unset($tag['entity_id'], $tag['id']);
534 $activities[$key]['tag_id'][$tag['tag_id']] = $tag;
539 $dao = CRM_Core_DAO
::executeQuery("SELECT entity_id, file_id FROM civicrm_entity_file WHERE entity_table = 'civicrm_activity' AND entity_id IN (%1)",
540 array(1 => array(implode(',', array_keys($activities)), 'String', CRM_Core_DAO
::QUERY_FORMAT_NO_QUOTES
)));
541 while ($dao->fetch()) {
542 $activities[$dao->entity_id
]['file_id'][] = $dao->file_id
;
547 $dao = CRM_Core_DAO
::executeQuery("SELECT activity_id, case_id FROM civicrm_case_activity WHERE activity_id IN (%1)",
548 array(1 => array(implode(',', array_keys($activities)), 'String', CRM_Core_DAO
::QUERY_FORMAT_NO_QUOTES
)));
549 while ($dao->fetch()) {
550 $activities[$dao->activity_id
]['case_id'][] = $dao->case_id
;
555 foreach ($activities as $key => $activityArray) {
556 $activities[$key]['is_overdue'] = (int) CRM_Activity_BAO_Activity
::isOverdue($activityArray);
561 if (substr($n, 0, 6) == 'custom') {
562 $returnProperties[$n] = $v;
568 if (!empty($params['contact_id'])) {
569 $statusOptions = CRM_Activity_BAO_Activity
::buildOptions('status_id', 'get');
570 $typeOptions = CRM_Activity_BAO_Activity
::buildOptions('activity_type_id', 'validate');
571 foreach ($activities as $key => &$activityArray) {
572 if (!empty($activityArray['status_id'])) {
573 $activityArray['status'] = $statusOptions[$activityArray['status_id']];
575 if (!empty($activityArray['activity_type_id'])) {
576 $activityArray['activity_name'] = $typeOptions[$activityArray['activity_type_id']];
581 if (!empty($returnProperties) ||
!empty($params['contact_id'])) {
582 foreach ($activities as $activityId => $values) {
583 //@todo - should possibly load activity type id if not loaded (update with id)
584 _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));
592 * Delete a specified Activity.
594 * @param array $params
595 * Array holding 'id' of activity to be deleted.
597 * @throws API_Exception
602 function civicrm_api3_activity_delete($params) {
604 if (CRM_Activity_BAO_Activity
::deleteActivity($params)) {
605 return civicrm_api3_create_success(1, $params, 'Activity', 'delete');
608 throw new API_Exception('Could not delete Activity');
613 * Check for required params.
615 * @param array $params
616 * Associated array of fields.
618 * @throws API_Exception
623 function _civicrm_api3_activity_check_params(&$params) {
624 $activityIds = array(
625 'activity' => CRM_Utils_Array
::value('id', $params),
626 'parent' => CRM_Utils_Array
::value('parent_id', $params),
627 'original' => CRM_Utils_Array
::value('original_id', $params),
630 foreach ($activityIds as $id => $value) {
632 !CRM_Core_DAO
::getFieldValue('CRM_Activity_DAO_Activity', $value, 'id')
634 throw new API_Exception('Invalid ' . ucfirst($id) . ' Id');
637 // this should be handled by wrapper layer & probably the api would already manage it
638 //correctly by doing pseudoconstant validation
640 $activityTypes = CRM_Activity_BAO_Activity
::buildOptions('activity_type_id', 'validate');
641 $activityName = CRM_Utils_Array
::value('activity_name', $params);
642 $activityName = ucfirst($activityName);
643 $activityLabel = CRM_Utils_Array
::value('activity_label', $params);
644 if ($activityLabel) {
645 $activityTypes = CRM_Activity_BAO_Activity
::buildOptions('activity_type_id', 'create');
648 $activityTypeId = CRM_Utils_Array
::value('activity_type_id', $params);
650 if ($activityName ||
$activityLabel) {
651 $activityTypeIdInList = array_search(($activityName ?
$activityName : $activityLabel), $activityTypes);
653 if (!$activityTypeIdInList) {
654 $errorString = $activityName ?
"Invalid Activity Name : $activityName" : "Invalid Activity Type Label";
655 throw new Exception($errorString);
657 elseif ($activityTypeId && ($activityTypeId != $activityTypeIdInList)) {
658 throw new API_Exception('Mismatch in Activity');
660 $params['activity_type_id'] = $activityTypeIdInList;
662 elseif ($activityTypeId &&
663 !array_key_exists($activityTypeId, $activityTypes)
665 throw new API_Exception('Invalid Activity Type ID');
668 // check for activity duration minutes
669 // this should be validated @ the wrapper layer not here
671 if (isset($params['duration_minutes']) && !is_numeric($params['duration_minutes'])) {
672 throw new API_Exception('Invalid Activity Duration (in minutes)');
675 //if adding a new activity & date_time not set make it now
676 // this should be managed by the wrapper layer & setting ['api.default'] in speces
678 if (empty($params['id']) && empty($params['activity_date_time'])) {
679 $params['activity_date_time'] = CRM_Utils_Date
::processDate(date('Y-m-d H:i:s'));
686 * Get parameters for activity list.
688 * @see _civicrm_api3_generic_getlist_params
690 * @param array $request
693 function _civicrm_api3_activity_getlist_params(&$request) {
694 $fieldsToReturn = array(
695 'activity_date_time',
700 $request['params']['return'] = array_unique(array_merge($fieldsToReturn, $request['extra']));
701 $request['params']['options']['sort'] = 'activity_date_time DESC';
702 $request['params'] +
= array(
703 'is_current_revision' => 1,
709 * Get output for activity list.
711 * @see _civicrm_api3_generic_getlist_output
713 * @param array $result
714 * @param array $request
718 function _civicrm_api3_activity_getlist_output($result, $request) {
720 if (!empty($result['values'])) {
721 foreach ($result['values'] as $row) {
723 'id' => $row[$request['id_field']],
724 'label' => $row[$request['label_field']] ?
$row[$request['label_field']] : ts('(no subject)'),
725 'description' => array(
726 CRM_Core_Pseudoconstant
::getLabel('CRM_Activity_BAO_Activity', 'activity_type_id', $row['activity_type_id']),
729 if (!empty($row['activity_date_time'])) {
730 $data['description'][0] .= ': ' . CRM_Utils_Date
::customFormat($row['activity_date_time']);
732 if (!empty($row['source_contact_id'])) {
733 $data['description'][] = ts('By %1', array(
734 1 => CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $row['source_contact_id'], 'display_name'),
737 // Add repeating info
738 $repeat = CRM_Core_BAO_RecurringEntity
::getPositionAndCount($row['id'], 'civicrm_activity');
739 $data['extra']['is_recur'] = FALSE;
741 $data['suffix'] = ts('(%1 of %2)', array(1 => $repeat[0], 2 => $repeat[1]));
742 $data['extra']['is_recur'] = TRUE;