3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
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
42 * 'case_type_id' => int OR
43 * 'case_type' => str (provide one or the other)
44 * 'contact_id' => int // case client
48 * 'medium_id' => int // see civicrm option values for possibilities
49 * 'creator_id' => int // case manager, default to the logged in user
50 * 'status_id' => int // defaults to 1 "ongoing"
52 * 'start_date' => str datestamp // defaults to: date('YmdHis')
53 * 'duration' => int // in minutes
54 * 'details' => str // html format
57 * @throws API_Exception
61 function civicrm_api3_case_create($params) {
63 if (!empty($params['id'])) {
64 return civicrm_api3_case_update($params);
67 civicrm_api3_verify_mandatory($params, NULL, array(
70 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 throw new API_Exception('Invalid case_type. No such case type exists.');
78 if (empty($params['case_type'])) {
79 throw new API_Exception('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 throw new API_Exception('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
134 * Parameters determined by getfields.
136 function _civicrm_api3_case_get_spec(&$params) {
137 $params['contact_id'] = array(
138 'api.aliases' => array('client_id'),
139 'title' => 'Case Client',
140 'type' => CRM_Utils_Type
::T_INT
,
145 * Adjust Metadata for Create Action.
147 * @param array $params
148 * Array of parameters determined by getfields.
150 function _civicrm_api3_case_create_spec(&$params) {
151 $params['contact_id'] = array(
152 'api.aliases' => array('client_id'),
153 'title' => 'Case Client',
155 'type' => CRM_Utils_Type
::T_INT
,
157 $params['status_id']['api.default'] = 1;
158 $params['status_id']['api.aliases'] = array('case_status');
159 $params['creator_id']['api.default'] = 'user_contact_id';
160 $params['creator_id']['type'] = CRM_Utils_Type
::T_INT
;
161 $params['creator_id']['title'] = 'Case Created By';
162 $params['start_date']['api.default'] = 'now';
163 $params['medium_id'] = array(
164 'name' => 'medium_id',
165 'title' => 'Activity Medium',
166 'type' => CRM_Utils_Type
::T_INT
,
171 * Adjust Metadata for Update action.
173 * @param array $params
174 * Array of parameters determined by getfields.
176 function _civicrm_api3_case_update_spec(&$params) {
177 $params['id']['api.required'] = 1;
181 * Adjust Metadata for Delete action.
183 * @param array $params
184 * Array of parameters determined by getfields.
186 function _civicrm_api3_case_delete_spec(&$params) {
187 $params['id']['api.required'] = 1;
191 * Get details of a particular case, or search for cases, depending on params.
193 * Please provide one (and only one) of the four get/search parameters:
195 * @param array $params
196 * 'id' => if set, will get all available info about a case, including contacts and activities
198 * // if no case_id provided, this function will use one of the following search parameters:
199 * 'client_id' => finds all cases with a specific client
200 * 'activity_id' => returns the case containing a specific activity
201 * 'contact_id' => finds all cases associated with a contact (in any role, not just client)
203 * @throws API_Exception
205 * (get mode, case_id provided): Array with case details, case roles, case activity ids, (search mode, case_id not provided): Array of cases found
207 function civicrm_api3_case_get($params) {
208 $options = _civicrm_api3_get_options_from_params($params);
210 if (!empty($params['contact_id'])) {
212 foreach ((array) $params['contact_id'] as $cid) {
213 if (is_numeric($cid)) {
214 $ids = array_merge($ids, CRM_Case_BAO_Case
::retrieveCaseIdsByContactId($cid, TRUE));
218 foreach ($ids as $id) {
219 if ($case = _civicrm_api3_case_read($id, $options)) {
223 return civicrm_api3_create_success($cases, $params, 'Case', 'get');
227 if (!empty($params['activity_id'])) {
228 if (!is_numeric($params['activity_id'])) {
229 throw new API_Exception('Invalid parameter: activity_id. Must provide a numeric value.');
231 $caseId = CRM_Case_BAO_Case
::getCaseIdByActivityId($params['activity_id']);
233 return civicrm_api3_create_success(array(), $params, 'Case', 'get');
235 $case = array($caseId => _civicrm_api3_case_read($caseId, $options));
236 return civicrm_api3_create_success($case, $params, 'Case', 'get');
240 if (($contact = CRM_Utils_Array
::value('contact_id', $params)) != FALSE) {
241 if (!is_numeric($contact)) {
242 throw new API_Exception('Invalid parameter: contact_id. Must provide a numeric value.');
246 SELECT DISTINCT case_id
247 FROM civicrm_relationship
248 WHERE (contact_id_a = $contact
249 OR contact_id_b = $contact)
250 AND case_id IS NOT NULL";
251 $dao = CRM_Core_DAO
::executeQuery($sql);
254 while ($dao->fetch()) {
255 $cases[$dao->case_id
] = _civicrm_api3_case_read($dao->case_id
, $options);
257 return civicrm_api3_create_success($cases, $params, 'Case', 'get');
260 // For historic reasons we always return these when an id is provided
261 $caseId = CRM_Utils_Array
::value('id', $params);
263 $options['return'] = array('contacts' => 1, 'activities' => 1);
266 $foundcases = _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params, TRUE, 'Case');
268 foreach ($foundcases['values'] as $foundcase) {
269 if ($case = _civicrm_api3_case_read($foundcase['id'], $options)) {
270 $cases[$foundcase['id']] = $case;
274 return civicrm_api3_create_success($cases, $params, 'Case', 'get');
280 * Use activity API instead.
282 * @param array $params
284 * @throws API_Exception
287 function civicrm_api3_case_activity_create($params) {
288 require_once "api/v3/Activity.php";
289 return civicrm_api3_activity_create($params) +
array(
290 'deprecated' => CRM_Utils_Array
::value('activity_create', _civicrm_api3_case_deprecation()),
295 * Declare deprecated api functions.
297 * @deprecated api notice
299 * Array of deprecated actions
301 function _civicrm_api3_case_deprecation() {
302 return array('activity_create' => 'Case api "activity_create" action is deprecated. Use the activity api instead.');
306 * Update a specified case.
308 * @param array $params
314 * 'start_date' => str datestamp
315 * 'contact_id' => int // case client
317 * @throws API_Exception
321 function civicrm_api3_case_update($params) {
323 civicrm_api3_verify_mandatory($params, NULL, array('id'));
325 // return error if modifying creator id
326 if (array_key_exists('creator_id', $params)) {
327 throw new API_Exception(ts('You cannot update creator id'));
330 $mCaseId = $origContactIds = array();
332 // get original contact id and creator id of case
333 if (!empty($params['contact_id'])) {
334 $origContactIds = CRM_Case_BAO_Case
::retrieveContactIdsByCaseId($params['id']);
335 $origContactId = $origContactIds[1];
338 if (count($origContactIds) > 1) {
339 // check valid orig contact id
340 if (!empty($params['orig_contact_id']) && !in_array($params['orig_contact_id'], $origContactIds)) {
341 throw new API_Exception('Invalid case contact id (orig_contact_id)');
343 elseif (empty($params['orig_contact_id'])) {
344 throw new API_Exception('Case is linked with more than one contact id. Provide the required params orig_contact_id to be replaced');
346 $origContactId = $params['orig_contact_id'];
349 // check for same contact id for edit Client
350 if (!empty($params['contact_id']) && !in_array($params['contact_id'], $origContactIds)) {
351 $mCaseId = CRM_Case_BAO_Case
::mergeCases($params['contact_id'], $params['case_id'], $origContactId, NULL, TRUE);
354 if (!empty($mCaseId[0])) {
355 $params['id'] = $mCaseId[0];
358 $dao = new CRM_Case_BAO_Case();
359 $dao->id
= $params['id'];
361 $dao->copyValues($params);
366 _civicrm_api3_object_to_array($dao, $case);
367 $values[$dao->id
] = $case;
369 return civicrm_api3_create_success($values, $params, 'Case', 'update', $dao);
373 * Delete a specified case.
375 * @param array $params
381 * 'move_to_trash' => bool (defaults to false)
384 * @throws API_Exception
386 * true if success, else false
388 function civicrm_api3_case_delete($params) {
390 civicrm_api3_verify_mandatory($params, NULL, array('id'));
392 if (CRM_Case_BAO_Case
::deleteCase($params['id'], CRM_Utils_Array
::value('move_to_trash', $params, FALSE))) {
393 return civicrm_api3_create_success($params, $params, 'Case', 'delete');
396 throw new API_Exception('Could not delete case.');
401 * Internal function to retrieve a case.
410 function _civicrm_api3_case_read($caseId, $options) {
411 $return = CRM_Utils_Array
::value('return', $options, array());
412 $dao = new CRM_Case_BAO_Case();
414 if ($dao->find(TRUE)) {
416 _civicrm_api3_object_to_array($dao, $case);
417 // Legacy support for client_id - TODO: in apiv4 remove 'client_id'
418 $case['client_id'] = $case['contact_id'] = $dao->retrieveContactIdsByCaseId($caseId);
420 if (!empty($return['contacts'])) {
422 $contacts = CRM_Case_BAO_Case
::getcontactNames($caseId);
423 $relations = CRM_Case_BAO_Case
::getRelatedContacts($caseId);
424 $case['contacts'] = array_merge($contacts, $relations);
426 if (!empty($return['activities'])) {
427 //get case activities
428 $case['activities'] = array();
429 $query = "SELECT activity_id FROM civicrm_case_activity WHERE case_id = $caseId";
430 $dao = CRM_Core_DAO
::executeQuery($query);
431 while ($dao->fetch()) {
432 $case['activities'][] = $dao->activity_id
;
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']];