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 Case objects.
30 * Developed by woolman.org
32 * @package CiviCRM_APIv3
37 * Open a new case, add client and manager roles, and standard timeline.
39 * @param array $params
43 * 'case_type_id' => int OR
44 * 'case_type' => str (provide one or the other)
45 * 'contact_id' => int // case client
49 * 'medium_id' => int // see civicrm option values for possibilities
50 * 'creator_id' => int // case manager, default to the logged in user
51 * 'status_id' => int // defaults to 1 "ongoing"
53 * 'start_date' => str datestamp // defaults to: date('YmdHis')
54 * 'duration' => int // in minutes
55 * 'details' => str // html format
58 * @throws API_Exception
62 function civicrm_api3_case_create($params) {
64 if (!empty($params['id'])) {
65 return civicrm_api3_case_update($params);
68 civicrm_api3_verify_mandatory($params, NULL, array(
71 array('case_type', 'case_type_id'))
73 _civicrm_api3_case_format_params($params);
75 // If format_params didn't find what it was looking for, return error
76 if (empty($params['case_type_id'])) {
77 throw new API_Exception('Invalid case_type. No such case type exists.');
79 if (empty($params['case_type'])) {
80 throw new API_Exception('Invalid case_type_id. No such case type exists.');
83 // Fixme: can we safely pass raw params to the BAO?
85 'case_type_id' => $params['case_type_id'],
86 'creator_id' => $params['creator_id'],
87 'status_id' => $params['status_id'],
88 'start_date' => $params['start_date'],
89 'end_date' => CRM_Utils_Array
::value('end_date', $params),
90 'subject' => $params['subject'],
93 $caseBAO = CRM_Case_BAO_Case
::create($newParams);
96 throw new API_Exception('Case not created. Please check input params.');
99 foreach ((array) $params['contact_id'] as $cid) {
100 $contactParams = array('case_id' => $caseBAO->id
, 'contact_id' => $cid);
101 CRM_Case_BAO_CaseContact
::create($contactParams);
104 // Initialize XML processor with $params
105 $xmlProcessor = new CRM_Case_XMLProcessor_Process();
106 $xmlProcessorParams = array(
107 'clientID' => $params['contact_id'],
108 'creatorID' => $params['creator_id'],
109 'standardTimeline' => 1,
110 'activityTypeName' => 'Open Case',
111 'caseID' => $caseBAO->id
,
112 'subject' => $params['subject'],
113 'location' => CRM_Utils_Array
::value('location', $params),
114 'activity_date_time' => $params['start_date'],
115 'duration' => CRM_Utils_Array
::value('duration', $params),
116 'medium_id' => CRM_Utils_Array
::value('medium_id', $params),
117 'details' => CRM_Utils_Array
::value('details', $params),
122 $xmlProcessor->run($params['case_type'], $xmlProcessorParams);
126 _civicrm_api3_object_to_array($caseBAO, $values[$caseBAO->id
]);
128 return civicrm_api3_create_success($values, $params, 'Case', 'create', $caseBAO);
132 * Adjust Metadata for Get Action.
134 * @param array $params
135 * Parameters determined by getfields.
137 function _civicrm_api3_case_get_spec(&$params) {
138 $params['contact_id'] = array(
139 'api.aliases' => array('client_id'),
140 'title' => 'Case Client',
141 'description' => 'Contact id of one or more clients to retrieve cases for',
142 'type' => CRM_Utils_Type
::T_INT
,
144 $params['activity_id'] = array(
145 'title' => 'Case Activity',
146 'description' => 'Id of an activity in the case',
147 'type' => CRM_Utils_Type
::T_INT
,
149 $params['tag_id'] = array(
151 'description' => 'Find activities with specified tags.',
153 'FKClassName' => 'CRM_Core_DAO_Tag',
154 'FKApiName' => 'Tag',
155 'supports_joins' => TRUE,
160 * Adjust Metadata for Create Action.
162 * @param array $params
163 * Array of parameters determined by getfields.
165 function _civicrm_api3_case_create_spec(&$params) {
166 $params['contact_id'] = array(
167 'api.aliases' => array('client_id'),
168 'title' => 'Case Client',
169 'description' => 'Contact id of case client(s)',
171 'type' => CRM_Utils_Type
::T_INT
,
173 $params['status_id']['api.default'] = 1;
174 $params['status_id']['api.aliases'] = array('case_status');
175 $params['creator_id']['api.default'] = 'user_contact_id';
176 $params['creator_id']['type'] = CRM_Utils_Type
::T_INT
;
177 $params['creator_id']['title'] = 'Case Created By';
178 $params['start_date']['api.default'] = 'now';
179 $params['medium_id'] = array(
180 'name' => 'medium_id',
181 'title' => 'Activity Medium',
182 'type' => CRM_Utils_Type
::T_INT
,
187 * Adjust Metadata for Update action.
189 * @param array $params
190 * Array of parameters determined by getfields.
192 function _civicrm_api3_case_update_spec(&$params) {
193 $params['id']['api.required'] = 1;
197 * Adjust Metadata for Delete action.
199 * @param array $params
200 * Array of parameters determined by getfields.
202 function _civicrm_api3_case_delete_spec(&$params) {
203 $params['id']['api.required'] = 1;
207 * Get details of a particular case, or search for cases, depending on params.
209 * Please provide one (and only one) of the four get/search parameters:
211 * @param array $params
212 * 'id' => if set, will get all available info about a case, including contacts and activities
214 * // if no case_id provided, this function will use one of the following search parameters:
215 * 'client_id' => finds all cases with a specific client
216 * 'activity_id' => returns the case containing a specific activity
217 * 'contact_id' => finds all cases associated with a contact (in any role, not just client)
218 * $params CRM_Utils_SQL_Select $sql
219 * Other apis wishing to wrap & extend this one can pass in a $sql object with extra clauses
221 * @throws API_Exception
223 * (get mode, case_id provided): Array with case details, case roles, case activity ids, (search mode, case_id not provided): Array of cases found
225 function civicrm_api3_case_get($params, $sql = NULL) {
226 $options = _civicrm_api3_get_options_from_params($params);
227 if (!is_a($sql, 'CRM_Utils_SQL_Select')) {
228 $sql = CRM_Utils_SQL_Select
::fragment();
231 // Add clause to search by client
232 if (!empty($params['contact_id'])) {
233 // Legacy support - this field historically supports a nonstandard format of array(1,2,3) as a synonym for array('IN' => array(1,2,3))
234 if (is_array($params['contact_id'])) {
235 $operator = CRM_Utils_Array
::first(array_keys($params['contact_id']));
236 if (!in_array($operator, \CRM_Core_DAO
::acceptedSQLOperators(), TRUE)) {
237 $params['contact_id'] = array('IN' => $params['contact_id']);
241 $params['contact_id'] = array('=' => $params['contact_id']);
243 $clause = CRM_Core_DAO
::createSQLFilter('contact_id', $params['contact_id']);
244 $sql->where("a.id IN (SELECT case_id FROM civicrm_case_contact WHERE $clause)");
247 // Order by case contact (primary client)
248 // Ex: "contact_id", "contact_id.display_name", "contact_id.sort_name DESC".
249 if (!empty($options['sort']) && strpos($options['sort'], 'contact_id') !== FALSE) {
250 $sort = explode(', ', $options['sort']);
252 foreach ($sort as $index => &$sortString) {
253 if (strpos($sortString, 'contact_id') === 0) {
254 $contactSort = $sortString;
256 // Get sort field and direction
257 list($sortField, $dir) = array_pad(explode(' ', $contactSort), 2, 'ASC');
258 list(, $sortField) = array_pad(explode('.', $sortField), 2, 'id');
260 if (!array_key_exists($sortField, CRM_Contact_DAO_Contact
::fieldKeys()) ||
($dir != 'ASC' && $dir != 'DESC')) {
261 throw new API_Exception("Unknown field specified for sort. Cannot order by '$contactSort'");
263 $sql->orderBy("case_contact.$sortField $dir", NULL, $index);
266 // Remove contact sort params so the basic_get function doesn't see them
267 $params['options']['sort'] = implode(', ', $sort);
268 unset($params['option_sort'], $params['option.sort'], $params['sort']);
269 // Add necessary joins to the first case client
271 $sql->join('ccc', 'LEFT JOIN (SELECT * FROM civicrm_case_contact WHERE id IN (SELECT MIN(id) FROM civicrm_case_contact GROUP BY case_id)) AS ccc ON ccc.case_id = a.id');
272 $sql->join('case_contact', 'LEFT JOIN civicrm_contact AS case_contact ON ccc.contact_id = case_contact.id AND case_contact.is_deleted <> 1');
276 // Add clause to search by activity
277 if (!empty($params['activity_id'])) {
278 if (!CRM_Utils_Rule
::positiveInteger($params['activity_id'])) {
279 throw new API_Exception('Invalid parameter: activity_id. Must provide a numeric value.');
281 $activityId = $params['activity_id'];
282 $originalId = CRM_Core_DAO
::getFieldValue('CRM_Activity_BAO_Activity', $activityId, 'original_id');
284 $activityId .= ',' . $originalId;
287 ->join('civicrm_case_activity', 'INNER JOIN civicrm_case_activity ON civicrm_case_activity.case_id = a.id')
288 ->where("civicrm_case_activity.activity_id IN ($activityId)");
291 // Clause to search by tag
292 if (!empty($params['tag_id'])) {
293 $dummySpec = array();
294 _civicrm_api3_validate_integer($params, 'tag_id', $dummySpec, 'Case');
295 if (!is_array($params['tag_id'])) {
296 $params['tag_id'] = array('=' => $params['tag_id']);
298 $clause = \CRM_Core_DAO
::createSQLFilter('tag_id', $params['tag_id']);
300 $sql->where('a.id IN (SELECT entity_id FROM civicrm_entity_tag WHERE entity_table = "civicrm_case" AND !clause)', array('!clause' => $clause));
304 $cases = _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), array('sequential' => 0) +
$params, TRUE, 'Case', $sql);
306 if (empty($options['is_count']) && !empty($cases['values'])) {
307 // For historic reasons we return these by default only when fetching a case by id
308 if (!empty($params['id']) && is_numeric($params['id']) && empty($options['return'])) {
309 $options['return'] = array(
316 _civicrm_api3_case_read($cases['values'], $options);
318 // We disabled sequential to keep the list indexed for case_read(). Now add it back.
319 if (!empty($params['sequential'])) {
320 $cases['values'] = array_values($cases['values']);
330 * Use activity API instead.
332 * @param array $params
334 * @throws API_Exception
337 function civicrm_api3_case_activity_create($params) {
338 require_once "api/v3/Activity.php";
339 return civicrm_api3_activity_create($params) +
array(
340 'deprecated' => CRM_Utils_Array
::value('activity_create', _civicrm_api3_case_deprecation()),
345 * Add a timeline to a case.
347 * @param array $params
349 * @throws API_Exception
352 function civicrm_api3_case_addtimeline($params) {
353 $caseType = CRM_Case_BAO_Case
::getCaseType($params['case_id'], 'name');
354 $xmlProcessor = new CRM_Case_XMLProcessor_Process();
355 $xmlProcessorParams = array(
356 'clientID' => CRM_Case_BAO_Case
::getCaseClients($params['case_id']),
357 'creatorID' => $params['creator_id'],
358 'standardTimeline' => 0,
359 'activity_date_time' => $params['activity_date_time'],
360 'caseID' => $params['case_id'],
361 'caseType' => $caseType,
362 'activitySetName' => $params['timeline'],
364 $xmlProcessor->run($caseType, $xmlProcessorParams);
365 return civicrm_api3_create_success();
369 * Adjust Metadata for addtimeline action.
371 * @param array $params
372 * Array of parameters determined by getfields.
374 function _civicrm_api3_case_addtimeline_spec(&$params) {
375 $params['case_id'] = array(
376 'title' => 'Case ID',
377 'description' => 'Id of case to update',
378 'type' => CRM_Utils_Type
::T_INT
,
381 $params['timeline'] = array(
382 'title' => 'Timeline',
383 'description' => 'Name of activity set',
384 'type' => CRM_Utils_Type
::T_STRING
,
387 $params['activity_date_time'] = array(
388 'api.default' => 'now',
389 'title' => 'Activity date time',
390 'description' => 'Timeline start date',
391 'type' => CRM_Utils_Type
::T_DATE
,
393 $params['creator_id'] = array(
394 'api.default' => 'user_contact_id',
395 'title' => 'Activity creator',
396 'description' => 'Contact id of timeline creator',
397 'type' => CRM_Utils_Type
::T_INT
,
404 * @param array $params
406 * @throws API_Exception
409 function civicrm_api3_case_merge($params) {
410 $clients1 = CRM_Case_BAO_Case
::getCaseClients($params['case_id_1']);
411 $clients2 = CRM_Case_BAO_Case
::getCaseClients($params['case_id_2']);
412 CRM_Case_BAO_Case
::mergeCases($clients1[0], $params['case_id_1'], $clients2[0], $params['case_id_2']);
413 return civicrm_api3_create_success();
417 * Adjust Metadata for merge action.
419 * @param array $params
420 * Array of parameters determined by getfields.
422 function _civicrm_api3_case_merge_spec(&$params) {
423 $params['case_id_1'] = array(
424 'title' => 'Case ID 1',
425 'description' => 'Id of main case',
426 'type' => CRM_Utils_Type
::T_INT
,
429 $params['case_id_2'] = array(
430 'title' => 'Case ID 2',
431 'description' => 'Id of second case',
432 'type' => CRM_Utils_Type
::T_INT
,
438 * Declare deprecated api functions.
440 * @deprecated api notice
442 * Array of deprecated actions
444 function _civicrm_api3_case_deprecation() {
445 return array('activity_create' => 'Case api "activity_create" action is deprecated. Use the activity api instead.');
449 * Update a specified case.
451 * @param array $params
457 * 'start_date' => str datestamp
458 * 'contact_id' => int // case client
460 * @throws API_Exception
464 function civicrm_api3_case_update($params) {
465 if (!isset($params['case_id']) && isset($params['id'])) {
466 $params['case_id'] = $params['id'];
470 civicrm_api3_verify_mandatory($params, NULL, array('id'));
472 // return error if modifying creator id
473 if (array_key_exists('creator_id', $params)) {
474 throw new API_Exception(ts('You cannot update creator id'));
477 $mCaseId = $origContactIds = array();
479 // get original contact id and creator id of case
480 if (!empty($params['contact_id'])) {
481 $origContactIds = CRM_Case_BAO_Case
::retrieveContactIdsByCaseId($params['id']);
482 $origContactId = $origContactIds[1];
485 if (count($origContactIds) > 1) {
486 // check valid orig contact id
487 if (!empty($params['orig_contact_id']) && !in_array($params['orig_contact_id'], $origContactIds)) {
488 throw new API_Exception('Invalid case contact id (orig_contact_id)');
490 elseif (empty($params['orig_contact_id'])) {
491 throw new API_Exception('Case is linked with more than one contact id. Provide the required params orig_contact_id to be replaced');
493 $origContactId = $params['orig_contact_id'];
496 // check for same contact id for edit Client
497 if (!empty($params['contact_id']) && !in_array($params['contact_id'], $origContactIds)) {
498 $mCaseId = CRM_Case_BAO_Case
::mergeCases($params['contact_id'], $params['case_id'], $origContactId, NULL, TRUE);
501 if (!empty($mCaseId[0])) {
502 $params['id'] = $mCaseId[0];
505 $dao = new CRM_Case_BAO_Case();
506 $dao->id
= $params['id'];
508 $dao->copyValues($params);
512 _civicrm_api3_object_to_array($dao, $case);
514 return civicrm_api3_create_success(array($dao->id
=> $case), $params, 'Case', 'update', $dao);
518 * Delete a specified case.
520 * @param array $params
527 * 'move_to_trash' => bool (defaults to false)
530 * @throws API_Exception
533 function civicrm_api3_case_delete($params) {
535 civicrm_api3_verify_mandatory($params, NULL, array('id'));
537 if (CRM_Case_BAO_Case
::deleteCase($params['id'], CRM_Utils_Array
::value('move_to_trash', $params, FALSE))) {
538 return civicrm_api3_create_success($params, $params, 'Case', 'delete');
541 throw new API_Exception('Could not delete case.');
546 * Case.restore API specification
548 * @param array $spec description of fields supported by this API call
551 function _civicrm_api3_case_restore_spec(&$spec) {
552 $result = civicrm_api3('Case', 'getfields', array('api_action' => 'delete'));
553 $spec = array('id' => $result['values']['id']);
557 * Restore a specified case from the trash.
559 * @param array $params
560 * @throws API_Exception
563 function civicrm_api3_case_restore($params) {
564 if (CRM_Case_BAO_Case
::restoreCase($params['id'])) {
565 return civicrm_api3_create_success($params, $params, 'Case', 'restore');
568 throw new API_Exception('Could not restore case.');
573 * Augment case results with extra data.
575 * @param array $cases
576 * @param array $options
578 function _civicrm_api3_case_read(&$cases, $options) {
579 foreach ($cases as &$case) {
580 if (empty($options['return']) ||
!empty($options['return']['contact_id'])) {
581 // Legacy support for client_id - TODO: in apiv4 remove 'client_id'
582 $case['client_id'] = $case['contact_id'] = CRM_Case_BAO_Case
::retrieveContactIdsByCaseId($case['id']);
584 if (!empty($options['return']['contacts'])) {
586 $contacts = CRM_Case_BAO_Case
::getcontactNames($case['id']);
587 $relations = CRM_Case_BAO_Case
::getRelatedContacts($case['id']);
588 $case['contacts'] = array_unique(array_merge($contacts, $relations), SORT_REGULAR
);
590 if (!empty($options['return']['activities'])) {
591 // add case activities array - we'll populate them in bulk below
592 $case['activities'] = array();
594 // Properly render this joined field
595 if (!empty($options['return']['case_type_id.definition'])) {
596 if (!empty($case['case_type_id.definition'])) {
597 list($xml) = CRM_Utils_XML
::parseString($case['case_type_id.definition']);
600 $caseTypeId = !empty($case['case_type_id']) ?
$case['case_type_id'] : CRM_Core_DAO
::getFieldValue('CRM_Case_DAO_Case', $case['id'], 'case_type_id');
601 $caseTypeName = !empty($case['case_type_id.name']) ?
$case['case_type_id.name'] : CRM_Core_DAO
::getFieldValue('CRM_Case_DAO_CaseType', $caseTypeId, 'name');
602 $xml = CRM_Case_XMLRepository
::singleton()->retrieve($caseTypeName);
604 $case['case_type_id.definition'] = array();
606 $case['case_type_id.definition'] = CRM_Case_BAO_CaseType
::convertXmlToDefinition($xml);
610 // Bulk-load activities
611 if (!empty($options['return']['activities'])) {
612 $query = "SELECT case_id, activity_id FROM civicrm_case_activity WHERE case_id IN (%1)";
613 $params = array(1 => array(implode(',', array_keys($cases)), 'String', CRM_Core_DAO
::QUERY_FORMAT_NO_QUOTES
));
614 $dao = CRM_Core_DAO
::executeQuery($query, $params);
615 while ($dao->fetch()) {
616 $cases[$dao->case_id
]['activities'][] = $dao->activity_id
;
619 // Bulk-load tags. Supports joins onto the tag entity.
620 $tagGet = array('tag_id', 'entity_id');
621 foreach (array_keys($options['return']) as $key) {
622 if (strpos($key, 'tag_id.') === 0) {
624 $options['return']['tag_id'] = 1;
627 if (!empty($options['return']['tag_id'])) {
628 $tags = civicrm_api3('EntityTag', 'get', array(
629 'entity_table' => 'civicrm_case',
630 'entity_id' => array('IN' => array_keys($cases)),
632 'options' => array('limit' => 0),
634 foreach ($tags['values'] as $tag) {
635 $key = (int) $tag['entity_id'];
636 unset($tag['entity_id'], $tag['id']);
637 $cases[$key]['tag_id'][$tag['tag_id']] = $tag;
643 * Internal function to format create params for processing.
645 * @param array $params
647 function _civicrm_api3_case_format_params(&$params) {
648 // figure out case type id from case type and vice-versa
649 $caseTypes = CRM_Case_PseudoConstant
::caseType('name', FALSE);
650 if (empty($params['case_type_id'])) {
651 $params['case_type_id'] = array_search($params['case_type'], $caseTypes);
653 // DEPRECATED: lookup by label for backward compatibility
654 if (!$params['case_type_id']) {
655 $caseTypeLabels = CRM_Case_PseudoConstant
::caseType('title', FALSE);
656 $params['case_type_id'] = array_search($params['case_type'], $caseTypeLabels);
657 $params['case_type'] = $caseTypes[$params['case_type_id']];
660 elseif (empty($params['case_type'])) {
661 $params['case_type'] = $caseTypes[$params['case_type_id']];
666 * It actually works a lot better to use the CaseContact api instead of the Case api
667 * for entityRef fields so we can perform the necessary joins,
668 * so we pass off getlist requests to the CaseContact api.
670 * @param array $params
673 function civicrm_api3_case_getList($params) {
674 require_once 'api/v3/Generic/Getlist.php';
675 require_once 'api/v3/CaseContact.php';
676 //CRM:19956 - Assign case_id param if both id and case_id is passed to retrieve the case
677 if (!empty($params['id']) && !empty($params['params']) && !empty($params['params']['case_id'])) {
678 $params['params']['case_id'] = array('IN' => $params['id']);
679 unset($params['id']);
681 $params['id_field'] = 'case_id';
682 $params['label_field'] = $params['search_field'] = 'contact_id.sort_name';
683 $params['description_field'] = array(
685 'case_id.case_type_id.title',
688 'case_id.start_date',
692 'entity' => 'CaseContact',
693 'action' => 'getlist',
696 return civicrm_api3_generic_getList($apiRequest);
700 * Needed due to the above override
704 function _civicrm_api3_case_getlist_spec(&$params, $apiRequest) {
705 require_once 'api/v3/Generic/Getlist.php';
706 _civicrm_api3_generic_getlist_spec($params, $apiRequest);