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