api/v3/Case.php

   1 <?php
   2 /*
   3   +--------------------------------------------------------------------+
   4   | CiviCRM version 4.7                                                |
   5   +--------------------------------------------------------------------+
   6   | Copyright CiviCRM LLC (c) 2004-2017                                |
   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   );
 144   $params['activity_id'] = array(
 145     'title' => 'Case Activity',
 146     'description' => 'Id of an activity in the case',
 147     'type' => CRM_Utils_Type::T_INT,
 148   );
 149   $params['tag_id'] = array(
 150     'title' => 'Tags',
 151     'description' => 'Find activities with specified tags.',
 152     'type' => 1,
 153     'FKClassName' => 'CRM_Core_DAO_Tag',
 154     'FKApiName' => 'Tag',
 155     'supports_joins' => TRUE,
 156   );
 157 }
 158
 159 /**
 160  * Adjust Metadata for Create Action.
 161  *
 162  * @param array $params
 163  *   Array of parameters determined by getfields.
 164  */
 165 function _civicrm_api3_case_create_spec(&$params) {
 166   $params['contact_id'] = array(
 167     'api.aliases' => array('client_id'),
 168     'title' => 'Case Client',
 169     'description' => 'Contact id of case client(s)',
 170     'api.required' => 1,
 171     'type' => CRM_Utils_Type::T_INT,
 172   );
 173   $params['status_id']['api.default'] = 1;
 174   $params['status_id']['api.aliases'] = array('case_status');
 175   $params['creator_id']['api.default'] = 'user_contact_id';
 176   $params['creator_id']['type'] = CRM_Utils_Type::T_INT;
 177   $params['creator_id']['title'] = 'Case Created By';
 178   $params['start_date']['api.default'] = 'now';
 179   $params['medium_id'] = array(
 180     'name' => 'medium_id',
 181     'title' => 'Activity Medium',
 182     'type' => CRM_Utils_Type::T_INT,
 183   );
 184 }
 185
 186 /**
 187  * Adjust Metadata for Update action.
 188  *
 189  * @param array $params
 190  *   Array of parameters determined by getfields.
 191  */
 192 function _civicrm_api3_case_update_spec(&$params) {
 193   $params['id']['api.required'] = 1;
 194 }
 195
 196 /**
 197  * Adjust Metadata for Delete action.
 198  *
 199  * @param array $params
 200  *   Array of parameters determined by getfields.
 201  */
 202 function _civicrm_api3_case_delete_spec(&$params) {
 203   $params['id']['api.required'] = 1;
 204 }
 205
 206 /**
 207  * Get details of a particular case, or search for cases, depending on params.
 208  *
 209  * Please provide one (and only one) of the four get/search parameters:
 210  *
 211  * @param array $params
 212  *   'id' => if set, will get all available info about a case, including contacts and activities
 213  *
 214  *   // if no case_id provided, this function will use one of the following search parameters:
 215  *   'client_id' => finds all cases with a specific client
 216  *   'activity_id' => returns the case containing a specific activity
 217  *   'contact_id' => finds all cases associated with a contact (in any role, not just client)
 218  * $params CRM_Utils_SQL_Select $sql
 219  *   Other apis wishing to wrap & extend this one can pass in a $sql object with extra clauses
 220  *
 221  * @throws API_Exception
 222  * @return array
 223  *   (get mode, case_id provided): Array with case details, case roles, case activity ids, (search mode, case_id not provided): Array of cases found
 224  */
 225 function civicrm_api3_case_get($params, $sql = NULL) {
 226   $options = _civicrm_api3_get_options_from_params($params);
 227   if (!is_a($sql, 'CRM_Utils_SQL_Select')) {
 228     $sql = CRM_Utils_SQL_Select::fragment();
 229   }
 230
 231   // Add clause to search by client
 232   if (!empty($params['contact_id'])) {
 233     // Legacy support - this field historically supports a nonstandard format of array(1,2,3) as a synonym for array('IN' => array(1,2,3))
 234     if (is_array($params['contact_id'])) {
 235       $operator = CRM_Utils_Array::first(array_keys($params['contact_id']));
 236       if (!in_array($operator, \CRM_Core_DAO::acceptedSQLOperators(), TRUE)) {
 237         $params['contact_id'] = array('IN' => $params['contact_id']);
 238       }
 239     }
 240     else {
 241       $params['contact_id'] = array('=' => $params['contact_id']);
 242     }
 243     $clause = CRM_Core_DAO::createSQLFilter('contact_id', $params['contact_id']);
 244     $sql->where("a.id IN (SELECT case_id FROM civicrm_case_contact WHERE $clause)");
 245   }
 246
 247   // Order by case contact (primary client)
 248   // Ex: "contact_id", "contact_id.display_name", "contact_id.sort_name DESC".
 249   if (!empty($options['sort']) && strpos($options['sort'], 'contact_id') !== FALSE) {
 250     $sort = explode(', ', $options['sort']);
 251     $contactSort = NULL;
 252     foreach ($sort as $index => &$sortString) {
 253       if (strpos($sortString, 'contact_id') === 0) {
 254         $contactSort = $sortString;
 255         $sortString = '(1)';
 256         // Get sort field and direction
 257         list($sortField, $dir) = array_pad(explode(' ', $contactSort), 2, 'ASC');
 258         list(, $sortField) = array_pad(explode('.', $sortField), 2, 'id');
 259         // Validate inputs
 260         if (!array_key_exists($sortField, CRM_Contact_DAO_Contact::fieldKeys()) || ($dir != 'ASC' && $dir != 'DESC')) {
 261           throw new API_Exception("Unknown field specified for sort. Cannot order by '$contactSort'");
 262         }
 263         $sql->orderBy("case_contact.$sortField $dir", NULL, $index);
 264       }
 265     }
 266     // Remove contact sort params so the basic_get function doesn't see them
 267     $params['options']['sort'] = implode(', ', $sort);
 268     unset($params['option_sort'], $params['option.sort'], $params['sort']);
 269     // Add necessary joins to the first case client
 270     if ($contactSort) {
 271       $sql->join('ccc', 'LEFT JOIN (SELECT * FROM civicrm_case_contact WHERE id IN (SELECT MIN(id) FROM civicrm_case_contact GROUP BY case_id)) AS ccc ON ccc.case_id = a.id');
 272       $sql->join('case_contact', 'LEFT JOIN civicrm_contact AS case_contact ON ccc.contact_id = case_contact.id AND case_contact.is_deleted <> 1');
 273     }
 274   }
 275
 276   // Add clause to search by activity
 277   if (!empty($params['activity_id'])) {
 278     if (!CRM_Utils_Rule::positiveInteger($params['activity_id'])) {
 279       throw new API_Exception('Invalid parameter: activity_id. Must provide a numeric value.');
 280     }
 281     $activityId = $params['activity_id'];
 282     $originalId = CRM_Core_DAO::getFieldValue('CRM_Activity_BAO_Activity', $activityId, 'original_id');
 283     if ($originalId) {
 284       $activityId .= ',' . $originalId;
 285     }
 286     $sql
 287       ->join('civicrm_case_activity', 'INNER JOIN civicrm_case_activity ON civicrm_case_activity.case_id = a.id')
 288       ->where("civicrm_case_activity.activity_id IN ($activityId)");
 289   }
 290
 291   // Clause to search by tag
 292   if (!empty($params['tag_id'])) {
 293     $dummySpec = array();
 294     _civicrm_api3_validate_integer($params, 'tag_id', $dummySpec, 'Case');
 295     if (!is_array($params['tag_id'])) {
 296       $params['tag_id'] = array('=' => $params['tag_id']);
 297     }
 298     $clause = \CRM_Core_DAO::createSQLFilter('tag_id', $params['tag_id']);
 299     if ($clause) {
 300       $sql->where('a.id IN (SELECT entity_id FROM civicrm_entity_tag WHERE entity_table = "civicrm_case" AND !clause)', array('!clause' => $clause));
 301     }
 302   }
 303
 304   $cases = _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), array('sequential' => 0) + $params, TRUE, 'Case', $sql);
 305
 306   if (empty($options['is_count']) && !empty($cases['values'])) {
 307     // For historic reasons we return these by default only when fetching a case by id
 308     if (!empty($params['id']) && is_numeric($params['id']) && empty($options['return'])) {
 309       $options['return'] = array(
 310         'contacts' => 1,
 311         'activities' => 1,
 312         'contact_id' => 1,
 313       );
 314     }
 315
 316     _civicrm_api3_case_read($cases['values'], $options);
 317
 318     // We disabled sequential to keep the list indexed for case_read(). Now add it back.
 319     if (!empty($params['sequential'])) {
 320       $cases['values'] = array_values($cases['values']);
 321     }
 322   }
 323
 324   return $cases;
 325 }
 326
 327 /**
 328  * Deprecated API.
 329  *
 330  * Use activity API instead.
 331  *
 332  * @param array $params
 333  *
 334  * @throws API_Exception
 335  * @return array
 336  */
 337 function civicrm_api3_case_activity_create($params) {
 338   require_once "api/v3/Activity.php";
 339   return civicrm_api3_activity_create($params) + array(
 340     'deprecated' => CRM_Utils_Array::value('activity_create', _civicrm_api3_case_deprecation()),
 341   );
 342 }
 343
 344 /**
 345  * Add a timeline to a case.
 346  *
 347  * @param array $params
 348  *
 349  * @throws API_Exception
 350  * @return array
 351  */
 352 function civicrm_api3_case_addtimeline($params) {
 353   $caseType = CRM_Case_BAO_Case::getCaseType($params['case_id'], 'name');
 354   $xmlProcessor = new CRM_Case_XMLProcessor_Process();
 355   $xmlProcessorParams = array(
 356     'clientID' => CRM_Case_BAO_Case::getCaseClients($params['case_id']),
 357     'creatorID' => $params['creator_id'],
 358     'standardTimeline' => 0,
 359     'activity_date_time' => $params['activity_date_time'],
 360     'caseID' => $params['case_id'],
 361     'caseType' => $caseType,
 362     'activitySetName' => $params['timeline'],
 363   );
 364   $xmlProcessor->run($caseType, $xmlProcessorParams);
 365   return civicrm_api3_create_success();
 366 }
 367
 368 /**
 369  * Adjust Metadata for addtimeline action.
 370  *
 371  * @param array $params
 372  *   Array of parameters determined by getfields.
 373  */
 374 function _civicrm_api3_case_addtimeline_spec(&$params) {
 375   $params['case_id'] = array(
 376     'title' => 'Case ID',
 377     'description' => 'Id of case to update',
 378     'type' => CRM_Utils_Type::T_INT,
 379     'api.required' => 1,
 380   );
 381   $params['timeline'] = array(
 382     'title' => 'Timeline',
 383     'description' => 'Name of activity set',
 384     'type' => CRM_Utils_Type::T_STRING,
 385     'api.required' => 1,
 386   );
 387   $params['activity_date_time'] = array(
 388     'api.default' => 'now',
 389     'title' => 'Activity date time',
 390     'description' => 'Timeline start date',
 391     'type' => CRM_Utils_Type::T_DATE,
 392   );
 393   $params['creator_id'] = array(
 394     'api.default' => 'user_contact_id',
 395     'title' => 'Activity creator',
 396     'description' => 'Contact id of timeline creator',
 397     'type' => CRM_Utils_Type::T_INT,
 398   );
 399 }
 400
 401 /**
 402  * Declare deprecated api functions.
 403  *
 404  * @deprecated api notice
 405  * @return array
 406  *   Array of deprecated actions
 407  */
 408 function _civicrm_api3_case_deprecation() {
 409   return array('activity_create' => 'Case api "activity_create" action is deprecated. Use the activity api instead.');
 410 }
 411
 412 /**
 413  * Update a specified case.
 414  *
 415  * @param array $params
 416  *   //REQUIRED:
 417  *   'case_id' => int
 418  *
 419  *   //OPTIONAL
 420  *   'status_id' => int
 421  *   'start_date' => str datestamp
 422  *   'contact_id' => int // case client
 423  *
 424  * @throws API_Exception
 425  * @return array
 426  *   api result array
 427  */
 428 function civicrm_api3_case_update($params) {
 429   if (!isset($params['case_id']) && isset($params['id'])) {
 430     $params['case_id'] = $params['id'];
 431   }
 432
 433   //check parameters
 434   civicrm_api3_verify_mandatory($params, NULL, array('id'));
 435
 436   // return error if modifying creator id
 437   if (array_key_exists('creator_id', $params)) {
 438     throw new API_Exception(ts('You cannot update creator id'));
 439   }
 440
 441   $mCaseId = $origContactIds = array();
 442
 443   // get original contact id and creator id of case
 444   if (!empty($params['contact_id'])) {
 445     $origContactIds = CRM_Case_BAO_Case::retrieveContactIdsByCaseId($params['id']);
 446     $origContactId = $origContactIds[1];
 447   }
 448
 449   if (count($origContactIds) > 1) {
 450     // check valid orig contact id
 451     if (!empty($params['orig_contact_id']) && !in_array($params['orig_contact_id'], $origContactIds)) {
 452       throw new API_Exception('Invalid case contact id (orig_contact_id)');
 453     }
 454     elseif (empty($params['orig_contact_id'])) {
 455       throw new API_Exception('Case is linked with more than one contact id. Provide the required params orig_contact_id to be replaced');
 456     }
 457     $origContactId = $params['orig_contact_id'];
 458   }
 459
 460   // check for same contact id for edit Client
 461   if (!empty($params['contact_id']) && !in_array($params['contact_id'], $origContactIds)) {
 462     $mCaseId = CRM_Case_BAO_Case::mergeCases($params['contact_id'], $params['case_id'], $origContactId, NULL, TRUE);
 463   }
 464
 465   if (!empty($mCaseId[0])) {
 466     $params['id'] = $mCaseId[0];
 467   }
 468
 469   $dao = new CRM_Case_BAO_Case();
 470   $dao->id = $params['id'];
 471
 472   $dao->copyValues($params);
 473   $dao->save();
 474
 475   $case = array();
 476   _civicrm_api3_object_to_array($dao, $case);
 477
 478   return civicrm_api3_create_success(array($dao->id => $case), $params, 'Case', 'update', $dao);
 479 }
 480
 481 /**
 482  * Delete a specified case.
 483  *
 484  * @param array $params
 485  *
 486  * @code
 487  *   //REQUIRED:
 488  *   'id' => int
 489  *
 490  *   //OPTIONAL
 491  *   'move_to_trash' => bool (defaults to false)
 492  * @endcode
 493  *
 494  * @throws API_Exception
 495  * @return bool
 496  *   true if success, else false
 497  */
 498 function civicrm_api3_case_delete($params) {
 499   //check parameters
 500   civicrm_api3_verify_mandatory($params, NULL, array('id'));
 501
 502   if (CRM_Case_BAO_Case::deleteCase($params['id'], CRM_Utils_Array::value('move_to_trash', $params, FALSE))) {
 503     return civicrm_api3_create_success($params, $params, 'Case', 'delete');
 504   }
 505   else {
 506     throw new API_Exception('Could not delete case.');
 507   }
 508 }
 509
 510 /**
 511  * Augment case results with extra data.
 512  *
 513  * @param array $cases
 514  * @param array $options
 515  */
 516 function _civicrm_api3_case_read(&$cases, $options) {
 517   foreach ($cases as &$case) {
 518     if (empty($options['return']) || !empty($options['return']['contact_id'])) {
 519       // Legacy support for client_id - TODO: in apiv4 remove 'client_id'
 520       $case['client_id'] = $case['contact_id'] = CRM_Case_BAO_Case::retrieveContactIdsByCaseId($case['id']);
 521     }
 522     if (!empty($options['return']['contacts'])) {
 523       //get case contacts
 524       $contacts = CRM_Case_BAO_Case::getcontactNames($case['id']);
 525       $relations = CRM_Case_BAO_Case::getRelatedContacts($case['id']);
 526       $case['contacts'] = array_unique(array_merge($contacts, $relations), SORT_REGULAR);
 527     }
 528     if (!empty($options['return']['activities'])) {
 529       // add case activities array - we'll populate them in bulk below
 530       $case['activities'] = array();
 531     }
 532     // Properly render this joined field
 533     if (!empty($options['return']['case_type_id.definition'])) {
 534       if (!empty($case['case_type_id.definition'])) {
 535         list($xml) = CRM_Utils_XML::parseString($case['case_type_id.definition']);
 536       }
 537       else {
 538         $caseTypeId = !empty($case['case_type_id']) ? $case['case_type_id'] : CRM_Core_DAO::getFieldValue('CRM_Case_DAO_Case', $case['id'], 'case_type_id');
 539         $caseTypeName = !empty($case['case_type_id.name']) ? $case['case_type_id.name'] : CRM_Core_DAO::getFieldValue('CRM_Case_DAO_CaseType', $caseTypeId, 'name');
 540         $xml = CRM_Case_XMLRepository::singleton()->retrieve($caseTypeName);
 541       }
 542       $case['case_type_id.definition'] = array();
 543       if ($xml) {
 544         $case['case_type_id.definition'] = CRM_Case_BAO_CaseType::convertXmlToDefinition($xml);
 545       }
 546     }
 547   }
 548   // Bulk-load activities
 549   if (!empty($options['return']['activities'])) {
 550     $query = "SELECT case_id, activity_id FROM civicrm_case_activity WHERE case_id IN (%1)";
 551     $params = array(1 => array(implode(',', array_keys($cases)), 'String', CRM_Core_DAO::QUERY_FORMAT_NO_QUOTES));
 552     $dao = CRM_Core_DAO::executeQuery($query, $params);
 553     while ($dao->fetch()) {
 554       $cases[$dao->case_id]['activities'][] = $dao->activity_id;
 555     }
 556   }
 557   // Bulk-load tags. Supports joins onto the tag entity.
 558   $tagGet = array('tag_id', 'entity_id');
 559   foreach (array_keys($options['return']) as $key) {
 560     if (strpos($key, 'tag_id.') === 0) {
 561       $tagGet[] = $key;
 562       $options['return']['tag_id'] = 1;
 563     }
 564   }
 565   if (!empty($options['return']['tag_id'])) {
 566     $tags = civicrm_api3('EntityTag', 'get', array(
 567       'entity_table' => 'civicrm_case',
 568       'entity_id' => array('IN' => array_keys($cases)),
 569       'return' => $tagGet,
 570       'options' => array('limit' => 0),
 571     ));
 572     foreach ($tags['values'] as $tag) {
 573       $key = (int) $tag['entity_id'];
 574       unset($tag['entity_id'], $tag['id']);
 575       $cases[$key]['tag_id'][$tag['tag_id']] = $tag;
 576     }
 577   }
 578 }
 579
 580 /**
 581  * Internal function to format create params for processing.
 582  *
 583  * @param array $params
 584  */
 585 function _civicrm_api3_case_format_params(&$params) {
 586   // figure out case type id from case type and vice-versa
 587   $caseTypes = CRM_Case_PseudoConstant::caseType('name', FALSE);
 588   if (empty($params['case_type_id'])) {
 589     $params['case_type_id'] = array_search($params['case_type'], $caseTypes);
 590
 591     // DEPRECATED: lookup by label for backward compatibility
 592     if (!$params['case_type_id']) {
 593       $caseTypeLabels = CRM_Case_PseudoConstant::caseType('title', FALSE);
 594       $params['case_type_id'] = array_search($params['case_type'], $caseTypeLabels);
 595       $params['case_type'] = $caseTypes[$params['case_type_id']];
 596     }
 597   }
 598   elseif (empty($params['case_type'])) {
 599     $params['case_type'] = $caseTypes[$params['case_type_id']];
 600   }
 601 }
 602
 603 /**
 604  * It actually works a lot better to use the CaseContact api instead of the Case api
 605  * for entityRef fields so we can perform the necessary joins,
 606  * so we pass off getlist requests to the CaseContact api.
 607  *
 608  * @param array $params
 609  * @return mixed
 610  */
 611 function civicrm_api3_case_getList($params) {
 612   require_once 'api/v3/Generic/Getlist.php';
 613   require_once 'api/v3/CaseContact.php';
 614   //CRM:19956 - Assign case_id param if both id and case_id is passed to retrieve the case
 615   if (!empty($params['id']) && !empty($params['params']) && !empty($params['params']['case_id'])) {
 616     $params['params']['case_id'] = array('IN' => $params['id']);
 617     unset($params['id']);
 618   }
 619   $params['id_field'] = 'case_id';
 620   $params['label_field'] = $params['search_field'] = 'contact_id.sort_name';
 621   $params['description_field'] = array(
 622     'case_id',
 623     'case_id.case_type_id.title',
 624     'case_id.subject',
 625     'case_id.status_id',
 626     'case_id.start_date',
 627   );
 628   $apiRequest = array(
 629     'version' => 3,
 630     'entity' => 'CaseContact',
 631     'action' => 'getlist',
 632     'params' => $params,
 633   );
 634   return civicrm_api3_generic_getList($apiRequest);
 635 }
 636
 637 /**
 638  * Needed due to the above override
 639  * @param $params
 640  * @param $apiRequest
 641  */
 642 function _civicrm_api3_case_getlist_spec(&$params, $apiRequest) {
 643   require_once 'api/v3/Generic/Getlist.php';
 644   _civicrm_api3_generic_getlist_spec($params, $apiRequest);
 645 }