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_CaseContact::create($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   $foundcases = _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params, TRUE, 'Case', $sql);
 252
 253   if (empty($options['is_count'])) {
 254     // For historic reasons we return these by default only when fetching a case by id
 255     if (!empty($params['id']) && empty($options['return'])) {
 256       $options['return'] = array(
 257         'contacts' => 1,
 258         'activities' => 1,
 259         'contact_id' => 1,
 260       );
 261     }
 262
 263     foreach ($foundcases['values'] as &$case) {
 264       _civicrm_api3_case_read($case, $options);
 265     }
 266   }
 267
 268   return $foundcases;
 269 }
 270
 271 /**
 272  * Deprecated API.
 273  *
 274  * Use activity API instead.
 275  *
 276  * @param array $params
 277  *
 278  * @throws API_Exception
 279  * @return array
 280  */
 281 function civicrm_api3_case_activity_create($params) {
 282   require_once "api/v3/Activity.php";
 283   return civicrm_api3_activity_create($params) + array(
 284     'deprecated' => CRM_Utils_Array::value('activity_create', _civicrm_api3_case_deprecation()),
 285   );
 286 }
 287
 288 /**
 289  * Declare deprecated api functions.
 290  *
 291  * @deprecated api notice
 292  * @return array
 293  *   Array of deprecated actions
 294  */
 295 function _civicrm_api3_case_deprecation() {
 296   return array('activity_create' => 'Case api "activity_create" action is deprecated. Use the activity api instead.');
 297 }
 298
 299 /**
 300  * Update a specified case.
 301  *
 302  * @param array $params
 303  *   //REQUIRED:
 304  *   'case_id' => int
 305  *
 306  *   //OPTIONAL
 307  *   'status_id' => int
 308  *   'start_date' => str datestamp
 309  *   'contact_id' => int // case client
 310  *
 311  * @throws API_Exception
 312  * @return array
 313  *   api result array
 314  */
 315 function civicrm_api3_case_update($params) {
 316   //check parameters
 317   civicrm_api3_verify_mandatory($params, NULL, array('id'));
 318
 319   // return error if modifying creator id
 320   if (array_key_exists('creator_id', $params)) {
 321     throw new API_Exception(ts('You cannot update creator id'));
 322   }
 323
 324   $mCaseId = $origContactIds = array();
 325
 326   // get original contact id and creator id of case
 327   if (!empty($params['contact_id'])) {
 328     $origContactIds = CRM_Case_BAO_Case::retrieveContactIdsByCaseId($params['id']);
 329     $origContactId = $origContactIds[1];
 330   }
 331
 332   if (count($origContactIds) > 1) {
 333     // check valid orig contact id
 334     if (!empty($params['orig_contact_id']) && !in_array($params['orig_contact_id'], $origContactIds)) {
 335       throw new API_Exception('Invalid case contact id (orig_contact_id)');
 336     }
 337     elseif (empty($params['orig_contact_id'])) {
 338       throw new API_Exception('Case is linked with more than one contact id. Provide the required params orig_contact_id to be replaced');
 339     }
 340     $origContactId = $params['orig_contact_id'];
 341   }
 342
 343   // check for same contact id for edit Client
 344   if (!empty($params['contact_id']) && !in_array($params['contact_id'], $origContactIds)) {
 345     $mCaseId = CRM_Case_BAO_Case::mergeCases($params['contact_id'], $params['case_id'], $origContactId, NULL, TRUE);
 346   }
 347
 348   if (!empty($mCaseId[0])) {
 349     $params['id'] = $mCaseId[0];
 350   }
 351
 352   $dao = new CRM_Case_BAO_Case();
 353   $dao->id = $params['id'];
 354
 355   $dao->copyValues($params);
 356   $dao->save();
 357
 358   $case = array();
 359   _civicrm_api3_object_to_array($dao, $case);
 360
 361   return civicrm_api3_create_success(array($dao->id => $case), $params, 'Case', 'update', $dao);
 362 }
 363
 364 /**
 365  * Delete a specified case.
 366  *
 367  * @param array $params
 368  *
 369  * @code
 370  *   //REQUIRED:
 371  *   'id' => int
 372  *
 373  *   //OPTIONAL
 374  *   'move_to_trash' => bool (defaults to false)
 375  * @endcode
 376  *
 377  * @throws API_Exception
 378  * @return bool
 379  *   true if success, else false
 380  */
 381 function civicrm_api3_case_delete($params) {
 382   //check parameters
 383   civicrm_api3_verify_mandatory($params, NULL, array('id'));
 384
 385   if (CRM_Case_BAO_Case::deleteCase($params['id'], CRM_Utils_Array::value('move_to_trash', $params, FALSE))) {
 386     return civicrm_api3_create_success($params, $params, 'Case', 'delete');
 387   }
 388   else {
 389     throw new API_Exception('Could not delete case.');
 390   }
 391 }
 392
 393 /**
 394  * Augment a case with extra data.
 395  *
 396  * @param array $case
 397  * @param array $options
 398  */
 399 function _civicrm_api3_case_read(&$case, $options) {
 400   if (empty($options['return']) || !empty($options['return']['contact_id'])) {
 401     // Legacy support for client_id - TODO: in apiv4 remove 'client_id'
 402     $case['client_id'] = $case['contact_id'] = CRM_Case_BAO_Case::retrieveContactIdsByCaseId($case['id']);
 403   }
 404   if (!empty($options['return']['contacts'])) {
 405     //get case contacts
 406     $contacts = CRM_Case_BAO_Case::getcontactNames($case['id']);
 407     $relations = CRM_Case_BAO_Case::getRelatedContacts($case['id']);
 408     $case['contacts'] = array_merge($contacts, $relations);
 409   }
 410   if (!empty($options['return']['activities'])) {
 411     //get case activities
 412     $case['activities'] = array();
 413     $query = "SELECT activity_id FROM civicrm_case_activity WHERE case_id = %1";
 414     $dao = CRM_Core_DAO::executeQuery($query, array(1 => array($case['id'], 'Integer')));
 415     while ($dao->fetch()) {
 416       $case['activities'][] = $dao->activity_id;
 417     }
 418   }
 419 }
 420
 421 /**
 422  * Internal function to format create params for processing.
 423  *
 424  * @param array $params
 425  */
 426 function _civicrm_api3_case_format_params(&$params) {
 427   // figure out case type id from case type and vice-versa
 428   $caseTypes = CRM_Case_PseudoConstant::caseType('name', FALSE);
 429   if (empty($params['case_type_id'])) {
 430     $params['case_type_id'] = array_search($params['case_type'], $caseTypes);
 431
 432     // DEPRECATED: lookup by label for backward compatibility
 433     if (!$params['case_type_id']) {
 434       $caseTypeLabels = CRM_Case_PseudoConstant::caseType('title', FALSE);
 435       $params['case_type_id'] = array_search($params['case_type'], $caseTypeLabels);
 436       $params['case_type'] = $caseTypes[$params['case_type_id']];
 437     }
 438   }
 439   elseif (empty($params['case_type'])) {
 440     $params['case_type'] = $caseTypes[$params['case_type_id']];
 441   }
 442 }
 443
 444 /**
 445  * It actually works a lot better to use the CaseContact api instead of the Case api
 446  * for entityRef fields so we can perform the necessary joins,
 447  * so we pass off getlist requests to the CaseContact api.
 448  *
 449  * @param array $params
 450  * @return mixed
 451  */
 452 function civicrm_api3_case_getList($params) {
 453   require_once 'api/v3/Generic/Getlist.php';
 454   require_once 'api/v3/CaseContact.php';
 455   $params['id_field'] = 'case_id';
 456   $params['label_field'] = $params['search_field'] = 'contact_id.sort_name';
 457   $params['description_field'] = array(
 458     'case_id',
 459     'case_id.case_type_id.title',
 460     'case_id.subject',
 461     'case_id.status_id',
 462     'case_id.start_date',
 463   );
 464   $apiRequest = array(
 465     'entity' => 'CaseContact',
 466     'action' => 'getlist',
 467     'params' => $params,
 468   );
 469   return civicrm_api3_generic_getList($apiRequest);
 470 }
 471
 472 /**
 473  * Needed due to the above override
 474  * @param $params
 475  * @param $apiRequest
 476  */
 477 function _civicrm_api3_case_getlist_spec(&$params, $apiRequest) {
 478   require_once 'api/v3/Generic/Getlist.php';
 479   _civicrm_api3_generic_getlist_spec($params, $apiRequest);
 480 }