Civi/Test/Api3TestTrait.php

   1 <?php
   2
   3 namespace Civi\Test;
   4
   5 use Civi\API\Exception\NotImplementedException;
   6
   7 /**
   8  * Class Api3TestTrait
   9  * @package Civi\Test
  10  *
  11  * This trait defines a number of helper functions for testing APIv3. Commonly
  12  * used helpers include `callAPISuccess()`, `callAPIFailure()`,
  13  * `assertAPISuccess()`, and `assertAPIFailure()`.
  14  *
  15  * This trait is intended for use with PHPUnit-based test cases.
  16  */
  17 trait Api3TestTrait {
  18
  19   /**
  20    * Get the api versions to test.
  21    *
  22    * @return array
  23    */
  24   public function versionThreeAndFour() {
  25     $r = [[3]];
  26     global $civicrm_root;
  27     if (file_exists("$civicrm_root/Civi/Api4") || file_exists("$civicrm_root/ext/api4")) {
  28       $r[] = [4];
  29     }
  30     return $r;
  31   }
  32
  33   /**
  34    * Api version - easier to override than just a define
  35    * @var int
  36    */
  37   protected $_apiversion = 3;
  38
  39   /**
  40    * Check that api returned 'is_error' => 1
  41    * else provide full message
  42    * @param array $result
  43    * @param $expected
  44    * @param array $valuesToExclude
  45    * @param string $prefix
  46    *   Extra test to add to message.
  47    */
  48   public function assertAPIArrayComparison($result, $expected, $valuesToExclude = [], $prefix = '') {
  49     $valuesToExclude = array_merge($valuesToExclude, ['debug', 'xdebug', 'sequential']);
  50     foreach ($valuesToExclude as $value) {
  51       if (isset($result[$value])) {
  52         unset($result[$value]);
  53       }
  54       if (isset($expected[$value])) {
  55         unset($expected[$value]);
  56       }
  57     }
  58     $this->assertEquals($result, $expected, "api result array comparison failed " . $prefix . print_r($result, TRUE) . ' was compared to ' . print_r($expected, TRUE));
  59   }
  60
  61   /**
  62    * Check that a deleted item has been deleted.
  63    *
  64    * @param $entity
  65    * @param $id
  66    */
  67   public function assertAPIDeleted($entity, $id) {
  68     $this->callAPISuccess($entity, 'getcount', ['id' => $id], 0);
  69   }
  70
  71   /**
  72    * Check that api returned 'is_error' => 1.
  73    *
  74    * @param array $apiResult
  75    *   Api result.
  76    * @param string $prefix
  77    *   Extra test to add to message.
  78    * @param null $expectedError
  79    */
  80   public function assertAPIFailure($apiResult, $prefix = '', $expectedError = NULL) {
  81     if (!empty($prefix)) {
  82       $prefix .= ': ';
  83     }
  84     if ($expectedError && !empty($apiResult['is_error'])) {
  85       $this->assertContains($expectedError, $apiResult['error_message'], 'api error message not as expected' . $prefix);
  86     }
  87     $this->assertEquals(1, $apiResult['is_error'], "api call should have failed but it succeeded " . $prefix . (print_r($apiResult, TRUE)));
  88     $this->assertNotEmpty($apiResult['error_message']);
  89   }
  90
  91   /**
  92    * Check that api returned 'is_error' => 0.
  93    *
  94    * @param array $apiResult
  95    *   Api result.
  96    * @param string $prefix
  97    *   Extra test to add to message.
  98    */
  99   public function assertAPISuccess($apiResult, $prefix = '') {
 100     if (!empty($prefix)) {
 101       $prefix .= ': ';
 102     }
 103     $errorMessage = empty($apiResult['error_message']) ? '' : " " . $apiResult['error_message'];
 104
 105     if (!empty($apiResult['debug_information'])) {
 106       $errorMessage .= "\n " . print_r($apiResult['debug_information'], TRUE);
 107     }
 108     if (!empty($apiResult['trace'])) {
 109       $errorMessage .= "\n" . print_r($apiResult['trace'], TRUE);
 110     }
 111     $this->assertEmpty(\CRM_Utils_Array::value('is_error', $apiResult), $prefix . $errorMessage);
 112   }
 113
 114   /**
 115    * This function exists to wrap api functions.
 116    * so we can ensure they fail where expected & throw exceptions without litterering the test with checks
 117    * @param string $entity
 118    * @param string $action
 119    * @param array $params
 120    * @param string $expectedErrorMessage
 121    *   Error.
 122    * @param null $extraOutput
 123    * @return array|int
 124    */
 125   public function callAPIFailure($entity, $action, $params, $expectedErrorMessage = NULL, $extraOutput = NULL) {
 126     if (is_array($params)) {
 127       $params += [
 128         'version' => $this->_apiversion,
 129       ];
 130     }
 131     $result = $this->civicrm_api($entity, $action, $params);
 132     $this->assertAPIFailure($result, "We expected a failure for $entity $action but got a success", $expectedErrorMessage);
 133     return $result;
 134   }
 135
 136   /**
 137    * wrap api functions.
 138    * so we can ensure they succeed & throw exceptions without litterering the test with checks
 139    *
 140    * @param string $entity
 141    * @param string $action
 142    * @param array $params
 143    * @param mixed $checkAgainst
 144    *   Optional value to check result against, implemented for getvalue,.
 145    *   getcount, getsingle. Note that for getvalue the type is checked rather than the value
 146    *   for getsingle the array is compared against an array passed in - the id is not compared (for
 147    *   better or worse )
 148    *
 149    * @return array|int
 150    *
 151    * @throws \CRM_Core_Exception
 152    */
 153   public function callAPISuccess($entity, $action, $params = [], $checkAgainst = NULL) {
 154     $params = array_merge([
 155       'version' => $this->_apiversion,
 156       'debug' => 1,
 157     ],
 158       $params
 159     );
 160     switch (strtolower($action)) {
 161       case 'getvalue':
 162         return $this->callAPISuccessGetValue($entity, $params, $checkAgainst);
 163
 164       case 'getsingle':
 165         return $this->callAPISuccessGetSingle($entity, $params, $checkAgainst);
 166
 167       case 'getcount':
 168         return $this->callAPISuccessGetCount($entity, $params, $checkAgainst);
 169     }
 170     $result = $this->civicrm_api($entity, $action, $params);
 171     $this->assertAPISuccess($result, "Failure in api call for $entity $action");
 172     return $result;
 173   }
 174
 175   /**
 176    * This function exists to wrap api getValue function & check the result
 177    * so we can ensure they succeed & throw exceptions without litterering the test with checks
 178    * There is a type check in this
 179    *
 180    * @param string $entity
 181    * @param array $params
 182    * @param int $count
 183    *
 184    * @throws \CRM_Core_Exception
 185    *
 186    * @return array|int
 187    */
 188   public function callAPISuccessGetCount($entity, $params, $count = NULL) {
 189     $params += [
 190       'version' => $this->_apiversion,
 191       'debug' => 1,
 192     ];
 193     $result = $this->civicrm_api($entity, 'getcount', $params);
 194     if (!is_int($result) || !empty($result['is_error']) || isset($result['values'])) {
 195       throw new \CRM_Core_Exception('Invalid getcount result : ' . print_r($result, TRUE) . " type :" . gettype($result));
 196     }
 197     if (is_int($count)) {
 198       $this->assertEquals($count, $result, "incorrect count returned from $entity getcount");
 199     }
 200     return $result;
 201   }
 202
 203   /**
 204    * This function exists to wrap api getsingle function & check the result
 205    * so we can ensure they succeed & throw exceptions without litterering the test with checks
 206    *
 207    * @param string $entity
 208    * @param array $params
 209    * @param array $checkAgainst
 210    *   Array to compare result against.
 211    *   - boolean
 212    *   - integer
 213    *   - double
 214    *   - string
 215    *   - array
 216    *   - object
 217    *
 218    * @throws \CRM_Core_Exception
 219    *
 220    * @return array|int
 221    */
 222   public function callAPISuccessGetSingle($entity, $params, $checkAgainst = NULL) {
 223     $params += [
 224       'version' => $this->_apiversion,
 225     ];
 226     $result = $this->civicrm_api($entity, 'getsingle', $params);
 227     if (!is_array($result) || !empty($result['is_error']) || isset($result['values'])) {
 228       $unfilteredResult = $this->civicrm_api($entity, 'get', ['version' => $this->_apiversion]);
 229       throw new \CRM_Core_Exception(
 230         'Invalid getsingle result' . print_r($result, TRUE)
 231         . "\n entity: $entity . \n params \n " . print_r($params, TRUE)
 232         . "\n entities retrieved with blank params \n" . print_r($unfilteredResult, TRUE)
 233       );
 234     }
 235     if ($checkAgainst) {
 236       // @todo - have gone with the fn that unsets id? should we check id?
 237       $this->checkArrayEquals($result, $checkAgainst);
 238     }
 239     return $result;
 240   }
 241
 242   /**
 243    * This function exists to wrap api getValue function & check the result
 244    * so we can ensure they succeed & throw exceptions without litterering the test with checks
 245    * There is a type check in this
 246    *
 247    * @param string $entity
 248    * @param array $params
 249    * @param string $type
 250    *   Per http://php.net/manual/en/function.gettype.php possible types.
 251    *   - boolean
 252    *   - integer
 253    *   - double
 254    *   - string
 255    *   - array
 256    *   - object
 257    *
 258    * @return array|int
 259    * @throws \CRM_Core_Exception
 260    */
 261   public function callAPISuccessGetValue($entity, $params, $type = NULL) {
 262     $params += [
 263       'version' => $this->_apiversion,
 264       'debug' => 1,
 265     ];
 266     $result = $this->civicrm_api($entity, 'getvalue', $params);
 267     if (is_array($result) && (!empty($result['is_error']) || isset($result['values']))) {
 268       throw new \CRM_Core_Exception('Invalid getvalue result' . print_r($result, TRUE));
 269     }
 270     if ($type) {
 271       if ($type === 'integer') {
 272         // api seems to return integers as strings
 273         $this->assertTrue(is_numeric($result), "expected a numeric value but got " . print_r($result, 1));
 274       }
 275       else {
 276         $this->assertType($type, $result, "returned result should have been of type $type but was ");
 277       }
 278     }
 279     return $result;
 280   }
 281
 282   /**
 283    * A stub for the API interface. This can be overriden by subclasses to change how the API is called.
 284    *
 285    * @param $entity
 286    * @param $action
 287    * @param array $params
 288    * @return array|int
 289    */
 290   public function civicrm_api($entity, $action, $params = []) {
 291     if (\CRM_Utils_Array::value('version', $params) == 4) {
 292       return $this->runApi4Legacy($entity, $action, $params);
 293     }
 294     return civicrm_api($entity, $action, $params);
 295   }
 296
 297   /**
 298    * Emulate v3 syntax so we can run api3 tests on v4
 299    *
 300    * @param $v3Entity
 301    * @param $v3Action
 302    * @param array $v3Params
 303    * @return array|int
 304    * @throws \API_Exception
 305    * @throws \CiviCRM_API3_Exception
 306    * @throws \Exception
 307    */
 308   public function runApi4Legacy($v3Entity, $v3Action, $v3Params = []) {
 309     $v4Entity = self::convertEntityNameToApi4($v3Entity);
 310     $v4Action = $v3Action = strtolower($v3Action);
 311     $v4Params = ['checkPermissions' => isset($v3Params['check_permissions']) ? (bool) $v3Params['check_permissions'] : FALSE];
 312     $sequential = !empty($v3Params['sequential']);
 313     $options = \_civicrm_api3_get_options_from_params($v3Params, in_array($v4Entity, ['Contact', 'Participant', 'Event', 'Group', 'Contribution', 'Membership']));
 314     $indexBy = in_array($v3Action, ['get', 'create', 'replace']) && !$sequential ? 'id' : NULL;
 315     $onlyId = !empty($v3Params['format.only_id']);
 316     $onlySuccess = !empty($v3Params['format.is_success']);
 317     if (!empty($v3Params['filters']['is_current']) || !empty($v3Params['isCurrent'])) {
 318       $v4Params['current'] = TRUE;
 319     }
 320     $language = !empty($v3Params['options']['language']) ? $v3Params['options']['language'] : \CRM_Utils_Array::value('option.language', $v3Params);
 321     if ($language) {
 322       $v4Params['language'] = $language;
 323     }
 324     $toRemove = ['option.', 'return', 'api.', 'format.'];
 325     $chains = [];
 326     $custom = [];
 327     foreach ($v3Params as $key => $val) {
 328       foreach ($toRemove as $remove) {
 329         if (strpos($key, $remove) === 0) {
 330           if ($remove == 'api.') {
 331             $chains[$key] = $val;
 332           }
 333           unset($v3Params[$key]);
 334         }
 335       }
 336     }
 337
 338     $v3Fields = civicrm_api3($v3Entity, 'getfields', ['action' => $v3Action])['values'];
 339
 340     // Fix 'null'
 341     foreach ($v3Params as $key => $val) {
 342       if ($val === 'null') {
 343         $v3Params[$key] = NULL;
 344       }
 345     }
 346
 347     if ($v4Entity == 'Setting') {
 348       $indexBy = NULL;
 349       $v4Params['domainId'] = \CRM_Utils_Array::value('domain_id', $v3Params);
 350       if ($v3Action == 'getfields') {
 351         if (!empty($v3Params['name'])) {
 352           $v3Params['filters']['name'] = $v3Params['name'];
 353         }
 354         foreach (\CRM_Utils_Array::value('filters', $v3Params, []) as $filter => $val) {
 355           $v4Params['where'][] = [$filter, '=', $val];
 356         }
 357       }
 358       if ($v3Action == 'create') {
 359         $v4Action = 'set';
 360       }
 361       if ($v3Action == 'revert') {
 362         $v4Params['select'] = (array) $v3Params['name'];
 363       }
 364       if ($v3Action == 'getvalue') {
 365         $options['return'] = [$v3Params['name'] => 1];
 366         $v3Params = [];
 367       }
 368       \CRM_Utils_Array::remove($v3Params, 'domain_id', 'name');
 369     }
 370
 371     \CRM_Utils_Array::remove($v3Params, 'options', 'debug', 'version', 'sort', 'offset', 'rowCount', 'check_permissions', 'sequential', 'filters', 'isCurrent');
 372
 373     // Work around ugly hack in v3 Domain api
 374     if ($v4Entity == 'Domain') {
 375       $v3Fields['version'] = ['name' => 'version', 'api.aliases' => ['domain_version']];
 376       unset($v3Fields['domain_version']);
 377     }
 378
 379     foreach ($v3Fields as $name => $field) {
 380       // Resolve v3 aliases
 381       foreach (\CRM_Utils_Array::value('api.aliases', $field, []) as $alias) {
 382         if (isset($v3Params[$alias])) {
 383           $v3Params[$field['name']] = $v3Params[$alias];
 384           unset($v3Params[$alias]);
 385         }
 386       }
 387       // Convert custom field names
 388       if (strpos($name, 'custom_') === 0 && is_numeric($name[7])) {
 389         // Strictly speaking, using titles instead of names is incorrect, but it works for
 390         // unit tests where names and titles are identical and saves an extra db lookup.
 391         $custom[$field['groupTitle']][$field['title']] = $name;
 392         $v4FieldName = $field['groupTitle'] . '.' . $field['title'];
 393         if (isset($v3Params[$name])) {
 394           $v3Params[$v4FieldName] = $v3Params[$name];
 395           unset($v3Params[$name]);
 396         }
 397         if (isset($options['return'][$name])) {
 398           $options['return'][$v4FieldName] = 1;
 399           unset($options['return'][$name]);
 400         }
 401       }
 402     }
 403
 404     switch ($v3Action) {
 405       case 'getcount':
 406         $v4Params['select'] = ['row_count'];
 407         // No break - keep processing as get
 408       case 'getsingle':
 409       case 'getvalue':
 410         $v4Action = 'get';
 411         // No break - keep processing as get
 412       case 'get':
 413         if ($options['return'] && $v3Action !== 'getcount') {
 414           $v4Params['select'] = array_keys($options['return']);
 415         }
 416         if ($options['limit'] && $v4Entity != 'Setting') {
 417           $v4Params['limit'] = $options['limit'];
 418         }
 419         if ($options['offset']) {
 420           $v4Params['offset'] = $options['offset'];
 421         }
 422         if ($options['sort']) {
 423           foreach (explode(',', $options['sort']) as $sort) {
 424             list($sortField, $sortDir) = array_pad(explode(' ', trim($sort)), 2, 'ASC');
 425             $v4Params['orderBy'][$sortField] = $sortDir;
 426           }
 427         }
 428         break;
 429
 430       case 'replace':
 431         if (empty($v3Params['values'])) {
 432           $v4Action = 'delete';
 433         }
 434         else {
 435           $v4Params['records'] = $v3Params['values'];
 436         }
 437         unset($v3Params['values']);
 438         break;
 439
 440       case 'create':
 441       case 'update':
 442         if (!empty($v3Params['id'])) {
 443           $v4Action = 'update';
 444           $v4Params['where'][] = ['id', '=', $v3Params['id']];
 445         }
 446
 447         $v4Params['values'] = $v3Params;
 448         unset($v4Params['values']['id']);
 449         break;
 450
 451       case 'delete':
 452         if (!empty($v3Params['id'])) {
 453           $v4Params['where'][] = ['id', '=', $v3Params['id']];
 454         }
 455         break;
 456
 457       case 'getoptions':
 458         $indexBy = 0;
 459         $v4Action = 'getFields';
 460         $v4Params += [
 461           'where' => [['name', '=', $v3Params['field']]],
 462           'loadOptions' => TRUE,
 463         ];
 464         break;
 465
 466       case 'getfields':
 467         $v4Action = 'getFields';
 468         if (!empty($v3Params['action']) || !empty($v3Params['api_action'])) {
 469           $v4Params['action'] = !empty($v3Params['action']) ? $v3Params['action'] : $v3Params['api_action'];
 470         }
 471         $indexBy = !$sequential ? 'name' : NULL;
 472         break;
 473     }
 474
 475     // Ensure this api4 entity/action exists
 476     try {
 477       $actionInfo = \civicrm_api4($v4Entity, 'getActions', ['checkPermissions' => FALSE, 'where' => [['name', '=', $v4Action]]]);
 478     }
 479     catch (NotImplementedException $e) {
 480       // For now we'll mark the test incomplete if a v4 entity doesn't exit yet
 481       $this->markTestIncomplete($e->getMessage());
 482     }
 483     if (!isset($actionInfo[0])) {
 484       throw new \Exception("Api4 $v4Entity $v4Action does not exist.");
 485     }
 486
 487     // Migrate special params like fix_address
 488     foreach ($actionInfo[0]['params'] as $v4ParamName => $paramInfo) {
 489       // camelCase in api4, lower_case in api3
 490       $v3ParamName = strtolower(preg_replace('/(?=[A-Z])/', '_$0', $v4ParamName));
 491       if (isset($v3Params[$v3ParamName])) {
 492         $v4Params[$v4ParamName] = $v3Params[$v3ParamName];
 493         unset($v3Params[$v3ParamName]);
 494         if ($paramInfo['type'][0] == 'bool') {
 495           $v4Params[$v4ParamName] = (bool) $v4Params[$v4ParamName];
 496         }
 497       }
 498     }
 499
 500     // Build where clause for 'getcount', 'getsingle', 'getvalue', 'get' & 'replace'
 501     if ($v4Action == 'get' || $v3Action == 'replace') {
 502       foreach ($v3Params as $key => $val) {
 503         $op = '=';
 504         if (is_array($val) && count($val) == 1 && array_intersect_key($val, array_flip(\CRM_Core_DAO::acceptedSQLOperators()))) {
 505           foreach ($val as $op => $newVal) {
 506             $val = $newVal;
 507           }
 508         }
 509         $v4Params['where'][] = [$key, $op, $val];
 510       }
 511     }
 512
 513     try {
 514       $result = \civicrm_api4($v4Entity, $v4Action, $v4Params, $indexBy);
 515     }
 516     catch (\Exception $e) {
 517       return $onlySuccess ? 0 : [
 518         'is_error' => 1,
 519         'error_message' => $e->getMessage(),
 520         'version' => 4,
 521       ];
 522     }
 523
 524     if (($v3Action == 'getsingle' || $v3Action == 'getvalue') && count($result) != 1) {
 525       return $onlySuccess ? 0 : [
 526         'is_error' => 1,
 527         'error_message' => "Expected one $v4Entity but found " . count($result),
 528         'count' => count($result),
 529       ];
 530     }
 531
 532     if ($onlySuccess) {
 533       return 1;
 534     }
 535
 536     if ($v3Action == 'getcount') {
 537       return $result->count();
 538     }
 539
 540     if ($onlyId) {
 541       return $result->first()['id'];
 542     }
 543
 544     if ($v3Action == 'getvalue' && $v4Entity == 'Setting') {
 545       return \CRM_Utils_Array::value('value', $result->first());
 546     }
 547
 548     if ($v3Action == 'getvalue') {
 549       return \CRM_Utils_Array::value(array_keys($options['return'])[0], $result->first());
 550     }
 551
 552     // Mimic api3 behavior when using 'replace' action to delete all
 553     if ($v3Action == 'replace' && $v4Action == 'delete') {
 554       $result->exchangeArray([]);
 555     }
 556
 557     if ($v3Action == 'getoptions') {
 558       return [
 559         'is_error' => 0,
 560         'count' => $result['options'] ? count($result['options']) : 0,
 561         'values' => $result['options'] ?: [],
 562         'version' => 4,
 563       ];
 564     }
 565
 566     // Emulate the weird return format of api3 settings
 567     if (($v3Action == 'get' || $v3Action == 'create') && $v4Entity == 'Setting') {
 568       $settings = [];
 569       foreach ($result as $item) {
 570         $settings[$item['domain_id']][$item['name']] = $item['value'];
 571       }
 572       $result->exchangeArray($sequential ? array_values($settings) : $settings);
 573     }
 574
 575     foreach ($result as $index => $row) {
 576       // Run chains
 577       foreach ($chains as $key => $params) {
 578         $result[$index][$key] = $this->runApi4LegacyChain($key, $params, $v4Entity, $row, $sequential);
 579       }
 580       // Resolve custom field names
 581       foreach ($custom as $group => $fields) {
 582         foreach ($fields as $field => $v3FieldName) {
 583           if (isset($row["$group.$field"])) {
 584             $result[$index][$v3FieldName] = $row["$group.$field"];
 585             unset($result[$index]["$group.$field"]);
 586           }
 587         }
 588       }
 589     }
 590
 591     if ($v3Action == 'getsingle') {
 592       return $result->first();
 593     }
 594
 595     return [
 596       'is_error' => 0,
 597       'version' => 4,
 598       'count' => count($result),
 599       'values' => (array) $result,
 600       'id' => is_object($result) && count($result) == 1 ? \CRM_Utils_Array::value('id', $result->first()) : NULL,
 601     ];
 602   }
 603
 604   /**
 605    * @param string $key
 606    * @param mixed $params
 607    * @param string $mainEntity
 608    * @param array $result
 609    * @param bool $sequential
 610    * @return array
 611    * @throws \API_Exception
 612    */
 613   protected function runApi4LegacyChain($key, $params, $mainEntity, $result, $sequential) {
 614     // Handle an array of multiple calls using recursion
 615     if (is_array($params) && isset($params[0]) && is_array($params[0])) {
 616       $results = [];
 617       foreach ($params as $chain) {
 618         $results[] = $this->runApi4LegacyChain($key, $chain, $mainEntity, $result, $sequential);
 619       }
 620       return $results;
 621     }
 622
 623     // Handle single api call
 624     list(, $chainEntity, $chainAction) = explode('.', $key);
 625     $lcChainEntity = \_civicrm_api_get_entity_name_from_camel($chainEntity);
 626     $chainEntity = self::convertEntityNameToApi4($chainEntity);
 627     $lcMainEntity = \_civicrm_api_get_entity_name_from_camel($mainEntity);
 628     $params = is_array($params) ? $params : [];
 629
 630     // Api3 expects this to be inherited
 631     $params += ['sequential' => $sequential];
 632
 633     // Replace $value.field_name
 634     foreach ($params as $name => $param) {
 635       if (is_string($param) && strpos($param, '$value.') === 0) {
 636         $param = substr($param, 7);
 637         $params[$name] = \CRM_Utils_Array::value($param, $result);
 638       }
 639     }
 640
 641     try {
 642       $getFields = civicrm_api4($chainEntity, 'getFields', ['select' => ['name']], 'name');
 643     }
 644     catch (NotImplementedException $e) {
 645       $this->markTestIncomplete($e->getMessage());
 646     }
 647
 648     // Emulate the string-fu guesswork that api3 does
 649     if ($chainEntity == $mainEntity && empty($params['id']) &&  !empty($result['id'])) {
 650       $params['id'] = $result['id'];
 651     }
 652     elseif (empty($params['id']) && !empty($result[$lcChainEntity . '_id'])) {
 653       $params['id'] = $result[$lcChainEntity . '_id'];
 654     }
 655     elseif (!empty($result['id']) && isset($getFields[$lcMainEntity . '_id']) && empty($params[$lcMainEntity . '_id'])) {
 656       $params[$lcMainEntity . '_id'] = $result['id'];
 657     }
 658     return $this->runApi4Legacy($chainEntity, $chainAction, $params);
 659   }
 660
 661   /**
 662    * Fix the naming differences between api3 & api4 entities.
 663    *
 664    * @param string $legacyName
 665    * @return string
 666    */
 667   public static function convertEntityNameToApi4($legacyName) {
 668     $api4Name = \CRM_Utils_String::convertStringToCamel($legacyName);
 669     $map = [
 670       'Im' => 'IM',
 671       'Acl' => 'ACL',
 672     ];
 673     return \CRM_Utils_Array::value($api4Name, $map, $api4Name);
 674   }
 675
 676 }