5 +--------------------------------------------------------------------+
6 | CiviCRM version 4.3 |
7 +--------------------------------------------------------------------+
8 | Copyright CiviCRM LLC (c) 2004-2013 |
9 +--------------------------------------------------------------------+
10 | This file is a part of CiviCRM. |
12 | CiviCRM is free software; you can copy, modify, and distribute it |
13 | under the terms of the GNU Affero General Public License |
14 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
16 | CiviCRM is distributed in the hope that it will be useful, but |
17 | WITHOUT ANY WARRANTY; without even the implied warranty of |
18 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
19 | See the GNU Affero General Public License for more details. |
21 | You should have received a copy of the GNU Affero General Public |
22 | License and the CiviCRM Licensing Exception along |
23 | with this program; if not, contact CiviCRM LLC |
24 | at info[AT]civicrm[DOT]org. If you have questions about the |
25 | GNU Affero General Public License or the licensing of CiviCRM, |
26 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
27 +--------------------------------------------------------------------+
31 * File for the CiviCRM APIv3 Case functions
32 * Developed by woolman.org
34 * @package CiviCRM_APIv3
35 * @subpackage API_Case
36 * @copyright CiviCRM LLC (c) 2004-2013
42 * Open a new case, add client and manager roles, and add standard timeline
46 * 'case_type_id' => int OR
47 * 'case_type' => str (provide one or the other)
48 * 'contact_id' => int // case client
52 * 'medium_id' => int // see civicrm option values for possibilities
53 * 'creator_id' => int // case manager, default to the logged in user
54 * 'status_id' => int // defaults to 1 "ongoing"
56 * 'start_date' => str datestamp // defaults to: date('YmdHis')
57 * 'duration' => int // in minutes
58 * 'details' => str // html format
60 * @return sucessfully opened case
63 * {@getfields case_create}
65 function civicrm_api3_case_create($params) {
67 if (!empty($params['id'])) {
68 return civicrm_api3_case_update($params);
71 civicrm_api3_verify_mandatory($params, NULL, array('contact_id', 'subject', array('case_type', 'case_type_id')));
72 _civicrm_api3_case_format_params($params);
74 // If format_params didn't find what it was looking for, return error
75 if (empty($params['case_type_id'])) {
76 return civicrm_api3_create_error('Invalid case_type. No such case type exists.');
78 if (empty($params['case_type'])) {
79 return civicrm_api3_create_error('Invalid case_type_id. No such case type exists.');
82 // Fixme: can we safely pass raw params to the BAO?
84 'case_type_id' => $params['case_type_id'],
85 'creator_id' => $params['creator_id'],
86 'status_id' => $params['status_id'],
87 'start_date' => $params['start_date'],
88 'end_date' => CRM_Utils_Array
::value('end_date', $params),
89 'subject' => $params['subject'],
92 $caseBAO = CRM_Case_BAO_Case
::create($newParams);
95 return civicrm_api3_create_error('Case not created. Please check input params.');
98 foreach ((array) $params['contact_id'] as $cid) {
99 $contactParams = array('case_id' => $caseBAO->id
, 'contact_id' => $cid);
100 CRM_Case_BAO_Case
::addCaseToContact($contactParams);
103 // Initialize XML processor with $params
104 $xmlProcessor = new CRM_Case_XMLProcessor_Process();
105 $xmlProcessorParams = array(
106 'clientID' => $params['contact_id'],
107 'creatorID' => $params['creator_id'],
108 'standardTimeline' => 1,
109 'activityTypeName' => 'Open Case',
110 'caseID' => $caseBAO->id
,
111 'subject' => $params['subject'],
112 'location' => CRM_Utils_Array
::value('location', $params),
113 'activity_date_time' => $params['start_date'],
114 'duration' => CRM_Utils_Array
::value('duration', $params),
115 'medium_id' => CRM_Utils_Array
::value('medium_id', $params),
116 'details' => CRM_Utils_Array
::value('details', $params),
121 $xmlProcessor->run($params['case_type'], $xmlProcessorParams);
125 _civicrm_api3_object_to_array($caseBAO, $values[$caseBAO->id
]);
127 return civicrm_api3_create_success($values, $params, 'case', 'create', $caseBAO);
131 * Adjust Metadata for Get Action
133 * @param array $params array or parameters determined by getfields
135 function _civicrm_api3_case_get_spec(&$params) {
136 $params['contact_id']['api.aliases'] = array('client_id');
137 $params['contact_id']['title'] = 'Case Client';
141 * Adjust Metadata for Create Action
143 * @param array $params array or parameters determined by getfields
145 function _civicrm_api3_case_create_spec(&$params) {
146 $params['contact_id']['api.aliases'] = array('client_id');
147 $params['contact_id']['title'] = 'Case Client';
148 $params['contact_id']['api.required'] = 1;
149 $params['status_id']['api.default'] = 1;
153 * Adjust Metadata for Update action
155 * @param array $params array or parameters determined by getfields
157 function _civicrm_api3_case_update_spec(&$params) {
158 $params['id']['api.required'] = 1;
162 * Adjust Metadata for Delete action
164 * @param array $params array or parameters determined by getfields
166 function _civicrm_api3_case_delete_spec(&$params) {
167 $params['id']['api.required'] = 1;
171 * Get details of a particular case, or search for cases, depending on params
173 * Please provide one (and only one) of the four get/search parameters:
176 'id' => if set, will get all available info about a case, including contacts and activities
178 * // if no case_id provided, this function will use one of the following search parameters:
179 * 'client_id' => finds all cases with a specific client
180 * 'activity_id' => returns the case containing a specific activity
181 * 'contact_id' => finds all cases associated with a contact (in any role, not just client)
183 * {@getfields case_get}
185 * @return (get mode, case_id provided): Array with case details, case roles, case activity ids, (search mode, case_id not provided): Array of cases found
187 * @todo Erik Hommel 16 dec 2010 check if all DB fields are returned
189 function civicrm_api3_case_get($params) {
190 civicrm_api3_verify_mandatory($params, NULL, array(
191 array('case_id', 'contact_id', 'activity_id', 'contact_id')
194 $options = _civicrm_api3_get_options_from_params($params);
197 $caseId = CRM_Utils_Array
::value('id', $params);
200 if (!is_numeric($caseId)) {
201 return civicrm_api3_create_error('Invalid parameter: case_id. Must provide a numeric value.');
203 // For historic reasons we always return these when an id is provided
204 $options['return'] = array('contacts' => 1, 'activities' => 1);
205 $case = _civicrm_api3_case_read($caseId, $options);
208 return civicrm_api3_create_success(array($caseId => $case), $params, 'case', 'get');
211 return civicrm_api3_create_success(array(), $params, 'case', 'get');
216 if (!empty($params['contact_id'])) {
218 foreach ((array) $params['contact_id'] as $cid) {
219 if (is_numeric($cid)) {
220 $ids = array_merge($ids, CRM_Case_BAO_Case
::retrieveCaseIdsByContactId($cid, TRUE));
224 foreach ($ids as $id) {
225 if ($case = _civicrm_api3_case_read($id, $options)) {
229 return civicrm_api3_create_success($cases, $params, 'case', 'get');
233 if (!empty($params['activity_id'])) {
234 if (!is_numeric($params['activity_id'])) {
235 return civicrm_api3_create_error('Invalid parameter: activity_id. Must provide a numeric value.');
237 $caseId = CRM_Case_BAO_Case
::getCaseIdByActivityId($params['activity_id']);
239 return civicrm_api3_create_success(array(), $params, 'case', 'get');
241 $case = array($caseId => _civicrm_api3_case_read($caseId, $options));
242 return civicrm_api3_create_success($case, $params, 'case', 'get');
246 if ($contact = CRM_Utils_Array
::value('contact_id', $params)) {
247 if (!is_numeric($contact)) {
248 return civicrm_api3_create_error('Invalid parameter: contact_id. Must provide a numeric value.');
252 SELECT DISTINCT case_id
253 FROM civicrm_relationship
254 WHERE (contact_id_a = $contact
255 OR contact_id_b = $contact)
256 AND case_id IS NOT NULL";
257 $dao = &CRM_Core_DAO
::executeQuery($sql);
260 while ($dao->fetch()) {
261 $cases[$dao->case_id
] = _civicrm_api3_case_read($dao->case_id
, $options);
263 return civicrm_api3_create_success($cases, $params, 'case', 'get');
268 * Deprecated. Use activity API instead
270 function civicrm_api3_case_activity_create($params) {
271 return civicrm_api3_activity_create($params);
275 * Update a specified case.
283 * 'start_date' => str datestamp
284 * 'contact_id' => int // case client
286 * @return Updated case
291 function civicrm_api3_case_update($params) {
293 civicrm_api3_verify_mandatory($params, NULL, array('id'));
295 // return error if modifing creator id
296 if (array_key_exists('creator_id', $params)) {
297 return civicrm_api3_create_error(ts('You cannot update creator id'));
301 $origContactIds = array();
303 // get original contact id and creator id of case
304 if (!empty($params['contact_id'])) {
305 $origContactIds = CRM_Case_BAO_Case
::retrieveContactIdsByCaseId($params['case_id']);
306 $origContactId = $origContactIds[1];
309 if (count($origContactIds) > 1) {
310 // check valid orig contact id
311 if (!empty($params['orig_contact_id']) && !in_array($params['orig_contact_id'], $origContactIds)) {
312 return civicrm_api3_create_error('Invalid case contact id (orig_contact_id)');
314 elseif (empty($params['orig_contact_id'])) {
315 return civicrm_api3_create_error('Case is linked with more than one contact id. Provide the required params orig_contact_id to be replaced');
317 $origContactId = $params['orig_contact_id'];
320 // check for same contact id for edit Client
321 if (!empty($params['contact_id']) && !in_array($params['contact_id'], $origContactIds)) {
322 $mCaseId = CRM_Case_BAO_Case
::mergeCases($params['contact_id'], $params['case_id'], $origContactId, NULL, TRUE);
325 if (!empty($mCaseId[0])) {
326 $params['case_id'] = $mCaseId[0];
329 $dao = new CRM_Case_BAO_Case();
330 $dao->id
= $params['id'];
332 $dao->copyValues($params);
337 _civicrm_api3_object_to_array($dao, $case);
339 return civicrm_api3_create_success($case, $params, 'case', 'update', $dao);
343 * Delete a specified case.
350 * 'move_to_trash' => bool (defaults to false)
352 * @return boolean: true if success, else false
353 * {@getfields case_delete}
356 function civicrm_api3_case_delete($params) {
358 civicrm_api3_verify_mandatory($params, NULL, array('id'));
360 if (CRM_Case_BAO_Case
::deleteCase($params['id'], CRM_Utils_Array
::value('move_to_trash', $params, FALSE))) {
361 return civicrm_api3_create_success($params, $params, 'case', 'delete');
364 return civicrm_api3_create_error('Could not delete case.');
368 /***********************************/
370 /* INTERNAL FUNCTIONS */
372 /***********************************/
375 * Internal function to retrieve a case.
379 * @return array (reference) case object
382 function _civicrm_api3_case_read($caseId, $options) {
383 $return = CRM_Utils_Array
::value('return', $options, array());
384 $dao = new CRM_Case_BAO_Case();
386 if ($dao->find(TRUE)) {
388 _civicrm_api3_object_to_array($dao, $case);
389 // Legacy support for client_id - TODO: in apiv4 remove 'client_id'
390 $case['client_id'] = $case['contact_id'] = $dao->retrieveContactIdsByCaseId($caseId);
392 //handle multi-value case type
393 $sep = CRM_Core_DAO
::VALUE_SEPARATOR
;
394 $case['case_type_id'] = trim(str_replace($sep, ',', $case['case_type_id']), ',');
396 if (!empty($return['contacts'])) {
398 $contacts = CRM_Case_BAO_Case
::getcontactNames($caseId);
399 $relations = CRM_Case_BAO_Case
::getRelatedContacts($caseId);
400 $case['contacts'] = array_merge($contacts, $relations);
402 if (!empty($return['activities'])) {
403 //get case activities
404 $case['activities'] = array();
405 $query = "SELECT activity_id FROM civicrm_case_activity WHERE case_id = $caseId";
406 $dao = CRM_Core_DAO
::executeQuery($query);
407 while ($dao->fetch()) {
408 $case['activities'][] = $dao->activity_id
;
416 * Internal function to format create params for processing
418 function _civicrm_api3_case_format_params(&$params) {
419 if (!array_key_exists('creator_id', $params)) {
420 $session = CRM_Core_Session
::singleton();
421 $params['creator_id'] = $session->get('userID');
423 if (empty($params['start_date'])) {
424 $params['start_date'] = date('YmdHis');
426 // figure out case type id from case type and vice-versa
427 $caseTypes = CRM_Case_PseudoConstant
::caseType('label', FALSE);
428 if (empty($params['case_type_id'])) {
429 $params['case_type_id'] = array_search($params['case_type'], $caseTypes);
431 elseif (empty($params['case_type'])) {
432 $params['case_type'] = $caseTypes[$params['case_type_id']];
434 // format input with value separators
435 $sep = CRM_Core_DAO
::VALUE_SEPARATOR
;
436 $params['case_type_id'] = $sep . implode($sep, (array) $params['case_type_id']) . $sep;