api/v3/Case.php

   1 <?php
   2
   3 /*
   4   +--------------------------------------------------------------------+
   5   | CiviCRM version 4.4                                                |
   6   +--------------------------------------------------------------------+
   7   | Copyright CiviCRM LLC (c) 2004-2013                                |
   8   +--------------------------------------------------------------------+
   9   | This file is a part of CiviCRM.                                    |
  10   |                                                                    |
  11   | CiviCRM is free software; you can copy, modify, and distribute it  |
  12   | under the terms of the GNU Affero General Public License           |
  13   | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  14   |                                                                    |
  15   | CiviCRM is distributed in the hope that it will be useful, but     |
  16   | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  17   | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  18   | See the GNU Affero General Public License for more details.        |
  19   |                                                                    |
  20   | You should have received a copy of the GNU Affero General Public   |
  21   | License and the CiviCRM Licensing Exception along                  |
  22   | with this program; if not, contact CiviCRM LLC                     |
  23   | at info[AT]civicrm[DOT]org. If you have questions about the        |
  24   | GNU Affero General Public License or the licensing of CiviCRM,     |
  25   | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  26   +--------------------------------------------------------------------+
  27 */
  28
  29 /**
  30  * File for the CiviCRM APIv3 Case functions
  31  * Developed by woolman.org
  32  *
  33  * @package CiviCRM_APIv3
  34  * @subpackage API_Case
  35  * @copyright CiviCRM LLC (c) 2004-2013
  36  *
  37  */
  38
  39
  40 /**
  41  * Open a new case, add client and manager roles, and add standard timeline
  42  *
  43  * @param  array(
  44     //REQUIRED:
  45  * 'case_type_id' => int OR
  46  * 'case_type' => str (provide one or the other)
  47  * 'contact_id' => int // case client
  48  * 'subject' => str
  49  *
  50  * //OPTIONAL
  51  * 'medium_id' => int // see civicrm option values for possibilities
  52  * 'creator_id' => int // case manager, default to the logged in user
  53  * 'status_id' => int // defaults to 1 "ongoing"
  54  * 'location' => str
  55  * 'start_date' => str datestamp // defaults to: date('YmdHis')
  56  * 'duration' => int // in minutes
  57  * 'details' => str // html format
  58  *
  59  * @return sucessfully opened case
  60  *
  61  * @access public
  62  * {@getfields case_create}
  63  */
  64 function civicrm_api3_case_create($params) {
  65
  66   if (!empty($params['id'])) {
  67     return civicrm_api3_case_update($params);
  68   }
  69
  70   civicrm_api3_verify_mandatory($params, NULL, array('contact_id', 'subject', array('case_type', 'case_type_id')));
  71   _civicrm_api3_case_format_params($params);
  72
  73   // If format_params didn't find what it was looking for, return error
  74   if (empty($params['case_type_id'])) {
  75     return civicrm_api3_create_error('Invalid case_type. No such case type exists.');
  76   }
  77   if (empty($params['case_type'])) {
  78     return civicrm_api3_create_error('Invalid case_type_id. No such case type exists.');
  79   }
  80
  81   // Fixme: can we safely pass raw params to the BAO?
  82   $newParams = array(
  83     'case_type_id' => $params['case_type_id'],
  84     'creator_id' => $params['creator_id'],
  85     'status_id' => $params['status_id'],
  86     'start_date' => $params['start_date'],
  87     'end_date' => CRM_Utils_Array::value('end_date', $params),
  88     'subject' => $params['subject'],
  89   );
  90
  91   $caseBAO = CRM_Case_BAO_Case::create($newParams);
  92
  93   if (!$caseBAO) {
  94     return civicrm_api3_create_error('Case not created. Please check input params.');
  95   }
  96
  97   foreach ((array) $params['contact_id'] as $cid) {
  98     $contactParams = array('case_id' => $caseBAO->id, 'contact_id' => $cid);
  99     CRM_Case_BAO_Case::addCaseToContact($contactParams);
 100   }
 101
 102   // Initialize XML processor with $params
 103   $xmlProcessor = new CRM_Case_XMLProcessor_Process();
 104   $xmlProcessorParams = array(
 105     'clientID' => $params['contact_id'],
 106     'creatorID' => $params['creator_id'],
 107     'standardTimeline' => 1,
 108     'activityTypeName' => 'Open Case',
 109     'caseID' => $caseBAO->id,
 110     'subject' => $params['subject'],
 111     'location' => CRM_Utils_Array::value('location', $params),
 112     'activity_date_time' => $params['start_date'],
 113     'duration' => CRM_Utils_Array::value('duration', $params),
 114     'medium_id' => CRM_Utils_Array::value('medium_id', $params),
 115     'details' => CRM_Utils_Array::value('details', $params),
 116     'custom' => array(),
 117   );
 118
 119   // Do it! :-D
 120   $xmlProcessor->run($params['case_type'], $xmlProcessorParams);
 121
 122   // return case
 123   $values = array();
 124   _civicrm_api3_object_to_array($caseBAO, $values[$caseBAO->id]);
 125
 126   return civicrm_api3_create_success($values, $params, 'case', 'create', $caseBAO);
 127 }
 128
 129 /**
 130  * Adjust Metadata for Get Action
 131  *
 132  * @param array $params array or parameters determined by getfields
 133  */
 134 function _civicrm_api3_case_get_spec(&$params) {
 135   $params['contact_id']['api.aliases'] = array('client_id');
 136   $params['contact_id']['title'] = 'Case Client';
 137 }
 138
 139 /**
 140  * Adjust Metadata for Create Action
 141  *
 142  * @param array $params array or parameters determined by getfields
 143  */
 144 function _civicrm_api3_case_create_spec(&$params) {
 145   $params['contact_id']['api.aliases'] = array('client_id');
 146   $params['contact_id']['title'] = 'Case Client';
 147   $params['contact_id']['api.required'] = 1;
 148   $params['status_id']['api.default'] = 1;
 149   $params['medium_id'] = array(
 150     'name' => 'medium_id',
 151     'title' => 'Activity Medium',
 152   );
 153 }
 154
 155 /**
 156  * Adjust Metadata for Update action
 157  *
 158  * @param array $params array or parameters determined by getfields
 159  */
 160 function _civicrm_api3_case_update_spec(&$params) {
 161   $params['id']['api.required'] = 1;
 162 }
 163
 164 /**
 165  * Adjust Metadata for Delete action
 166  *
 167  * @param array $params array or parameters determined by getfields
 168  */
 169 function _civicrm_api3_case_delete_spec(&$params) {
 170   $params['id']['api.required'] = 1;
 171 }
 172
 173 /**
 174  * Get details of a particular case, or search for cases, depending on params
 175  *
 176  * Please provide one (and only one) of the four get/search parameters:
 177  *
 178  * @param array(
 179     'id' => if set, will get all available info about a case, including contacts and activities
 180  *
 181  * // if no case_id provided, this function will use one of the following search parameters:
 182  * 'client_id' => finds all cases with a specific client
 183  * 'activity_id' => returns the case containing a specific activity
 184  * 'contact_id' => finds all cases associated with a contact (in any role, not just client)
 185  *
 186  * {@getfields case_get}
 187  *
 188  * @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
 189  * @access public
 190  * @todo Erik Hommel 16 dec 2010 check if all DB fields are returned
 191  */
 192 function civicrm_api3_case_get($params) {
 193   $options = _civicrm_api3_get_options_from_params($params);
 194
 195   //search by client
 196   if (!empty($params['contact_id'])) {
 197     $ids = array();
 198     foreach ((array) $params['contact_id'] as $cid) {
 199       if (is_numeric($cid)) {
 200         $ids = array_merge($ids, CRM_Case_BAO_Case::retrieveCaseIdsByContactId($cid, TRUE));
 201       }
 202     }
 203     $cases = array();
 204     foreach ($ids as $id) {
 205       if ($case = _civicrm_api3_case_read($id, $options)) {
 206         $cases[$id] = $case;
 207       }
 208     }
 209     return civicrm_api3_create_success($cases, $params, 'case', 'get');
 210   }
 211
 212   //search by activity
 213   if (!empty($params['activity_id'])) {
 214     if (!is_numeric($params['activity_id'])) {
 215       return civicrm_api3_create_error('Invalid parameter: activity_id. Must provide a numeric value.');
 216     }
 217     $caseId = CRM_Case_BAO_Case::getCaseIdByActivityId($params['activity_id']);
 218     if (!$caseId) {
 219       return civicrm_api3_create_success(array(), $params, 'case', 'get');
 220     }
 221     $case = array($caseId => _civicrm_api3_case_read($caseId, $options));
 222     return civicrm_api3_create_success($case, $params, 'case', 'get');
 223   }
 224
 225   //search by contacts
 226   if ($contact = CRM_Utils_Array::value('contact_id', $params)) {
 227     if (!is_numeric($contact)) {
 228       return civicrm_api3_create_error('Invalid parameter: contact_id.  Must provide a numeric value.');
 229     }
 230
 231     $sql = "
 232 SELECT DISTINCT case_id
 233   FROM civicrm_relationship
 234  WHERE (contact_id_a = $contact
 235     OR contact_id_b = $contact)
 236    AND case_id IS NOT NULL";
 237     $dao = &CRM_Core_DAO::executeQuery($sql);
 238
 239     $cases = array();
 240     while ($dao->fetch()) {
 241       $cases[$dao->case_id] = _civicrm_api3_case_read($dao->case_id, $options);
 242     }
 243     return civicrm_api3_create_success($cases, $params, 'case', 'get');
 244   }
 245
 246   // For historic reasons we always return these when an id is provided
 247   $caseId = CRM_Utils_Array::value('id', $params);
 248   if ($caseId) {
 249     $options['return'] = array('contacts' => 1, 'activities' => 1);
 250   }
 251
 252   $foundcases =  _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params, TRUE, 'Case');
 253   $cases = array();
 254   foreach ($foundcases['values'] as $foundcase) {
 255       if ($case = _civicrm_api3_case_read($foundcase['id'], $options)) {
 256         $cases[$foundcase['id']] = $case;
 257       }
 258     }
 259
 260   return civicrm_api3_create_success($cases, $params, 'case', 'get');
 261 }
 262
 263 /**
 264  * Deprecated. Use activity API instead
 265  */
 266 function civicrm_api3_case_activity_create($params) {
 267   return civicrm_api3_activity_create($params);
 268 }
 269
 270 /**
 271  * Update a specified case.
 272  *
 273  * @param  array(
 274     //REQUIRED:
 275  * 'case_id' => int
 276  *
 277  * //OPTIONAL
 278  * 'status_id' => int
 279  * 'start_date' => str datestamp
 280  * 'contact_id' => int // case client
 281  *
 282  * @return Updated case
 283  *
 284  * @access public
 285  *
 286  */
 287 function civicrm_api3_case_update($params) {
 288   //check parameters
 289   civicrm_api3_verify_mandatory($params, NULL, array('id'));
 290
 291   // return error if modifing creator id
 292   if (array_key_exists('creator_id', $params)) {
 293     return civicrm_api3_create_error(ts('You cannot update creator id'));
 294   }
 295
 296   $mCaseId = array();
 297   $origContactIds = array();
 298
 299   // get original contact id and creator id of case
 300   if (!empty($params['contact_id'])) {
 301     $origContactIds = CRM_Case_BAO_Case::retrieveContactIdsByCaseId($params['id']);
 302     $origContactId = $origContactIds[1];
 303   }
 304
 305   if (count($origContactIds) > 1) {
 306     // check valid orig contact id
 307     if (!empty($params['orig_contact_id']) && !in_array($params['orig_contact_id'], $origContactIds)) {
 308       return civicrm_api3_create_error('Invalid case contact id (orig_contact_id)');
 309     }
 310     elseif (empty($params['orig_contact_id'])) {
 311       return civicrm_api3_create_error('Case is linked with more than one contact id. Provide the required params orig_contact_id to be replaced');
 312     }
 313     $origContactId = $params['orig_contact_id'];
 314   }
 315
 316   // check for same contact id for edit Client
 317   if (!empty($params['contact_id']) && !in_array($params['contact_id'], $origContactIds)) {
 318     $mCaseId = CRM_Case_BAO_Case::mergeCases($params['contact_id'], $params['case_id'], $origContactId, NULL, TRUE);
 319   }
 320
 321   if (!empty($mCaseId[0])) {
 322     $params['id'] = $mCaseId[0];
 323   }
 324
 325   $dao = new CRM_Case_BAO_Case();
 326   $dao->id = $params['id'];
 327
 328   $dao->copyValues($params);
 329   $dao->save();
 330
 331   $case = array();
 332
 333   _civicrm_api3_object_to_array($dao, $case);
 334
 335   return civicrm_api3_create_success($case, $params, 'case', 'update', $dao);
 336 }
 337
 338 /**
 339  * Delete a specified case.
 340  *
 341  * @param  array(
 342     //REQUIRED:
 343  * 'id' => int
 344  *
 345  * //OPTIONAL
 346  * 'move_to_trash' => bool (defaults to false)
 347  *
 348  * @return boolean: true if success, else false
 349  * {@getfields case_delete}
 350  * @access public
 351  */
 352 function civicrm_api3_case_delete($params) {
 353   //check parameters
 354   civicrm_api3_verify_mandatory($params, NULL, array('id'));
 355
 356   if (CRM_Case_BAO_Case::deleteCase($params['id'], CRM_Utils_Array::value('move_to_trash', $params, FALSE))) {
 357     return civicrm_api3_create_success($params, $params, 'case', 'delete');
 358   }
 359   else {
 360     return civicrm_api3_create_error('Could not delete case.');
 361   }
 362 }
 363
 364 /***********************************/
 365 /*                                 */
 366 /*     INTERNAL FUNCTIONS          */
 367 /*                                 */
 368 /***********************************/
 369
 370 /**
 371  * Internal function to retrieve a case.
 372  *
 373  * @param int $caseId
 374  *
 375  * @return array (reference) case object
 376  *
 377  */
 378 function _civicrm_api3_case_read($caseId, $options) {
 379   $return = CRM_Utils_Array::value('return', $options, array());
 380   $dao = new CRM_Case_BAO_Case();
 381   $dao->id = $caseId;
 382   if ($dao->find(TRUE)) {
 383     $case = array();
 384     _civicrm_api3_object_to_array($dao, $case);
 385     // Legacy support for client_id - TODO: in apiv4 remove 'client_id'
 386     $case['client_id'] = $case['contact_id'] = $dao->retrieveContactIdsByCaseId($caseId);
 387
 388     //handle multi-value case type
 389     $sep = CRM_Core_DAO::VALUE_SEPARATOR;
 390     $case['case_type_id'] = trim(str_replace($sep, ',', $case['case_type_id']), ',');
 391
 392     if (!empty($return['contacts'])) {
 393       //get case contacts
 394       $contacts = CRM_Case_BAO_Case::getcontactNames($caseId);
 395       $relations = CRM_Case_BAO_Case::getRelatedContacts($caseId);
 396       $case['contacts'] = array_merge($contacts, $relations);
 397     }
 398     if (!empty($return['activities'])) {
 399       //get case activities
 400       $case['activities'] = array();
 401       $query = "SELECT activity_id FROM civicrm_case_activity WHERE case_id = $caseId";
 402       $dao = CRM_Core_DAO::executeQuery($query);
 403       while ($dao->fetch()) {
 404         $case['activities'][] = $dao->activity_id;
 405       }
 406     }
 407     return $case;
 408   }
 409 }
 410
 411 /**
 412  * Internal function to format create params for processing
 413  */
 414 function _civicrm_api3_case_format_params(&$params) {
 415   if (!array_key_exists('creator_id', $params)) {
 416     $session = CRM_Core_Session::singleton();
 417     $params['creator_id'] = $session->get('userID');
 418   }
 419   if (empty($params['start_date'])) {
 420     $params['start_date'] = date('YmdHis');
 421   }
 422   // figure out case type id from case type and vice-versa
 423   $caseTypes = CRM_Case_PseudoConstant::caseType('label', FALSE);
 424   if (empty($params['case_type_id'])) {
 425     $params['case_type_id'] = array_search($params['case_type'], $caseTypes);
 426   }
 427   elseif (empty($params['case_type'])) {
 428     $params['case_type'] = $caseTypes[$params['case_type_id']];
 429   }
 430   // format input with value separators
 431   $sep = CRM_Core_DAO::VALUE_SEPARATOR;
 432   $params['case_type_id'] = $sep . implode($sep, (array) $params['case_type_id']) . $sep;
 433 }