api/v3/Case.php

   1 <?php
   2 /*
   3   +--------------------------------------------------------------------+
   4   | CiviCRM version 4.7                                                |
   5   +--------------------------------------------------------------------+
   6   | Copyright CiviCRM LLC (c) 2004-2015                                |
   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 objects.
  30  * Developed by woolman.org
  31  *
  32  * @package CiviCRM_APIv3
  33  */
  34
  35
  36 /**
  37  * Open a new case, add client and manager roles, and standard timeline.
  38  *
  39  * @param array $params
  40  *
  41  * @code
  42  * //REQUIRED:
  43  * 'case_type_id' => int OR
  44  * 'case_type' => str (provide one or the other)
  45  * 'contact_id' => int // case client
  46  * 'subject' => str
  47  *
  48  * //OPTIONAL
  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"
  52  * 'location' => str
  53  * 'start_date' => str datestamp // defaults to: date('YmdHis')
  54  * 'duration' => int // in minutes
  55  * 'details' => str // html format
  56  * @endcode
  57  *
  58  * @throws API_Exception
  59  * @return array
  60  *   api result array
  61  */
  62 function civicrm_api3_case_create($params) {
  63
  64   if (!empty($params['id'])) {
  65     return civicrm_api3_case_update($params);
  66   }
  67
  68   civicrm_api3_verify_mandatory($params, NULL, array(
  69     'contact_id',
  70     'subject',
  71     array('case_type', 'case_type_id'))
  72   );
  73   _civicrm_api3_case_format_params($params);
  74
  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.');
  78   }
  79   if (empty($params['case_type'])) {
  80     throw new API_Exception('Invalid case_type_id. No such case type exists.');
  81   }
  82
  83   // Fixme: can we safely pass raw params to the BAO?
  84   $newParams = array(
  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'],
  91   );
  92
  93   $caseBAO = CRM_Case_BAO_Case::create($newParams);
  94
  95   if (!$caseBAO) {
  96     throw new API_Exception('Case not created. Please check input params.');
  97   }
  98
  99   foreach ((array) $params['contact_id'] as $cid) {
 100     $contactParams = array('case_id' => $caseBAO->id, 'contact_id' => $cid);
 101     CRM_Case_BAO_Case::addCaseToContact($contactParams);
 102   }
 103
 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),
 118     'custom' => array(),
 119   );
 120
 121   // Do it! :-D
 122   $xmlProcessor->run($params['case_type'], $xmlProcessorParams);
 123
 124   // return case
 125   $values = array();
 126   _civicrm_api3_object_to_array($caseBAO, $values[$caseBAO->id]);
 127
 128   return civicrm_api3_create_success($values, $params, 'Case', 'create', $caseBAO);
 129 }
 130
 131 /**
 132  * Adjust Metadata for Get Action.
 133  *
 134  * @param array $params
 135  *   Parameters determined by getfields.
 136  */
 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,
 143     'FKApiName' => 'Contact',
 144   );
 145   $params['activity_id'] = array(
 146     'title' => 'Case Activity',
 147     'description' => 'Id of an activity in the case',
 148     'type' => CRM_Utils_Type::T_INT,
 149     'FKApiName' => 'Activity',
 150   );
 151 }
 152
 153 /**
 154  * Adjust Metadata for Create Action.
 155  *
 156  * @param array $params
 157  *   Array of parameters determined by getfields.
 158  */
 159 function _civicrm_api3_case_create_spec(&$params) {
 160   $params['contact_id'] = array(
 161     'api.aliases' => array('client_id'),
 162     'title' => 'Case Client',
 163     'description' => 'Contact id of case client(s)',
 164     'api.required' => 1,
 165     'type' => CRM_Utils_Type::T_INT,
 166     'FKApiName' => 'Contact',
 167   );
 168   $params['status_id']['api.default'] = 1;
 169   $params['status_id']['api.aliases'] = array('case_status');
 170   $params['creator_id']['api.default'] = 'user_contact_id';
 171   $params['creator_id']['type'] = CRM_Utils_Type::T_INT;
 172   $params['creator_id']['title'] = 'Case Created By';
 173   $params['start_date']['api.default'] = 'now';
 174   $params['medium_id'] = array(
 175     'name' => 'medium_id',
 176     'title' => 'Activity Medium',
 177     'type' => CRM_Utils_Type::T_INT,
 178   );
 179 }
 180
 181 /**
 182  * Adjust Metadata for Update action.
 183  *
 184  * @param array $params
 185  *   Array of parameters determined by getfields.
 186  */
 187 function _civicrm_api3_case_update_spec(&$params) {
 188   $params['id']['api.required'] = 1;
 189 }
 190
 191 /**
 192  * Adjust Metadata for Delete action.
 193  *
 194  * @param array $params
 195  *   Array of parameters determined by getfields.
 196  */
 197 function _civicrm_api3_case_delete_spec(&$params) {
 198   $params['id']['api.required'] = 1;
 199 }
 200
 201 /**
 202  * Get details of a particular case, or search for cases, depending on params.
 203  *
 204  * Please provide one (and only one) of the four get/search parameters:
 205  *
 206  * @param array $params
 207  *   'id' => if set, will get all available info about a case, including contacts and activities
 208  *
 209  *   // if no case_id provided, this function will use one of the following search parameters:
 210  *   'client_id' => finds all cases with a specific client
 211  *   'activity_id' => returns the case containing a specific activity
 212  *   'contact_id' => finds all cases associated with a contact (in any role, not just client)
 213  *
 214  * @throws API_Exception
 215  * @return array
 216  *   (get mode, case_id provided): Array with case details, case roles, case activity ids, (search mode, case_id not provided): Array of cases found
 217  */
 218 function civicrm_api3_case_get($params) {
 219   $options = _civicrm_api3_get_options_from_params($params);
 220   $sql = CRM_Utils_SQL_Select::fragment();
 221
 222   // Add clause to search by client
 223   if (!empty($params['contact_id'])) {
 224     $contacts = array();
 225     foreach ((array) $params['contact_id'] as $c) {
 226       if (!CRM_Utils_Rule::positiveInteger($c)) {
 227         throw new API_Exception('Invalid parameter: contact_id. Must provide numeric value(s).');
 228       }
 229       $contacts[] = $c;
 230     }
 231     $sql
 232       ->join('civicrm_case_contact', 'INNER JOIN civicrm_case_contact ON civicrm_case_contact.case_id = a.id')
 233       ->where('civicrm_case_contact.contact_id IN (' . implode(',', $contacts) . ')');
 234   }
 235
 236   // Add clause to search by activity
 237   if (!empty($params['activity_id'])) {
 238     if (!CRM_Utils_Rule::positiveInteger($params['activity_id'])) {
 239       throw new API_Exception('Invalid parameter: activity_id. Must provide a numeric value.');
 240     }
 241     $activityId = $params['activity_id'];
 242     $originalId = CRM_Core_DAO::getFieldValue('CRM_Activity_BAO_Activity', $activityId, 'original_id');
 243     if ($originalId) {
 244       $activityId .= ',' . $originalId;
 245     }
 246     $sql
 247       ->join('civicrm_case_activity', 'INNER JOIN civicrm_case_activity ON civicrm_case_activity.case_id = a.id')
 248       ->where("civicrm_case_activity.activity_id IN ($activityId)");
 249   }
 250
 251   // For historic reasons we always return these when an id is provided
 252   if (!empty($params['id'])) {
 253     $options['return'] = array('contacts' => 1, 'activities' => 1);
 254   }
 255
 256   $foundcases = _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params, TRUE, 'Case', $sql);
 257   $cases = array();
 258   foreach ($foundcases['values'] as $foundcase) {
 259     if ($case = _civicrm_api3_case_read($foundcase['id'], $options, !empty($params['check_permissions']))) {
 260       $cases[$foundcase['id']] = $case;
 261     }
 262   }
 263
 264   return civicrm_api3_create_success($cases, $params, 'Case', 'get');
 265 }
 266
 267 /**
 268  * Deprecated API.
 269  *
 270  * Use activity API instead.
 271  *
 272  * @param array $params
 273  *
 274  * @throws API_Exception
 275  * @return array
 276  */
 277 function civicrm_api3_case_activity_create($params) {
 278   require_once "api/v3/Activity.php";
 279   return civicrm_api3_activity_create($params) + array(
 280     'deprecated' => CRM_Utils_Array::value('activity_create', _civicrm_api3_case_deprecation()),
 281   );
 282 }
 283
 284 /**
 285  * Declare deprecated api functions.
 286  *
 287  * @deprecated api notice
 288  * @return array
 289  *   Array of deprecated actions
 290  */
 291 function _civicrm_api3_case_deprecation() {
 292   return array('activity_create' => 'Case api "activity_create" action is deprecated. Use the activity api instead.');
 293 }
 294
 295 /**
 296  * Update a specified case.
 297  *
 298  * @param array $params
 299  *   //REQUIRED:
 300  *   'case_id' => int
 301  *
 302  *   //OPTIONAL
 303  *   'status_id' => int
 304  *   'start_date' => str datestamp
 305  *   'contact_id' => int // case client
 306  *
 307  * @throws API_Exception
 308  * @return array
 309  *   api result array
 310  */
 311 function civicrm_api3_case_update($params) {
 312   //check parameters
 313   civicrm_api3_verify_mandatory($params, NULL, array('id'));
 314
 315   // return error if modifying creator id
 316   if (array_key_exists('creator_id', $params)) {
 317     throw new API_Exception(ts('You cannot update creator id'));
 318   }
 319
 320   $mCaseId = $origContactIds = array();
 321
 322   // get original contact id and creator id of case
 323   if (!empty($params['contact_id'])) {
 324     $origContactIds = CRM_Case_BAO_Case::retrieveContactIdsByCaseId($params['id']);
 325     $origContactId = $origContactIds[1];
 326   }
 327
 328   if (count($origContactIds) > 1) {
 329     // check valid orig contact id
 330     if (!empty($params['orig_contact_id']) && !in_array($params['orig_contact_id'], $origContactIds)) {
 331       throw new API_Exception('Invalid case contact id (orig_contact_id)');
 332     }
 333     elseif (empty($params['orig_contact_id'])) {
 334       throw new API_Exception('Case is linked with more than one contact id. Provide the required params orig_contact_id to be replaced');
 335     }
 336     $origContactId = $params['orig_contact_id'];
 337   }
 338
 339   // check for same contact id for edit Client
 340   if (!empty($params['contact_id']) && !in_array($params['contact_id'], $origContactIds)) {
 341     $mCaseId = CRM_Case_BAO_Case::mergeCases($params['contact_id'], $params['case_id'], $origContactId, NULL, TRUE);
 342   }
 343
 344   if (!empty($mCaseId[0])) {
 345     $params['id'] = $mCaseId[0];
 346   }
 347
 348   $dao = new CRM_Case_BAO_Case();
 349   $dao->id = $params['id'];
 350
 351   $dao->copyValues($params);
 352   $dao->save();
 353
 354   $case = array();
 355
 356   _civicrm_api3_object_to_array($dao, $case);
 357   $values[$dao->id] = $case;
 358
 359   return civicrm_api3_create_success($values, $params, 'Case', 'update', $dao);
 360 }
 361
 362 /**
 363  * Delete a specified case.
 364  *
 365  * @param array $params
 366  *
 367  * @code
 368  *   //REQUIRED:
 369  *   'id' => int
 370  *
 371  *   //OPTIONAL
 372  *   'move_to_trash' => bool (defaults to false)
 373  * @endcode
 374  *
 375  * @throws API_Exception
 376  * @return bool
 377  *   true if success, else false
 378  */
 379 function civicrm_api3_case_delete($params) {
 380   //check parameters
 381   civicrm_api3_verify_mandatory($params, NULL, array('id'));
 382
 383   if (CRM_Case_BAO_Case::deleteCase($params['id'], CRM_Utils_Array::value('move_to_trash', $params, FALSE))) {
 384     return civicrm_api3_create_success($params, $params, 'Case', 'delete');
 385   }
 386   else {
 387     throw new API_Exception('Could not delete case.');
 388   }
 389 }
 390
 391 /**
 392  * Internal function to retrieve a case.
 393  *
 394  * @param int $caseId
 395  *
 396  * @param array $options
 397  *
 398  * @param bool $checkPermission
 399  *
 400  * @return array
 401  *   case object
 402  */
 403 function _civicrm_api3_case_read($caseId, $options, $checkPermission) {
 404   $return = CRM_Utils_Array::value('return', $options, array());
 405   $dao = new CRM_Case_BAO_Case();
 406   $dao->id = $caseId;
 407   if ($dao->find(TRUE)) {
 408     $case = array();
 409     _civicrm_api3_object_to_array($dao, $case);
 410
 411     _civicrm_api3_custom_data_get($case, $checkPermission, 'Case', $caseId);
 412
 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 }