api/v3/Case.php

   1 <?php
   2
   3 /*
   4   +--------------------------------------------------------------------+
   5   | CiviCRM version 4.5                                                |
   6   +--------------------------------------------------------------------+
   7   | Copyright CiviCRM LLC (c) 2004-2014                                |
   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-2014
  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 array (get mode, case_id provided): Array with case details, case roles, case activity ids, (search mode, case_id not provided): Array of cases found@access public
 189  * @todo Erik Hommel 16 dec 2010 check if all DB fields are returned
 190  */
 191 function civicrm_api3_case_get($params) {
 192   $options = _civicrm_api3_get_options_from_params($params);
 193   //search by client
 194   if (!empty($params['contact_id'])) {
 195     $ids = array();
 196     foreach ((array) $params['contact_id'] as $cid) {
 197       if (is_numeric($cid)) {
 198         $ids = array_merge($ids, CRM_Case_BAO_Case::retrieveCaseIdsByContactId($cid, TRUE));
 199       }
 200     }
 201     $cases = array();
 202     foreach ($ids as $id) {
 203       if ($case = _civicrm_api3_case_read($id, $options)) {
 204         $cases[$id] = $case;
 205       }
 206     }
 207     return civicrm_api3_create_success($cases, $params, 'case', 'get');
 208   }
 209
 210   //search by activity
 211   if (!empty($params['activity_id'])) {
 212     if (!is_numeric($params['activity_id'])) {
 213       return civicrm_api3_create_error('Invalid parameter: activity_id. Must provide a numeric value.');
 214     }
 215     $caseId = CRM_Case_BAO_Case::getCaseIdByActivityId($params['activity_id']);
 216     if (!$caseId) {
 217       return civicrm_api3_create_success(array(), $params, 'case', 'get');
 218     }
 219     $case = array($caseId => _civicrm_api3_case_read($caseId, $options));
 220     return civicrm_api3_create_success($case, $params, 'case', 'get');
 221   }
 222
 223   //search by contacts
 224   if ($contact = CRM_Utils_Array::value('contact_id', $params)) {
 225     if (!is_numeric($contact)) {
 226       return civicrm_api3_create_error('Invalid parameter: contact_id.  Must provide a numeric value.');
 227     }
 228
 229     $sql = "
 230 SELECT DISTINCT case_id
 231   FROM civicrm_relationship
 232  WHERE (contact_id_a = $contact
 233     OR contact_id_b = $contact)
 234    AND case_id IS NOT NULL";
 235     $dao = &CRM_Core_DAO::executeQuery($sql);
 236
 237     $cases = array();
 238     while ($dao->fetch()) {
 239       $cases[$dao->case_id] = _civicrm_api3_case_read($dao->case_id, $options);
 240     }
 241     return civicrm_api3_create_success($cases, $params, 'case', 'get');
 242   }
 243
 244   // For historic reasons we always return these when an id is provided
 245   $caseId = CRM_Utils_Array::value('id', $params);
 246   if ($caseId) {
 247     $options['return'] = array('contacts' => 1, 'activities' => 1);
 248   }
 249
 250   $foundcases =  _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params, TRUE, 'Case');
 251   $cases = array();
 252   foreach ($foundcases['values'] as $foundcase) {
 253       if ($case = _civicrm_api3_case_read($foundcase['id'], $options)) {
 254         $cases[$foundcase['id']] = $case;
 255       }
 256     }
 257
 258   return civicrm_api3_create_success($cases, $params, 'case', 'get');
 259 }
 260
 261 /**
 262  * Deprecated. Use activity API instead
 263  */
 264 function civicrm_api3_case_activity_create($params) {
 265   return civicrm_api3_activity_create($params);
 266 }
 267
 268 /**
 269  * Update a specified case.
 270  *
 271  * @param  array(
 272     //REQUIRED:
 273  * 'case_id' => int
 274  *
 275  * //OPTIONAL
 276  * 'status_id' => int
 277  * 'start_date' => str datestamp
 278  * 'contact_id' => int // case client
 279  *
 280  * @return Updated case
 281  *
 282  * @access public
 283  *
 284  */
 285 function civicrm_api3_case_update($params) {
 286   //check parameters
 287   civicrm_api3_verify_mandatory($params, NULL, array('id'));
 288
 289   // return error if modifing creator id
 290   if (array_key_exists('creator_id', $params)) {
 291     return civicrm_api3_create_error(ts('You cannot update creator id'));
 292   }
 293
 294   $mCaseId = array();
 295   $origContactIds = array();
 296
 297   // get original contact id and creator id of case
 298   if (!empty($params['contact_id'])) {
 299     $origContactIds = CRM_Case_BAO_Case::retrieveContactIdsByCaseId($params['id']);
 300     $origContactId = $origContactIds[1];
 301   }
 302
 303   if (count($origContactIds) > 1) {
 304     // check valid orig contact id
 305     if (!empty($params['orig_contact_id']) && !in_array($params['orig_contact_id'], $origContactIds)) {
 306       return civicrm_api3_create_error('Invalid case contact id (orig_contact_id)');
 307     }
 308     elseif (empty($params['orig_contact_id'])) {
 309       return civicrm_api3_create_error('Case is linked with more than one contact id. Provide the required params orig_contact_id to be replaced');
 310     }
 311     $origContactId = $params['orig_contact_id'];
 312   }
 313
 314   // check for same contact id for edit Client
 315   if (!empty($params['contact_id']) && !in_array($params['contact_id'], $origContactIds)) {
 316     $mCaseId = CRM_Case_BAO_Case::mergeCases($params['contact_id'], $params['case_id'], $origContactId, NULL, TRUE);
 317   }
 318
 319   if (!empty($mCaseId[0])) {
 320     $params['id'] = $mCaseId[0];
 321   }
 322
 323   $dao = new CRM_Case_BAO_Case();
 324   $dao->id = $params['id'];
 325
 326   $dao->copyValues($params);
 327   $dao->save();
 328
 329   $case = array();
 330
 331   _civicrm_api3_object_to_array($dao, $case);
 332
 333   return civicrm_api3_create_success($case, $params, 'case', 'update', $dao);
 334 }
 335
 336 /**
 337  * Delete a specified case.
 338  *
 339  * @param  array(
 340     //REQUIRED:
 341  * 'id' => int
 342  *
 343  * //OPTIONAL
 344  * 'move_to_trash' => bool (defaults to false)
 345  *
 346  * @return boolean: true if success, else false
 347  * {@getfields case_delete}
 348  * @access public
 349  */
 350 function civicrm_api3_case_delete($params) {
 351   //check parameters
 352   civicrm_api3_verify_mandatory($params, NULL, array('id'));
 353
 354   if (CRM_Case_BAO_Case::deleteCase($params['id'], CRM_Utils_Array::value('move_to_trash', $params, FALSE))) {
 355     return civicrm_api3_create_success($params, $params, 'case', 'delete');
 356   }
 357   else {
 358     return civicrm_api3_create_error('Could not delete case.');
 359   }
 360 }
 361
 362 /***********************************/
 363 /*                                 */
 364 /*     INTERNAL FUNCTIONS          */
 365 /*                                 */
 366 /***********************************/
 367
 368 /**
 369  * Internal function to retrieve a case.
 370  *
 371  * @param int $caseId
 372  *
 373  * @return array (reference) case object
 374  *
 375  */
 376 function _civicrm_api3_case_read($caseId, $options) {
 377   $return = CRM_Utils_Array::value('return', $options, array());
 378   $dao = new CRM_Case_BAO_Case();
 379   $dao->id = $caseId;
 380   if ($dao->find(TRUE)) {
 381     $case = array();
 382     _civicrm_api3_object_to_array($dao, $case);
 383     // Legacy support for client_id - TODO: in apiv4 remove 'client_id'
 384     $case['client_id'] = $case['contact_id'] = $dao->retrieveContactIdsByCaseId($caseId);
 385
 386     //handle multi-value case type
 387     $sep = CRM_Core_DAO::VALUE_SEPARATOR;
 388     $case['case_type_id'] = trim(str_replace($sep, ',', $case['case_type_id']), ',');
 389
 390     if (!empty($return['contacts'])) {
 391       //get case contacts
 392       $contacts = CRM_Case_BAO_Case::getcontactNames($caseId);
 393       $relations = CRM_Case_BAO_Case::getRelatedContacts($caseId);
 394       $case['contacts'] = array_merge($contacts, $relations);
 395     }
 396     if (!empty($return['activities'])) {
 397       //get case activities
 398       $case['activities'] = array();
 399       $query = "SELECT activity_id FROM civicrm_case_activity WHERE case_id = $caseId";
 400       $dao = CRM_Core_DAO::executeQuery($query);
 401       while ($dao->fetch()) {
 402         $case['activities'][] = $dao->activity_id;
 403       }
 404     }
 405     return $case;
 406   }
 407 }
 408
 409 /**
 410  * Internal function to format create params for processing
 411  */
 412 function _civicrm_api3_case_format_params(&$params) {
 413   if (!array_key_exists('creator_id', $params)) {
 414     $session = CRM_Core_Session::singleton();
 415     $params['creator_id'] = $session->get('userID');
 416   }
 417   if (empty($params['start_date'])) {
 418     $params['start_date'] = date('YmdHis');
 419   }
 420   // figure out case type id from case type and vice-versa
 421   $caseTypes = CRM_Case_PseudoConstant::caseType('label', FALSE);
 422   if (empty($params['case_type_id'])) {
 423     $params['case_type_id'] = array_search($params['case_type'], $caseTypes);
 424   }
 425   elseif (empty($params['case_type'])) {
 426     $params['case_type'] = $caseTypes[$params['case_type_id']];
 427   }
 428   // format input with value separators
 429   $sep = CRM_Core_DAO::VALUE_SEPARATOR;
 430   $params['case_type_id'] = $sep . implode($sep, (array) $params['case_type_id']) . $sep;
 431 }