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
,
152 * Adjust Metadata for Create Action.
154 * @param array $params
155 * Array of parameters determined by getfields.
157 function _civicrm_api3_case_create_spec(&$params) {
158 $params['contact_id'] = array(
159 'api.aliases' => array('client_id'),
160 'title' => 'Case Client',
161 'description' => 'Contact id of case client(s)',
163 'type' => CRM_Utils_Type
::T_INT
,
165 $params['status_id']['api.default'] = 1;
166 $params['status_id']['api.aliases'] = array('case_status');
167 $params['creator_id']['api.default'] = 'user_contact_id';
168 $params['creator_id']['type'] = CRM_Utils_Type
::T_INT
;
169 $params['creator_id']['title'] = 'Case Created By';
170 $params['start_date']['api.default'] = 'now';
171 $params['medium_id'] = array(
172 'name' => 'medium_id',
173 'title' => 'Activity Medium',
174 'type' => CRM_Utils_Type
::T_INT
,
179 * Adjust Metadata for Update action.
181 * @param array $params
182 * Array of parameters determined by getfields.
184 function _civicrm_api3_case_update_spec(&$params) {
185 $params['id']['api.required'] = 1;
189 * Adjust Metadata for Delete action.
191 * @param array $params
192 * Array of parameters determined by getfields.
194 function _civicrm_api3_case_delete_spec(&$params) {
195 $params['id']['api.required'] = 1;
199 * Get details of a particular case, or search for cases, depending on params.
201 * Please provide one (and only one) of the four get/search parameters:
203 * @param array $params
204 * 'id' => if set, will get all available info about a case, including contacts and activities
206 * // if no case_id provided, this function will use one of the following search parameters:
207 * 'client_id' => finds all cases with a specific client
208 * 'activity_id' => returns the case containing a specific activity
209 * 'contact_id' => finds all cases associated with a contact (in any role, not just client)
211 * @throws API_Exception
213 * (get mode, case_id provided): Array with case details, case roles, case activity ids, (search mode, case_id not provided): Array of cases found
215 function civicrm_api3_case_get($params) {
216 $options = _civicrm_api3_get_options_from_params($params);
217 $sql = CRM_Utils_SQL_Select
::fragment();
219 // Add clause to search by client
220 if (!empty($params['contact_id'])) {
221 // Legacy support - this field historically supports a nonstandard format of array(1,2,3) as a synonym for array('IN' => array(1,2,3))
222 if (is_array($params['contact_id'])) {
223 $operator = CRM_Utils_Array
::first(array_keys($params['contact_id']));
224 if (!in_array($operator, \CRM_Core_DAO
::acceptedSQLOperators(), TRUE)) {
225 $params['contact_id'] = array('IN' => $params['contact_id']);
229 $params['contact_id'] = array('=' => $params['contact_id']);
231 $clause = CRM_Core_DAO
::createSQLFilter('contact_id', $params['contact_id']);
232 $sql->where("a.id IN (SELECT case_id FROM civicrm_case_contact WHERE $clause)");
235 // Add clause to search by activity
236 if (!empty($params['activity_id'])) {
237 if (!CRM_Utils_Rule
::positiveInteger($params['activity_id'])) {
238 throw new API_Exception('Invalid parameter: activity_id. Must provide a numeric value.');
240 $activityId = $params['activity_id'];
241 $originalId = CRM_Core_DAO
::getFieldValue('CRM_Activity_BAO_Activity', $activityId, 'original_id');
243 $activityId .= ',' . $originalId;
246 ->join('civicrm_case_activity', 'INNER JOIN civicrm_case_activity ON civicrm_case_activity.case_id = a.id')
247 ->where("civicrm_case_activity.activity_id IN ($activityId)");
250 $foundcases = _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params, TRUE, 'Case', $sql);
252 if (empty($options['is_count'])) {
253 // For historic reasons we return these by default only when fetching a case by id
254 if (!empty($params['id']) && empty($options['return'])) {
255 $options['return'] = array(
262 foreach ($foundcases['values'] as &$case) {
263 _civicrm_api3_case_read($case, $options);
273 * Use activity API instead.
275 * @param array $params
277 * @throws API_Exception
280 function civicrm_api3_case_activity_create($params) {
281 require_once "api/v3/Activity.php";
282 return civicrm_api3_activity_create($params) +
array(
283 'deprecated' => CRM_Utils_Array
::value('activity_create', _civicrm_api3_case_deprecation()),
288 * Declare deprecated api functions.
290 * @deprecated api notice
292 * Array of deprecated actions
294 function _civicrm_api3_case_deprecation() {
295 return array('activity_create' => 'Case api "activity_create" action is deprecated. Use the activity api instead.');
299 * Update a specified case.
301 * @param array $params
307 * 'start_date' => str datestamp
308 * 'contact_id' => int // case client
310 * @throws API_Exception
314 function civicrm_api3_case_update($params) {
315 if (!isset($params['case_id']) && isset($params['id'])) {
316 $params['case_id'] = $params['id'];
320 civicrm_api3_verify_mandatory($params, NULL, array('id'));
322 // return error if modifying creator id
323 if (array_key_exists('creator_id', $params)) {
324 throw new API_Exception(ts('You cannot update creator id'));
327 $mCaseId = $origContactIds = array();
329 // get original contact id and creator id of case
330 if (!empty($params['contact_id'])) {
331 $origContactIds = CRM_Case_BAO_Case
::retrieveContactIdsByCaseId($params['id']);
332 $origContactId = $origContactIds[1];
335 if (count($origContactIds) > 1) {
336 // check valid orig contact id
337 if (!empty($params['orig_contact_id']) && !in_array($params['orig_contact_id'], $origContactIds)) {
338 throw new API_Exception('Invalid case contact id (orig_contact_id)');
340 elseif (empty($params['orig_contact_id'])) {
341 throw new API_Exception('Case is linked with more than one contact id. Provide the required params orig_contact_id to be replaced');
343 $origContactId = $params['orig_contact_id'];
346 // check for same contact id for edit Client
347 if (!empty($params['contact_id']) && !in_array($params['contact_id'], $origContactIds)) {
348 $mCaseId = CRM_Case_BAO_Case
::mergeCases($params['contact_id'], $params['case_id'], $origContactId, NULL, TRUE);
351 if (!empty($mCaseId[0])) {
352 $params['id'] = $mCaseId[0];
355 $dao = new CRM_Case_BAO_Case();
356 $dao->id
= $params['id'];
358 $dao->copyValues($params);
362 _civicrm_api3_object_to_array($dao, $case);
364 return civicrm_api3_create_success(array($dao->id
=> $case), $params, 'Case', 'update', $dao);
368 * Delete a specified case.
370 * @param array $params
377 * 'move_to_trash' => bool (defaults to false)
380 * @throws API_Exception
382 * true if success, else false
384 function civicrm_api3_case_delete($params) {
386 civicrm_api3_verify_mandatory($params, NULL, array('id'));
388 if (CRM_Case_BAO_Case
::deleteCase($params['id'], CRM_Utils_Array
::value('move_to_trash', $params, FALSE))) {
389 return civicrm_api3_create_success($params, $params, 'Case', 'delete');
392 throw new API_Exception('Could not delete case.');
397 * Augment a case with extra data.
400 * @param array $options
402 function _civicrm_api3_case_read(&$case, $options) {
403 if (empty($options['return']) ||
!empty($options['return']['contact_id'])) {
404 // Legacy support for client_id - TODO: in apiv4 remove 'client_id'
405 $case['client_id'] = $case['contact_id'] = CRM_Case_BAO_Case
::retrieveContactIdsByCaseId($case['id']);
407 if (!empty($options['return']['contacts'])) {
409 $contacts = CRM_Case_BAO_Case
::getcontactNames($case['id']);
410 $relations = CRM_Case_BAO_Case
::getRelatedContacts($case['id']);
411 $case['contacts'] = array_merge($contacts, $relations);
413 if (!empty($options['return']['activities'])) {
414 //get case activities
415 $case['activities'] = array();
416 $query = "SELECT activity_id FROM civicrm_case_activity WHERE case_id = %1";
417 $dao = CRM_Core_DAO
::executeQuery($query, array(1 => array($case['id'], 'Integer')));
418 while ($dao->fetch()) {
419 $case['activities'][] = $dao->activity_id
;
422 // Properly render this joined field
423 if (!empty($options['return']['case_type_id.definition'])) {
424 if (!empty($case['case_type_id.definition'])) {
425 list($xml) = CRM_Utils_XML
::parseString($case['case_type_id.definition']);
428 $caseTypeId = !empty($case['case_type_id']) ?
$case['case_type_id'] : CRM_Core_DAO
::getFieldValue('CRM_Case_DAO_Case', $case['id'], 'case_type_id');
429 $caseTypeName = !empty($case['case_type_id.name']) ?
$case['case_type_id.name'] : CRM_Core_DAO
::getFieldValue('CRM_Case_DAO_CaseType', $caseTypeId, 'name');
430 $xml = CRM_Case_XMLRepository
::singleton()->retrieve($caseTypeName);
432 $case['case_type_id.definition'] = array();
434 $case['case_type_id.definition'] = CRM_Case_BAO_CaseType
::convertXmlToDefinition($xml);
440 * Internal function to format create params for processing.
442 * @param array $params
444 function _civicrm_api3_case_format_params(&$params) {
445 // figure out case type id from case type and vice-versa
446 $caseTypes = CRM_Case_PseudoConstant
::caseType('name', FALSE);
447 if (empty($params['case_type_id'])) {
448 $params['case_type_id'] = array_search($params['case_type'], $caseTypes);
450 // DEPRECATED: lookup by label for backward compatibility
451 if (!$params['case_type_id']) {
452 $caseTypeLabels = CRM_Case_PseudoConstant
::caseType('title', FALSE);
453 $params['case_type_id'] = array_search($params['case_type'], $caseTypeLabels);
454 $params['case_type'] = $caseTypes[$params['case_type_id']];
457 elseif (empty($params['case_type'])) {
458 $params['case_type'] = $caseTypes[$params['case_type_id']];
463 * It actually works a lot better to use the CaseContact api instead of the Case api
464 * for entityRef fields so we can perform the necessary joins,
465 * so we pass off getlist requests to the CaseContact api.
467 * @param array $params
470 function civicrm_api3_case_getList($params) {
471 require_once 'api/v3/Generic/Getlist.php';
472 require_once 'api/v3/CaseContact.php';
473 //CRM:19956 - Assign case_id param if both id and case_id is passed to retrieve the case
474 if (!empty($params['id']) && !empty($params['params']) && !empty($params['params']['case_id'])) {
475 $params['params']['case_id'] = array('IN' => $params['id']);
476 unset($params['id']);
478 $params['id_field'] = 'case_id';
479 $params['label_field'] = $params['search_field'] = 'contact_id.sort_name';
480 $params['description_field'] = array(
482 'case_id.case_type_id.title',
485 'case_id.start_date',
489 'entity' => 'CaseContact',
490 'action' => 'getlist',
493 return civicrm_api3_generic_getList($apiRequest);
497 * Needed due to the above override
501 function _civicrm_api3_case_getlist_spec(&$params, $apiRequest) {
502 require_once 'api/v3/Generic/Getlist.php';
503 _civicrm_api3_generic_getlist_spec($params, $apiRequest);