api/v3/Case.php

   1 <?php
   2 /*
   3   +--------------------------------------------------------------------+
   4   | CiviCRM version 4.6                                                |
   5   +--------------------------------------------------------------------+
   6   | Copyright CiviCRM LLC (c) 2004-2014                                |
   7   +--------------------------------------------------------------------+
   8   | This file is a part of CiviCRM.                                    |
   9   |                                                                    |
  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.   |
  13   |                                                                    |
  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.        |
  18   |                                                                    |
  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   +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  * This api exposes CiviCRM Case.
  30  * Developed by woolman.org
  31  *
  32  * @package CiviCRM_APIv3
  33  * @subpackage API_Case
  34  */
  35
  36
  37 /**
  38  * Open a new case, add client and manager roles, and add standard timeline.
  39  *
  40  * @param array $params
  41  * //REQUIRED:
  42  * 'case_type_id' => int OR
  43  * 'case_type' => str (provide one or the other)
  44  * 'contact_id' => int // case client
  45  * 'subject' => str
  46  *
  47  * //OPTIONAL
  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"
  51  * 'location' => str
  52  * 'start_date' => str datestamp // defaults to: date('YmdHis')
  53  * 'duration' => int // in minutes
  54  * 'details' => str // html format
  55  *
  56  * @throws API_Exception
  57  * @return array
  58  *   api result array
  59  */
  60 function civicrm_api3_case_create($params) {
  61
  62   if (!empty($params['id'])) {
  63     return civicrm_api3_case_update($params);
  64   }
  65
  66   civicrm_api3_verify_mandatory($params, NULL, array(
  67     'contact_id',
  68     'subject',
  69     array('case_type', 'case_type_id'))
  70   );
  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     throw new API_Exception('Invalid case_type. No such case type exists.');
  76   }
  77   if (empty($params['case_type'])) {
  78     throw new API_Exception('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     throw new API_Exception('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
 133  *   Parameters determined by getfields.
 134  */
 135 function _civicrm_api3_case_get_spec(&$params) {
 136   $params['contact_id']['api.aliases'] = array('client_id');
 137   $params['contact_id']['title'] = 'Case Client';
 138 }
 139
 140 /**
 141  * Adjust Metadata for Create Action.
 142  *
 143  * @param array $params
 144  *   Array or parameters determined by getfields.
 145  */
 146 function _civicrm_api3_case_create_spec(&$params) {
 147   $params['contact_id']['api.aliases'] = array('client_id');
 148   $params['contact_id']['title'] = 'Case Client';
 149   $params['contact_id']['api.required'] = 1;
 150   $params['status_id']['api.default'] = 1;
 151   $params['status_id']['api.aliases'] = array('case_status');
 152   $params['creator_id']['api.default'] = 'user_contact_id';
 153   $params['creator_id']['type'] = CRM_Utils_Type::T_INT;
 154   $params['creator_id']['title'] = 'Case Created By';
 155   $params['start_date']['api.default'] = 'now';
 156   $params['medium_id'] = array(
 157     'name' => 'medium_id',
 158     'title' => 'Activity Medium',
 159   );
 160 }
 161
 162 /**
 163  * Adjust Metadata for Update action.
 164  *
 165  * @param array $params
 166  *   Array or parameters determined by getfields.
 167  */
 168 function _civicrm_api3_case_update_spec(&$params) {
 169   $params['id']['api.required'] = 1;
 170 }
 171
 172 /**
 173  * Adjust Metadata for Delete action.
 174  *
 175  * @param array $params
 176  *   Array or parameters determined by getfields.
 177  */
 178 function _civicrm_api3_case_delete_spec(&$params) {
 179   $params['id']['api.required'] = 1;
 180 }
 181
 182 /**
 183  * Get details of a particular case, or search for cases, depending on params.
 184  *
 185  * Please provide one (and only one) of the four get/search parameters:
 186  *
 187  * @param array $params
 188  *   'id' => if set, will get all available info about a case, including contacts and activities
 189  *
 190  *   // if no case_id provided, this function will use one of the following search parameters:
 191  *   'client_id' => finds all cases with a specific client
 192  *   'activity_id' => returns the case containing a specific activity
 193  *   'contact_id' => finds all cases associated with a contact (in any role, not just client)
 194  *
 195  * @throws API_Exception
 196  * @return array
 197  *   (get mode, case_id provided): Array with case details, case roles, case activity ids, (search mode, case_id not provided): Array of cases found
 198  */
 199 function civicrm_api3_case_get($params) {
 200   $options = _civicrm_api3_get_options_from_params($params);
 201   //search by client
 202   if (!empty($params['contact_id'])) {
 203     $ids = array();
 204     foreach ((array) $params['contact_id'] as $cid) {
 205       if (is_numeric($cid)) {
 206         $ids = array_merge($ids, CRM_Case_BAO_Case::retrieveCaseIdsByContactId($cid, TRUE));
 207       }
 208     }
 209     $cases = array();
 210     foreach ($ids as $id) {
 211       if ($case = _civicrm_api3_case_read($id, $options)) {
 212         $cases[$id] = $case;
 213       }
 214     }
 215     return civicrm_api3_create_success($cases, $params, 'case', 'get');
 216   }
 217
 218   //search by activity
 219   if (!empty($params['activity_id'])) {
 220     if (!is_numeric($params['activity_id'])) {
 221       throw new API_Exception('Invalid parameter: activity_id. Must provide a numeric value.');
 222     }
 223     $caseId = CRM_Case_BAO_Case::getCaseIdByActivityId($params['activity_id']);
 224     if (!$caseId) {
 225       return civicrm_api3_create_success(array(), $params, 'case', 'get');
 226     }
 227     $case = array($caseId => _civicrm_api3_case_read($caseId, $options));
 228     return civicrm_api3_create_success($case, $params, 'case', 'get');
 229   }
 230
 231   //search by contacts
 232   if (($contact = CRM_Utils_Array::value('contact_id', $params)) != FALSE) {
 233     if (!is_numeric($contact)) {
 234       throw new API_Exception('Invalid parameter: contact_id.  Must provide a numeric value.');
 235     }
 236
 237     $sql = "
 238 SELECT DISTINCT case_id
 239   FROM civicrm_relationship
 240  WHERE (contact_id_a = $contact
 241     OR contact_id_b = $contact)
 242    AND case_id IS NOT NULL";
 243     $dao = CRM_Core_DAO::executeQuery($sql);
 244
 245     $cases = array();
 246     while ($dao->fetch()) {
 247       $cases[$dao->case_id] = _civicrm_api3_case_read($dao->case_id, $options);
 248     }
 249     return civicrm_api3_create_success($cases, $params, 'case', 'get');
 250   }
 251
 252   // For historic reasons we always return these when an id is provided
 253   $caseId = CRM_Utils_Array::value('id', $params);
 254   if ($caseId) {
 255     $options['return'] = array('contacts' => 1, 'activities' => 1);
 256   }
 257
 258   $foundcases = _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params, TRUE, 'Case');
 259   $cases = array();
 260   foreach ($foundcases['values'] as $foundcase) {
 261     if ($case = _civicrm_api3_case_read($foundcase['id'], $options)) {
 262       $cases[$foundcase['id']] = $case;
 263     }
 264   }
 265
 266   return civicrm_api3_create_success($cases, $params, 'case', 'get');
 267 }
 268
 269 /**
 270  * Deprecated API.
 271  *
 272  * Use activity API instead.
 273  *
 274  * @param array $params
 275  *
 276  * @throws API_Exception
 277  * @return array
 278  */
 279 function civicrm_api3_case_activity_create($params) {
 280   require_once "api/v3/Activity.php";
 281   return civicrm_api3_activity_create($params) + array(
 282     'deprecated' => CRM_Utils_Array::value('activity_create', _civicrm_api3_case_deprecation()),
 283   );
 284 }
 285
 286 /**
 287  * Declare deprecated api functions.
 288  *
 289  * @deprecated api notice
 290  * @return array
 291  *   Array of deprecated actions
 292  */
 293 function _civicrm_api3_case_deprecation() {
 294   return array('activity_create' => 'Case api "activity_create" action is deprecated. Use the activity api instead.');
 295 }
 296
 297 /**
 298  * Update a specified case.
 299  *
 300  * @param array $params
 301  *   //REQUIRED:
 302  *   'case_id' => int
 303  *
 304  *   //OPTIONAL
 305  *   'status_id' => int
 306  *   'start_date' => str datestamp
 307  *   'contact_id' => int // case client
 308  *
 309  * @throws API_Exception
 310  * @return array
 311  *   api result array
 312  */
 313 function civicrm_api3_case_update($params) {
 314   //check parameters
 315   civicrm_api3_verify_mandatory($params, NULL, array('id'));
 316
 317   // return error if modifying creator id
 318   if (array_key_exists('creator_id', $params)) {
 319     throw new API_Exception(ts('You cannot update creator id'));
 320   }
 321
 322   $mCaseId = $origContactIds = array();
 323
 324   // get original contact id and creator id of case
 325   if (!empty($params['contact_id'])) {
 326     $origContactIds = CRM_Case_BAO_Case::retrieveContactIdsByCaseId($params['id']);
 327     $origContactId = $origContactIds[1];
 328   }
 329
 330   if (count($origContactIds) > 1) {
 331     // check valid orig contact id
 332     if (!empty($params['orig_contact_id']) && !in_array($params['orig_contact_id'], $origContactIds)) {
 333       throw new API_Exception('Invalid case contact id (orig_contact_id)');
 334     }
 335     elseif (empty($params['orig_contact_id'])) {
 336       throw new API_Exception('Case is linked with more than one contact id. Provide the required params orig_contact_id to be replaced');
 337     }
 338     $origContactId = $params['orig_contact_id'];
 339   }
 340
 341   // check for same contact id for edit Client
 342   if (!empty($params['contact_id']) && !in_array($params['contact_id'], $origContactIds)) {
 343     $mCaseId = CRM_Case_BAO_Case::mergeCases($params['contact_id'], $params['case_id'], $origContactId, NULL, TRUE);
 344   }
 345
 346   if (!empty($mCaseId[0])) {
 347     $params['id'] = $mCaseId[0];
 348   }
 349
 350   $dao = new CRM_Case_BAO_Case();
 351   $dao->id = $params['id'];
 352
 353   $dao->copyValues($params);
 354   $dao->save();
 355
 356   $case = array();
 357
 358   _civicrm_api3_object_to_array($dao, $case);
 359   $values[$dao->id] = $case;
 360
 361   return civicrm_api3_create_success($values, $params, 'case', 'update', $dao);
 362 }
 363
 364 /**
 365  * Delete a specified case.
 366  *
 367  * @param array $params
 368  *   //REQUIRED:
 369  *   'id' => int
 370  *
 371  *   //OPTIONAL
 372  *   'move_to_trash' => bool (defaults to false)
 373  *
 374  * @throws API_Exception
 375  * @return bool
 376  *   true if success, else false
 377  */
 378 function civicrm_api3_case_delete($params) {
 379   //check parameters
 380   civicrm_api3_verify_mandatory($params, NULL, array('id'));
 381
 382   if (CRM_Case_BAO_Case::deleteCase($params['id'], CRM_Utils_Array::value('move_to_trash', $params, FALSE))) {
 383     return civicrm_api3_create_success($params, $params, 'case', 'delete');
 384   }
 385   else {
 386     throw new API_Exception('Could not delete case.');
 387   }
 388 }
 389
 390 /***********************************/
 391 /*                                 */
 392 /*     INTERNAL FUNCTIONS          */
 393 /*                                 */
 394 /***********************************/
 395
 396 /**
 397  * Internal function to retrieve a case.
 398  *
 399  * @param int $caseId
 400  *
 401  * @param $options
 402  *
 403  * @return array
 404  *   case object
 405  */
 406 function _civicrm_api3_case_read($caseId, $options) {
 407   $return = CRM_Utils_Array::value('return', $options, array());
 408   $dao = new CRM_Case_BAO_Case();
 409   $dao->id = $caseId;
 410   if ($dao->find(TRUE)) {
 411     $case = array();
 412     _civicrm_api3_object_to_array($dao, $case);
 413     // Legacy support for client_id - TODO: in apiv4 remove 'client_id'
 414     $case['client_id'] = $case['contact_id'] = $dao->retrieveContactIdsByCaseId($caseId);
 415
 416     if (!empty($return['contacts'])) {
 417       //get case contacts
 418       $contacts = CRM_Case_BAO_Case::getcontactNames($caseId);
 419       $relations = CRM_Case_BAO_Case::getRelatedContacts($caseId);
 420       $case['contacts'] = array_merge($contacts, $relations);
 421     }
 422     if (!empty($return['activities'])) {
 423       //get case activities
 424       $case['activities'] = array();
 425       $query = "SELECT activity_id FROM civicrm_case_activity WHERE case_id = $caseId";
 426       $dao = CRM_Core_DAO::executeQuery($query);
 427       while ($dao->fetch()) {
 428         $case['activities'][] = $dao->activity_id;
 429       }
 430     }
 431     return $case;
 432   }
 433 }
 434
 435 /**
 436  * Internal function to format create params for processing.
 437  *
 438  * @param array $params
 439  */
 440 function _civicrm_api3_case_format_params(&$params) {
 441   // figure out case type id from case type and vice-versa
 442   $caseTypes = CRM_Case_PseudoConstant::caseType('name', FALSE);
 443   if (empty($params['case_type_id'])) {
 444     $params['case_type_id'] = array_search($params['case_type'], $caseTypes);
 445
 446     // DEPRECATED: lookup by label for backward compatibility
 447     if (!$params['case_type_id']) {
 448       $caseTypeLabels = CRM_Case_PseudoConstant::caseType('title', FALSE);
 449       $params['case_type_id'] = array_search($params['case_type'], $caseTypeLabels);
 450       $params['case_type'] = $caseTypes[$params['case_type_id']];
 451     }
 452   }
 453   elseif (empty($params['case_type'])) {
 454     $params['case_type'] = $caseTypes[$params['case_type_id']];
 455   }
 456 }