3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
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 throw new API_Exception(ts("Unable to revision existing case activity."));
110 $createRevision = TRUE;
115 $deleteActivityAssignment = FALSE;
116 if (isset($params['assignee_contact_id'])) {
117 $deleteActivityAssignment = TRUE;
120 $deleteActivityTarget = FALSE;
121 if (isset($params['target_contact_id'])) {
122 $deleteActivityTarget = TRUE;
125 // this should all be handled at the BAO layer
126 $params['deleteActivityAssignment'] = CRM_Utils_Array
::value('deleteActivityAssignment', $params, $deleteActivityAssignment);
127 $params['deleteActivityTarget'] = CRM_Utils_Array
::value('deleteActivityTarget', $params, $deleteActivityTarget);
129 if ($case_id && $createRevision) {
130 // This is very similar to the copy-to-case action.
131 if (!CRM_Utils_Array
::crmIsEmptyArray($oldActivityValues['target_contact'])) {
132 $oldActivityValues['targetContactIds'] = implode(',', array_unique($oldActivityValues['target_contact']));
134 if (!CRM_Utils_Array
::crmIsEmptyArray($oldActivityValues['assignee_contact'])) {
135 $oldActivityValues['assigneeContactIds'] = implode(',', array_unique($oldActivityValues['assignee_contact']));
137 $oldActivityValues['mode'] = 'copy';
138 $oldActivityValues['caseID'] = $case_id;
139 $oldActivityValues['activityID'] = $oldActivityValues['id'];
140 $oldActivityValues['contactID'] = $oldActivityValues['source_contact_id'];
142 $copyToCase = CRM_Activity_Page_AJAX
::_convertToCaseActivity($oldActivityValues);
143 if (empty($copyToCase['error_msg'])) {
144 // now fix some things that are different from copy-to-case
145 // then fall through to the create below to update with the passed in params
146 $params['id'] = $copyToCase['newId'];
147 $params['is_auto'] = 0;
148 $params['original_id'] = empty($oldActivityValues['original_id']) ?
$oldActivityValues['id'] : $oldActivityValues['original_id'];
151 throw new API_Exception(ts("Unable to create new revision of case activity."));
156 $activityBAO = CRM_Activity_BAO_Activity
::create($params);
158 if (isset($activityBAO->id
)) {
159 if ($case_id && $isNew && !$createRevision) {
160 // If this is a brand new case activity, add to case(s)
161 foreach ((array) $case_id as $singleCaseId) {
162 $caseActivityParams = array('activity_id' => $activityBAO->id
, 'case_id' => $singleCaseId);
163 CRM_Case_BAO_Case
::processCaseActivity($caseActivityParams);
167 _civicrm_api3_object_to_array($activityBAO, $activityArray[$activityBAO->id
]);
168 return civicrm_api3_create_success($activityArray, $params, 'Activity', 'get', $activityBAO);
173 * Specify Meta data for create.
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.
178 * @param array $params
179 * Array of parameters determined by getfields.
181 function _civicrm_api3_activity_create_spec(&$params) {
183 $params['status_id']['api.aliases'] = array('activity_status');
185 $params['assignee_contact_id'] = array(
186 'name' => 'assignee_id',
187 'title' => 'Activity Assignee',
188 'description' => 'Contact(s) assigned to this activity.',
190 'FKClassName' => 'CRM_Contact_DAO_Contact',
191 'FKApiName' => 'Contact',
193 $params['target_contact_id'] = array(
194 'name' => 'target_id',
195 'title' => 'Activity Target',
196 'description' => 'Contact(s) participating in this activity.',
198 'FKClassName' => 'CRM_Contact_DAO_Contact',
199 'FKApiName' => 'Contact',
202 $params['source_contact_id'] = array(
203 'name' => 'source_contact_id',
204 'title' => 'Activity Source Contact',
205 'description' => 'Person who created this activity. Defaults to current user.',
207 'FKClassName' => 'CRM_Contact_DAO_Contact',
208 'api.default' => 'user_contact_id',
209 'FKApiName' => 'Contact',
210 'api.required' => TRUE,
213 $params['case_id'] = array(
215 'title' => 'Case ID',
216 'description' => 'For creating an activity as part of a case.',
218 'FKClassName' => 'CRM_Case_DAO_Case',
219 'FKApiName' => 'Case',
225 * Specify Metadata for get.
227 * @param array $params
229 function _civicrm_api3_activity_get_spec(&$params) {
230 $params['tag_id'] = array(
232 'description' => 'Find activities with specified tags.',
233 'type' => CRM_Utils_Type
::T_INT
,
234 'FKClassName' => 'CRM_Core_DAO_Tag',
235 'FKApiName' => 'Tag',
236 'supports_joins' => TRUE,
238 $params['file_id'] = array(
239 'title' => 'Attached Files',
240 'description' => 'Find activities with attached files.',
241 'type' => CRM_Utils_Type
::T_INT
,
242 'FKClassName' => 'CRM_Core_DAO_File',
243 'FKApiName' => 'File',
245 $params['case_id'] = array(
247 'description' => 'Find activities within specified cases.',
248 'type' => CRM_Utils_Type
::T_INT
,
249 'FKClassName' => 'CRM_Case_DAO_Case',
250 'FKApiName' => 'Case',
251 'supports_joins' => TRUE,
253 $params['contact_id'] = array(
254 'title' => 'Activity Contact ID',
255 'description' => 'Find activities involving this contact (as target, source, OR assignee).',
256 'type' => CRM_Utils_Type
::T_INT
,
257 'FKClassName' => 'CRM_Contact_DAO_Contact',
258 'FKApiName' => 'Contact',
260 $params['target_contact_id'] = array(
261 'title' => 'Target Contact ID',
262 'description' => 'Find activities with specified target contact.',
263 'type' => CRM_Utils_Type
::T_INT
,
264 'FKClassName' => 'CRM_Contact_DAO_Contact',
265 'FKApiName' => 'Contact',
267 $params['source_contact_id'] = array(
268 'title' => 'Source Contact ID',
269 'description' => 'Find activities with specified source contact.',
270 'type' => CRM_Utils_Type
::T_INT
,
271 'FKClassName' => 'CRM_Contact_DAO_Contact',
272 'FKApiName' => 'Contact',
274 $params['assignee_contact_id'] = array(
275 'title' => 'Assignee Contact ID',
276 'description' => 'Find activities with specified assignee contact.',
277 'type' => CRM_Utils_Type
::T_INT
,
278 'FKClassName' => 'CRM_Contact_DAO_Contact',
279 'FKApiName' => 'Contact',
281 $params['is_overdue'] = array(
282 'title' => 'Is Activity Overdue',
283 'description' => 'Incomplete activities with a past date.',
284 'type' => CRM_Utils_Type
::T_BOOLEAN
,
289 * Gets a CiviCRM activity according to parameters.
291 * @param array $params
292 * Array per getfields documentation.
294 * @return array API result array
297 * @throws \API_Exception
298 * @throws \CiviCRM_API3_Exception
299 * @throws \Civi\API\Exception\UnauthorizedException
301 function civicrm_api3_activity_get($params) {
302 $options = _civicrm_api3_get_options_from_params($params, FALSE, 'Activity', 'get');
303 $sql = CRM_Utils_SQL_Select
::fragment();
305 _civicrm_api3_activity_get_extraFilters($params, $sql);
307 // Handle is_overdue sort
308 if (!empty($options['sort'])) {
309 $sort = explode(', ', $options['sort']);
311 foreach ($sort as $index => &$sortString) {
312 // Get sort field and direction
313 list($sortField, $dir) = array_pad(explode(' ', $sortString), 2, 'ASC');
314 if ($sortField == 'is_overdue') {
315 $incomplete = implode(',', array_keys(CRM_Activity_BAO_Activity
::getStatusesByType(CRM_Activity_BAO_Activity
::INCOMPLETE
)));
316 $sql->orderBy("IF((a.activity_date_time >= NOW() OR a.status_id NOT IN ($incomplete)), 0, 1) $dir", NULL, $index);
317 // Replace the sort with a placeholder which will be ignored by sql
321 $params['options']['sort'] = implode(', ', $sort);
324 // Ensure there's enough data for calculating is_overdue
325 if (!empty($options['return']['is_overdue']) && (empty($options['return']['status_id']) ||
empty($options['return']['activity_date_time']))) {
326 $options['return']['status_id'] = $options['return']['activity_date_time'] = 1;
327 $params['return'] = array_keys($options['return']);
330 $activities = _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params, FALSE, 'Activity', $sql);
331 if ($options['is_count']) {
332 return civicrm_api3_create_success($activities, $params, 'Activity', 'get');
335 $activities = _civicrm_api3_activity_get_formatResult($params, $activities, $options);
336 //legacy custom data get - so previous formatted response is still returned too
337 return civicrm_api3_create_success($activities, $params, 'Activity', 'get');
341 * Support filters beyond what basic_get can do.
343 * @param array $params
344 * @param CRM_Utils_SQL_Select $sql
345 * @throws \CiviCRM_API3_Exception
348 function _civicrm_api3_activity_get_extraFilters(&$params, &$sql) {
349 // Filter by activity contacts
350 $activityContactOptions = array(
351 'contact_id' => NULL,
352 'target_contact_id' => CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_ActivityContact', 'record_type_id', 'Activity Targets'),
353 'source_contact_id' => CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_ActivityContact', 'record_type_id', 'Activity Source'),
354 'assignee_contact_id' => CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_ActivityContact', 'record_type_id', 'Activity Assignees'),
356 foreach ($activityContactOptions as $activityContactName => $activityContactValue) {
357 if (!empty($params[$activityContactName])) {
358 if (!is_array($params[$activityContactName])) {
359 $params[$activityContactName] = array('=' => $params[$activityContactName]);
361 $clause = \CRM_Core_DAO
::createSQLFilter('contact_id', $params[$activityContactName]);
362 $typeClause = $activityContactValue ?
'record_type_id = #typeId AND ' : '';
363 $sql->where("a.id IN (SELECT activity_id FROM civicrm_activity_contact WHERE $typeClause !clause)",
364 array('#typeId' => $activityContactValue, '!clause' => $clause)
369 // Handle is_overdue filter
370 // Boolean calculated field - does not support operators
371 if (isset($params['is_overdue'])) {
372 $incomplete = implode(',', array_keys(CRM_Activity_BAO_Activity
::getStatusesByType(CRM_Activity_BAO_Activity
::INCOMPLETE
)));
373 if ($params['is_overdue']) {
374 $sql->where('a.activity_date_time < NOW()');
375 $sql->where("a.status_id IN ($incomplete)");
378 $sql->where("(a.activity_date_time >= NOW() OR a.status_id NOT IN ($incomplete))");
382 // Define how to handle filters on some related entities.
383 // Subqueries are nice in (a) avoiding duplicates and (b) when the result
384 // list is expected to be bite-sized. Joins are nice (a) with larger
385 // datasets and (b) checking for non-existent relations.
388 'subquery' => 'a.id IN (SELECT entity_id FROM civicrm_entity_tag WHERE entity_table = "civicrm_activity" AND !clause)',
389 'join' => '!joinType civicrm_entity_tag !alias ON (!alias.entity_table = "civicrm_activity" AND !alias.entity_id = a.id)',
390 'column' => 'tag_id',
393 'subquery' => 'a.id IN (SELECT entity_id FROM civicrm_entity_file WHERE entity_table = "civicrm_activity" AND !clause)',
394 'join' => '!joinType civicrm_entity_file !alias ON (!alias.entity_table = "civicrm_activity" AND !alias.entity_id = a.id)',
395 'column' => 'file_id',
398 'subquery' => 'a.id IN (SELECT activity_id FROM civicrm_case_activity WHERE !clause)',
399 'join' => '!joinType civicrm_case_activity !alias ON (!alias.activity_id = a.id)',
400 'column' => 'case_id',
403 foreach ($rels as $filter => $relSpec) {
404 if (!empty($params[$filter])) {
405 if (!is_array($params[$filter])) {
406 $params[$filter] = array('=' => $params[$filter]);
408 // $mode is one of ('LEFT JOIN', 'INNER JOIN', 'SUBQUERY')
409 $mode = isset($params[$filter]['IS NULL']) ?
'LEFT JOIN' : 'SUBQUERY';
410 if ($mode === 'SUBQUERY') {
411 $clause = \CRM_Core_DAO
::createSQLFilter($relSpec['column'], $params[$filter]);
413 $sql->where($relSpec['subquery'], array('!clause' => $clause));
417 $alias = 'actjoin_' . $filter;
418 $clause = \CRM_Core_DAO
::createSQLFilter($alias . "." . $relSpec['column'], $params[$filter]);
420 $sql->join($alias, $relSpec['join'], array('!alias' => $alias, 'joinType' => $mode));
421 $sql->where($clause);
429 * Given a list of activities, append any extra data requested about the activities.
431 * @note Called by civicrm-core and CiviHR
433 * @param array $params
434 * API request parameters.
435 * @param array $activities
436 * @param array $options
437 * Options array (pre-processed to extract 'return' from params).
440 * new activities list
442 function _civicrm_api3_activity_get_formatResult($params, $activities, $options) {
447 $returns = $options['return'];
448 foreach ($params as $n => $v) {
449 // @todo - the per-parsing on options should have already done this.
450 if (substr($n, 0, 7) == 'return.') {
451 $returnkey = substr($n, 7);
452 $returns[$returnkey] = $v;
456 _civicrm_api3_activity_fill_activity_contact_names($activities, $params, $returns);
458 $tagGet = array('tag_id', 'entity_id');
459 $caseGet = $caseIds = array();
460 foreach (array_keys($returns) as $key) {
461 if (strpos($key, 'tag_id.') === 0) {
463 $returns['tag_id'] = 1;
465 if (strpos($key, 'case_id.') === 0) {
466 $caseGet[] = str_replace('case_id.', '', $key);
467 $returns['case_id'] = 1;
471 foreach ($returns as $n => $v) {
473 case 'assignee_contact_id':
474 case 'target_contact_id':
475 foreach ($activities as &$activity) {
476 if (!isset($activity[$n])) {
481 case 'source_contact_id':
485 $tags = civicrm_api3('EntityTag', 'get', array(
486 'entity_table' => 'civicrm_activity',
487 'entity_id' => array('IN' => array_keys($activities)),
489 'options' => array('limit' => 0),
491 foreach ($tags['values'] as $tag) {
492 $key = (int) $tag['entity_id'];
493 unset($tag['entity_id'], $tag['id']);
494 $activities[$key]['tag_id'][$tag['tag_id']] = $tag;
499 $dao = CRM_Core_DAO
::executeQuery("SELECT entity_id, file_id FROM civicrm_entity_file WHERE entity_table = 'civicrm_activity' AND entity_id IN (%1)",
500 array(1 => array(implode(',', array_keys($activities)), 'String', CRM_Core_DAO
::QUERY_FORMAT_NO_QUOTES
)));
501 while ($dao->fetch()) {
502 $activities[$dao->entity_id
]['file_id'][] = $dao->file_id
;
507 $dao = CRM_Core_DAO
::executeQuery("SELECT activity_id, case_id FROM civicrm_case_activity WHERE activity_id IN (%1)",
508 array(1 => array(implode(',', array_keys($activities)), 'String', CRM_Core_DAO
::QUERY_FORMAT_NO_QUOTES
)));
509 while ($dao->fetch()) {
510 $activities[$dao->activity_id
]['case_id'][] = $dao->case_id
;
511 $caseIds[$dao->case_id
] = $dao->case_id
;
516 foreach ($activities as $key => $activityArray) {
517 $activities[$key]['is_overdue'] = (int) CRM_Activity_BAO_Activity
::isOverdue($activityArray);
522 if (substr($n, 0, 6) == 'custom') {
523 $returnProperties[$n] = $v;
528 // Fetch case fields via the join syntax
529 // Note this is limited to the first case if the activity belongs to more than one
530 if ($caseGet && $caseIds) {
531 $cases = civicrm_api3('Case', 'get', array(
532 'id' => array('IN' => $caseIds),
533 'options' => array('limit' => 0),
534 'check_permissions' => !empty($params['check_permissions']),
535 'return' => $caseGet,
537 foreach ($activities as &$activity) {
538 if (!empty($activity['case_id'])) {
539 $case = CRM_Utils_Array
::value($activity['case_id'][0], $cases['values']);
541 foreach ($case as $key => $value) {
543 $activity['case_id.' . $key] = $value;
552 if (!empty($params['contact_id'])) {
553 $statusOptions = CRM_Activity_BAO_Activity
::buildOptions('status_id', 'get');
554 $typeOptions = CRM_Activity_BAO_Activity
::buildOptions('activity_type_id', 'validate');
555 foreach ($activities as $key => &$activityArray) {
556 if (!empty($activityArray['status_id'])) {
557 $activityArray['status'] = $statusOptions[$activityArray['status_id']];
559 if (!empty($activityArray['activity_type_id'])) {
560 $activityArray['activity_name'] = $typeOptions[$activityArray['activity_type_id']];
565 if (!empty($returnProperties) ||
!empty($params['contact_id'])) {
566 foreach ($activities as $activityId => $values) {
567 //@todo - should possibly load activity type id if not loaded (update with id)
568 _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));
575 * Append activity contact details to activity results.
577 * Adds id & name of activity contacts to results array if check_permissions
578 * does not block access to them.
580 * For historical reasons source_contact_id is always added & is not an array.
581 * The others are added depending on requested return params.
583 * @param array $activities
584 * @param array $params
585 * @param array $returns
587 function _civicrm_api3_activity_fill_activity_contact_names(&$activities, $params, $returns) {
588 $contactTypes = array_flip(CRM_Activity_BAO_ActivityContact
::buildOptions('record_type_id', 'validate'));
589 $assigneeType = $contactTypes['Activity Assignees'];
590 $targetType = $contactTypes['Activity Targets'];
591 $sourceType = $contactTypes['Activity Source'];
593 $assigneeType => 'assignee',
594 $sourceType => 'source',
595 $targetType => 'target'
598 $activityContactTypes = [$sourceType];
600 if (!empty($returns['target_contact_name']) ||
!empty($returns['target_contact_id'])) {
601 $activityContactTypes[] = $targetType;
603 if (!empty($returns['assignee_contact_name']) ||
(!empty($returns['assignee_contact_id']))) {
604 $activityContactTypes[] = $assigneeType;
606 $activityContactParams = [
607 'activity_id' => ['IN' => array_keys($activities)],
611 'contact_id.display_name',
614 'check_permissions' => !empty($params['check_permissions']),
616 if (count($activityContactTypes) < 3) {
617 $activityContactParams['record_type_id'] = ['IN' => $activityContactTypes];
619 $activityContacts = civicrm_api3('ActivityContact', 'get', $activityContactParams)['values'];
620 foreach ($activityContacts as $activityContact) {
621 $contactID = $activityContact['contact_id'];
622 $recordType = $typeMap[$activityContact['record_type_id']];
623 if (in_array($recordType, ['target', 'assignee'])) {
624 $activities[$activityContact['activity_id']][$recordType . '_contact_id'][] = $contactID;
625 $activities[$activityContact['activity_id']][$recordType . '_contact_name'][$contactID] = isset($activityContact['contact_id.display_name']) ?
$activityContact['contact_id.display_name'] : '';
628 $activities[$activityContact['activity_id']]['source_contact_id'] = $contactID;
629 $activities[$activityContact['activity_id']]['source_contact_name'] = isset($activityContact['contact_id.display_name']) ?
$activityContact['contact_id.display_name'] : '';
636 * Delete a specified Activity.
638 * @param array $params
639 * Array holding 'id' of activity to be deleted.
641 * @throws API_Exception
646 function civicrm_api3_activity_delete($params) {
648 if (CRM_Activity_BAO_Activity
::deleteActivity($params)) {
649 return civicrm_api3_create_success(1, $params, 'Activity', 'delete');
652 throw new API_Exception('Could not delete Activity: ' . (int) $params['id']);
657 * Check for required params.
659 * @param array $params
660 * Associated array of fields.
662 * @throws API_Exception
667 function _civicrm_api3_activity_check_params(&$params) {
668 $activityIds = array(
669 'activity' => CRM_Utils_Array
::value('id', $params),
670 'parent' => CRM_Utils_Array
::value('parent_id', $params),
671 'original' => CRM_Utils_Array
::value('original_id', $params),
674 foreach ($activityIds as $id => $value) {
676 !CRM_Core_DAO
::getFieldValue('CRM_Activity_DAO_Activity', $value, 'id')
678 throw new API_Exception('Invalid ' . ucfirst($id) . ' Id');
681 // this should be handled by wrapper layer & probably the api would already manage it
682 //correctly by doing pseudoconstant validation
684 $activityTypes = CRM_Activity_BAO_Activity
::buildOptions('activity_type_id', 'validate');
685 $activityName = CRM_Utils_Array
::value('activity_name', $params);
686 $activityName = ucfirst($activityName);
687 $activityLabel = CRM_Utils_Array
::value('activity_label', $params);
688 if ($activityLabel) {
689 $activityTypes = CRM_Activity_BAO_Activity
::buildOptions('activity_type_id', 'create');
692 $activityTypeId = CRM_Utils_Array
::value('activity_type_id', $params);
694 if ($activityName ||
$activityLabel) {
695 $activityTypeIdInList = array_search(($activityName ?
$activityName : $activityLabel), $activityTypes);
697 if (!$activityTypeIdInList) {
698 $errorString = $activityName ?
"Invalid Activity Name : $activityName" : "Invalid Activity Type Label";
699 throw new Exception($errorString);
701 elseif ($activityTypeId && ($activityTypeId != $activityTypeIdInList)) {
702 throw new API_Exception('Mismatch in Activity');
704 $params['activity_type_id'] = $activityTypeIdInList;
706 elseif ($activityTypeId &&
707 !array_key_exists($activityTypeId, $activityTypes)
709 throw new API_Exception('Invalid Activity Type ID');
712 // check for activity duration minutes
713 // this should be validated @ the wrapper layer not here
715 if (isset($params['duration_minutes']) && !is_numeric($params['duration_minutes'])) {
716 throw new API_Exception('Invalid Activity Duration (in minutes)');
719 //if adding a new activity & date_time not set make it now
720 // this should be managed by the wrapper layer & setting ['api.default'] in speces
722 if (empty($params['id']) && empty($params['activity_date_time'])) {
723 $params['activity_date_time'] = CRM_Utils_Date
::processDate(date('Y-m-d H:i:s'));
730 * Get parameters for activity list.
732 * @see _civicrm_api3_generic_getlist_params
734 * @param array $request
737 function _civicrm_api3_activity_getlist_params(&$request) {
738 $fieldsToReturn = array(
739 'activity_date_time',
744 $request['params']['return'] = array_unique(array_merge($fieldsToReturn, $request['extra']));
745 $request['params']['options']['sort'] = 'activity_date_time DESC';
746 $request['params'] +
= array(
747 'is_current_revision' => 1,
753 * Get output for activity list.
755 * @see _civicrm_api3_generic_getlist_output
757 * @param array $result
758 * @param array $request
762 function _civicrm_api3_activity_getlist_output($result, $request) {
764 if (!empty($result['values'])) {
765 foreach ($result['values'] as $row) {
767 'id' => $row[$request['id_field']],
768 'label' => $row[$request['label_field']] ?
$row[$request['label_field']] : ts('(no subject)'),
769 'description' => array(
770 CRM_Core_Pseudoconstant
::getLabel('CRM_Activity_BAO_Activity', 'activity_type_id', $row['activity_type_id']),
773 if (!empty($row['activity_date_time'])) {
774 $data['description'][0] .= ': ' . CRM_Utils_Date
::customFormat($row['activity_date_time']);
776 if (!empty($row['source_contact_id'])) {
777 $data['description'][] = ts('By %1', array(
778 1 => CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $row['source_contact_id'], 'display_name'),
781 // Add repeating info
782 $repeat = CRM_Core_BAO_RecurringEntity
::getPositionAndCount($row['id'], 'civicrm_activity');
783 $data['extra']['is_recur'] = FALSE;
785 $data['suffix'] = ts('(%1 of %2)', array(1 => $repeat[0], 2 => $repeat[1]));
786 $data['extra']['is_recur'] = TRUE;