| 1 | <?php |
| 2 | /* |
| 3 | +--------------------------------------------------------------------+ |
| 4 | | CiviCRM version 4.7 | |
| 5 | +--------------------------------------------------------------------+ |
| 6 | | Copyright CiviCRM LLC (c) 2004-2016 | |
| 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 | * @package CiviCRM_APIv3 |
| 30 | */ |
| 31 | |
| 32 | /** |
| 33 | * Get information about fields for a given api request. |
| 34 | * |
| 35 | * Getfields information is used for documentation, validation, default setting |
| 36 | * We first query the scheme using the $dao->fields function & then augment |
| 37 | * that information by calling the _spec functions that apply to the relevant function |
| 38 | * Note that we use 'unique' field names as described in the xml/schema files |
| 39 | * for get requests & just field name for create. This is because some get functions |
| 40 | * access multiple objects e.g. contact api accesses is_deleted from the activity |
| 41 | * table & from the contact table |
| 42 | * |
| 43 | * @param array $apiRequest |
| 44 | * Api request as an array. Keys are. |
| 45 | * - entity: string |
| 46 | * - action: string |
| 47 | * - version: string |
| 48 | * - function: callback (mixed) |
| 49 | * - params: array, varies |
| 50 | * |
| 51 | * @param bool $unique |
| 52 | * Determines whether to key by unique field names (only affects get-type) actions |
| 53 | * |
| 54 | * @return array |
| 55 | * API success object |
| 56 | */ |
| 57 | function civicrm_api3_generic_getfields($apiRequest, $unique = TRUE) { |
| 58 | static $results = array(); |
| 59 | if ((CRM_Utils_Array::value('cache_clear', $apiRequest['params']))) { |
| 60 | $results = array(); |
| 61 | // we will also clear pseudoconstants here - should potentially be moved to relevant BAO classes |
| 62 | CRM_Core_PseudoConstant::flush(); |
| 63 | if (!empty($apiRequest['params']['fieldname'])) { |
| 64 | CRM_Utils_PseudoConstant::flushConstant($apiRequest['params']['fieldname']); |
| 65 | } |
| 66 | if (!empty($apiRequest['params']['option_group_id'])) { |
| 67 | $optionGroupName = civicrm_api('option_group', 'getvalue', array( |
| 68 | 'version' => 3, |
| 69 | 'id' => $apiRequest['params']['option_group_id'], |
| 70 | 'return' => 'name', |
| 71 | )); |
| 72 | if (is_string($optionGroupName)) { |
| 73 | CRM_Utils_PseudoConstant::flushConstant(_civicrm_api_get_camel_name($optionGroupName)); |
| 74 | } |
| 75 | } |
| 76 | } |
| 77 | $entity = $apiRequest['entity']; |
| 78 | $lowercase_entity = _civicrm_api_get_entity_name_from_camel($entity); |
| 79 | $subentity = CRM_Utils_Array::value('contact_type', $apiRequest['params']); |
| 80 | $action = CRM_Utils_Array::value('action', $apiRequest['params']); |
| 81 | $sequential = empty($apiRequest['params']['sequential']) ? 0 : 1; |
| 82 | $apiRequest['params']['options'] = CRM_Utils_Array::value('options', $apiRequest['params'], array()); |
| 83 | $optionsToResolve = (array) CRM_Utils_Array::value('get_options', $apiRequest['params']['options'], array()); |
| 84 | |
| 85 | if (!$action || $action == 'getvalue' || $action == 'getcount') { |
| 86 | $action = 'get'; |
| 87 | } |
| 88 | // If no options, return results from cache |
| 89 | if (!$apiRequest['params']['options'] && isset($results[$entity . $subentity]) && isset($action, $results[$entity . $subentity]) |
| 90 | && isset($action, $results[$entity . $subentity][$sequential])) { |
| 91 | return $results[$entity . $subentity][$action][$sequential]; |
| 92 | } |
| 93 | // defaults based on data model and API policy |
| 94 | switch ($action) { |
| 95 | case 'getfields': |
| 96 | $values = _civicrm_api_get_fields($entity, FALSE, $apiRequest['params']); |
| 97 | return civicrm_api3_create_success($values, $apiRequest['params'], $entity, 'getfields'); |
| 98 | |
| 99 | case 'create': |
| 100 | case 'update': |
| 101 | case 'replace': |
| 102 | $unique = FALSE; |
| 103 | case 'get': |
| 104 | case 'getsingle': |
| 105 | case 'getcount': |
| 106 | case 'getstat': |
| 107 | $metadata = _civicrm_api_get_fields($apiRequest['entity'], $unique, $apiRequest['params']); |
| 108 | if (empty($metadata['id'])) { |
| 109 | // if id is not set we will set it eg. 'id' from 'case_id', case_id will be an alias |
| 110 | if (!empty($metadata[strtolower($apiRequest['entity']) . '_id'])) { |
| 111 | $metadata['id'] = $metadata[$lowercase_entity . '_id']; |
| 112 | unset($metadata[$lowercase_entity . '_id']); |
| 113 | $metadata['id']['api.aliases'] = array($lowercase_entity . '_id'); |
| 114 | } |
| 115 | } |
| 116 | else { |
| 117 | // really the preference would be to set the unique name in the xml |
| 118 | // question is which is a less risky fix this close to a release - setting in xml for the known failure |
| 119 | // (note) or setting for all api where fields is returning 'id' & we want to accept 'note_id' @ the api layer |
| 120 | // nb we don't officially accept note_id anyway - rationale here is more about centralising a now-tested |
| 121 | // inconsistency |
| 122 | $metadata['id']['api.aliases'] = array($lowercase_entity . '_id'); |
| 123 | } |
| 124 | break; |
| 125 | |
| 126 | case 'delete': |
| 127 | $metadata = array( |
| 128 | 'id' => array( |
| 129 | 'title' => $entity . ' ID', |
| 130 | 'api.required' => 1, |
| 131 | 'api.aliases' => array($lowercase_entity . '_id'), |
| 132 | 'type' => CRM_Utils_Type::T_INT, |
| 133 | )); |
| 134 | break; |
| 135 | |
| 136 | // Note: adding setvalue case here instead of in a generic spec function because |
| 137 | // some APIs override the generic setvalue fn which causes the generic spec to be overlooked. |
| 138 | case 'setvalue': |
| 139 | $metadata = array( |
| 140 | 'field' => array( |
| 141 | 'title' => 'Field name', |
| 142 | 'api.required' => 1, |
| 143 | 'type' => CRM_Utils_Type::T_STRING, |
| 144 | ), |
| 145 | 'id' => array( |
| 146 | 'title' => $entity . ' ID', |
| 147 | 'api.required' => 1, |
| 148 | 'type' => CRM_Utils_Type::T_INT, |
| 149 | ), |
| 150 | 'value' => array( |
| 151 | 'title' => 'Value', |
| 152 | 'description' => "Field value to set", |
| 153 | 'api.required' => 1, |
| 154 | ), |
| 155 | ); |
| 156 | if (array_intersect(array('all', 'field'), $optionsToResolve)) { |
| 157 | $options = civicrm_api3_generic_getfields(array('entity' => $entity, array('params' => array('action' => 'create')))); |
| 158 | $metadata['field']['options'] = CRM_Utils_Array::collect('title', $options['values']); |
| 159 | } |
| 160 | break; |
| 161 | |
| 162 | default: |
| 163 | // oddballs are on their own |
| 164 | $metadata = array(); |
| 165 | } |
| 166 | |
| 167 | // Normalize this for the sake of spec funcions |
| 168 | $apiRequest['params']['options']['get_options'] = $optionsToResolve; |
| 169 | |
| 170 | // find any supplemental information |
| 171 | $hypApiRequest = array('entity' => $apiRequest['entity'], 'action' => $action, 'version' => $apiRequest['version']); |
| 172 | try { |
| 173 | list ($apiProvider, $hypApiRequest) = \Civi::service('civi_api_kernel')->resolve($hypApiRequest); |
| 174 | if (isset($hypApiRequest['function'])) { |
| 175 | $helper = '_' . $hypApiRequest['function'] . '_spec'; |
| 176 | } |
| 177 | else { |
| 178 | // not implemented MagicFunctionProvider |
| 179 | $helper = NULL; |
| 180 | } |
| 181 | } |
| 182 | catch (\Civi\API\Exception\NotImplementedException $e) { |
| 183 | $helper = NULL; |
| 184 | } |
| 185 | if (function_exists($helper)) { |
| 186 | // alter |
| 187 | $helper($metadata, $apiRequest); |
| 188 | } |
| 189 | |
| 190 | foreach ($metadata as $fieldname => $fieldSpec) { |
| 191 | // Ensure 'name' is set |
| 192 | if (!isset($fieldSpec['name'])) { |
| 193 | $metadata[$fieldname]['name'] = $fieldname; |
| 194 | } |
| 195 | _civicrm_api3_generic_get_metadata_options($metadata, $apiRequest, $fieldname, $fieldSpec); |
| 196 | |
| 197 | // Convert options to "sequential" format |
| 198 | if ($sequential && !empty($metadata[$fieldname]['options'])) { |
| 199 | $metadata[$fieldname]['options'] = CRM_Utils_Array::makeNonAssociative($metadata[$fieldname]['options']); |
| 200 | } |
| 201 | } |
| 202 | |
| 203 | $results[$entity][$action][$sequential] = civicrm_api3_create_success($metadata, $apiRequest['params'], $entity, 'getfields'); |
| 204 | return $results[$entity][$action][$sequential]; |
| 205 | } |
| 206 | |
| 207 | /** |
| 208 | * Get metadata for a field |
| 209 | * |
| 210 | * @param array $apiRequest |
| 211 | * |
| 212 | * @return array |
| 213 | * API success object |
| 214 | */ |
| 215 | function civicrm_api3_generic_getfield($apiRequest) { |
| 216 | $params = $apiRequest['params']; |
| 217 | $sequential = !empty($params['sequential']); |
| 218 | $fieldName = _civicrm_api3_api_resolve_alias($apiRequest['entity'], $params['name'], $params['action']); |
| 219 | if (!$fieldName) { |
| 220 | return civicrm_api3_create_error("The field '{$params['name']}' doesn't exist."); |
| 221 | } |
| 222 | // Turn off sequential to make the field easier to find |
| 223 | $apiRequest['params']['sequential'] = 0; |
| 224 | if (isset($params['get_options'])) { |
| 225 | $apiRequest['params']['options']['get_options_context'] = $params['get_options']; |
| 226 | $apiRequest['params']['options']['get_options'] = $fieldName; |
| 227 | } |
| 228 | $result = civicrm_api3_generic_getfields($apiRequest, FALSE); |
| 229 | $result = $result['values'][$fieldName]; |
| 230 | // Fix sequential options since we forced it off |
| 231 | if ($sequential && !empty($result['options'])) { |
| 232 | $result['options'] = CRM_Utils_Array::makeNonAssociative($result['options']); |
| 233 | } |
| 234 | return civicrm_api3_create_success($result, $apiRequest['params'], $apiRequest['entity'], 'getfield'); |
| 235 | } |
| 236 | |
| 237 | /** |
| 238 | * Get metadata for getfield action. |
| 239 | * |
| 240 | * @param array $params |
| 241 | * @param array $apiRequest |
| 242 | * |
| 243 | * @throws \CiviCRM_API3_Exception |
| 244 | * @throws \Exception |
| 245 | */ |
| 246 | function _civicrm_api3_generic_getfield_spec(&$params, $apiRequest) { |
| 247 | $params = array( |
| 248 | 'name' => array( |
| 249 | 'title' => 'Field name', |
| 250 | 'description' => 'Name or alias of field to lookup', |
| 251 | 'api.required' => 1, |
| 252 | 'type' => CRM_Utils_Type::T_STRING, |
| 253 | ), |
| 254 | 'action' => array( |
| 255 | 'title' => 'API Action', |
| 256 | 'api.required' => 1, |
| 257 | 'type' => CRM_Utils_Type::T_STRING, |
| 258 | 'api.aliases' => array('api_action'), |
| 259 | ), |
| 260 | 'get_options' => array( |
| 261 | 'title' => 'Get Options', |
| 262 | 'description' => 'Context for which to get field options, or null to skip fetching options.', |
| 263 | 'type' => CRM_Utils_Type::T_STRING, |
| 264 | 'options' => CRM_Core_DAO::buildOptionsContext(), |
| 265 | 'api.aliases' => array('context'), |
| 266 | ), |
| 267 | ); |
| 268 | // Add available options to these params if requested |
| 269 | if (array_intersect(array('all', 'action'), $apiRequest['params']['options']['get_options'])) { |
| 270 | $actions = civicrm_api3($apiRequest['entity'], 'getactions'); |
| 271 | $actions = array_combine($actions['values'], $actions['values']); |
| 272 | // Let's not go meta-crazy |
| 273 | CRM_Utils_Array::remove($actions, 'getactions', 'getoptions', 'getfields', 'getfield', 'getcount', 'getrefcount', 'getsingle', 'getlist', 'getvalue', 'setvalue', 'update'); |
| 274 | $params['action']['options'] = $actions; |
| 275 | } |
| 276 | } |
| 277 | |
| 278 | /** |
| 279 | * API return function to reformat results as count. |
| 280 | * |
| 281 | * @param array $apiRequest |
| 282 | * Api request as an array. Keys are. |
| 283 | * |
| 284 | * @throws API_Exception |
| 285 | * @return int |
| 286 | * count of results |
| 287 | */ |
| 288 | function civicrm_api3_generic_getcount($apiRequest) { |
| 289 | $apiRequest['params']['options']['is_count'] = TRUE; |
| 290 | $result = civicrm_api($apiRequest['entity'], 'get', $apiRequest['params']); |
| 291 | if (is_numeric(CRM_Utils_Array::value('values', $result))) { |
| 292 | return (int) $result['values']; |
| 293 | } |
| 294 | if (!isset($result['count'])) { |
| 295 | throw new API_Exception(ts('Unexpected result from getcount') . print_r($result, TRUE)); |
| 296 | } |
| 297 | return $result['count']; |
| 298 | } |
| 299 | |
| 300 | /** |
| 301 | * API return function to reformat results as single result. |
| 302 | * |
| 303 | * @param array $apiRequest |
| 304 | * Api request as an array. Keys are. |
| 305 | * |
| 306 | * @return int |
| 307 | * count of results |
| 308 | */ |
| 309 | function civicrm_api3_generic_getsingle($apiRequest) { |
| 310 | // So the first entity is always result['values'][0]. |
| 311 | $apiRequest['params']['sequential'] = 1; |
| 312 | $result = civicrm_api($apiRequest['entity'], 'get', $apiRequest['params']); |
| 313 | if ($result['is_error'] !== 0) { |
| 314 | return $result; |
| 315 | } |
| 316 | if ($result['count'] === 1) { |
| 317 | return $result['values'][0]; |
| 318 | } |
| 319 | if ($result['count'] !== 1) { |
| 320 | return civicrm_api3_create_error("Expected one " . $apiRequest['entity'] . " but found " . $result['count'], array('count' => $result['count'])); |
| 321 | } |
| 322 | return civicrm_api3_create_error("Undefined behavior"); |
| 323 | } |
| 324 | |
| 325 | /** |
| 326 | * API return function to reformat results as single value. |
| 327 | * |
| 328 | * @param array $apiRequest |
| 329 | * Api request as an array. Keys are. |
| 330 | * |
| 331 | * @return int |
| 332 | * count of results |
| 333 | */ |
| 334 | function civicrm_api3_generic_getvalue($apiRequest) { |
| 335 | $apiRequest['params']['sequential'] = 1; |
| 336 | $result = civicrm_api($apiRequest['entity'], 'get', $apiRequest['params']); |
| 337 | if ($result['is_error'] !== 0) { |
| 338 | return $result; |
| 339 | } |
| 340 | if ($result['count'] !== 1) { |
| 341 | $result = civicrm_api3_create_error("Expected one " . $apiRequest['entity'] . " but found " . $result['count'], array('count' => $result['count'])); |
| 342 | return $result; |
| 343 | } |
| 344 | |
| 345 | // we only take "return=" as valid options |
| 346 | if (!empty($apiRequest['params']['return'])) { |
| 347 | if (!isset($result['values'][0][$apiRequest['params']['return']])) { |
| 348 | return civicrm_api3_create_error("field " . $apiRequest['params']['return'] . " unset or not existing", array('invalid_field' => $apiRequest['params']['return'])); |
| 349 | } |
| 350 | |
| 351 | return $result['values'][0][$apiRequest['params']['return']]; |
| 352 | } |
| 353 | |
| 354 | return civicrm_api3_create_error("missing param return=field you want to read the value of", array('error_type' => 'mandatory_missing', 'missing_param' => 'return')); |
| 355 | } |
| 356 | |
| 357 | /** |
| 358 | * Get count of contact references. |
| 359 | * |
| 360 | * @param array $params |
| 361 | * @param array $apiRequest |
| 362 | */ |
| 363 | function _civicrm_api3_generic_getrefcount_spec(&$params, $apiRequest) { |
| 364 | $params['id']['api.required'] = 1; |
| 365 | $params['id']['title'] = $apiRequest['entity'] . ' ID'; |
| 366 | $params['id']['type'] = CRM_Utils_Type::T_INT; |
| 367 | } |
| 368 | |
| 369 | /** |
| 370 | * API to determine if a record is in-use. |
| 371 | * |
| 372 | * @param array $apiRequest |
| 373 | * Api request as an array. |
| 374 | * |
| 375 | * @throws API_Exception |
| 376 | * @return array |
| 377 | * API result (int 0 or 1) |
| 378 | */ |
| 379 | function civicrm_api3_generic_getrefcount($apiRequest) { |
| 380 | $entityToClassMap = CRM_Core_DAO_AllCoreTables::daoToClass(); |
| 381 | if (!isset($entityToClassMap[$apiRequest['entity']])) { |
| 382 | throw new API_Exception("The entity '{$apiRequest['entity']}' is unknown or unsupported by 'getrefcount'. Consider implementing this API.", 'getrefcount_unsupported'); |
| 383 | } |
| 384 | $daoClass = $entityToClassMap[$apiRequest['entity']]; |
| 385 | |
| 386 | /* @var $dao CRM_Core_DAO */ |
| 387 | $dao = new $daoClass(); |
| 388 | $dao->id = $apiRequest['params']['id']; |
| 389 | if ($dao->find(TRUE)) { |
| 390 | return civicrm_api3_create_success($dao->getReferenceCounts()); |
| 391 | } |
| 392 | else { |
| 393 | return civicrm_api3_create_success(array()); |
| 394 | } |
| 395 | } |
| 396 | |
| 397 | /** |
| 398 | * API wrapper for replace function. |
| 399 | * |
| 400 | * @param array $apiRequest |
| 401 | * Api request as an array. Keys are. |
| 402 | * |
| 403 | * @return int |
| 404 | * count of results |
| 405 | */ |
| 406 | function civicrm_api3_generic_replace($apiRequest) { |
| 407 | return _civicrm_api3_generic_replace($apiRequest['entity'], $apiRequest['params']); |
| 408 | } |
| 409 | |
| 410 | /** |
| 411 | * API wrapper for getoptions function. |
| 412 | * |
| 413 | * @param array $apiRequest |
| 414 | * Api request as an array. |
| 415 | * |
| 416 | * @return array |
| 417 | * Array of results |
| 418 | */ |
| 419 | function civicrm_api3_generic_getoptions($apiRequest) { |
| 420 | // Resolve aliases. |
| 421 | $fieldName = _civicrm_api3_api_resolve_alias($apiRequest['entity'], $apiRequest['params']['field']); |
| 422 | if (!$fieldName) { |
| 423 | return civicrm_api3_create_error("The field '{$apiRequest['params']['field']}' doesn't exist."); |
| 424 | } |
| 425 | // Validate 'context' from params |
| 426 | $context = CRM_Utils_Array::value('context', $apiRequest['params']); |
| 427 | CRM_Core_DAO::buildOptionsContext($context); |
| 428 | unset($apiRequest['params']['context'], $apiRequest['params']['field']); |
| 429 | |
| 430 | $baoName = _civicrm_api3_get_BAO($apiRequest['entity']); |
| 431 | $options = $baoName::buildOptions($fieldName, $context, $apiRequest['params']); |
| 432 | if ($options === FALSE) { |
| 433 | return civicrm_api3_create_error("The field '{$fieldName}' has no associated option list."); |
| 434 | } |
| 435 | // Support 'sequential' output as a non-associative array |
| 436 | if (!empty($apiRequest['params']['sequential'])) { |
| 437 | $options = CRM_Utils_Array::makeNonAssociative($options); |
| 438 | } |
| 439 | return civicrm_api3_create_success($options, $apiRequest['params'], $apiRequest['entity'], 'getoptions'); |
| 440 | } |
| 441 | |
| 442 | /** |
| 443 | * Provide metadata for this generic action |
| 444 | * |
| 445 | * @param $params |
| 446 | * @param $apiRequest |
| 447 | */ |
| 448 | function _civicrm_api3_generic_getoptions_spec(&$params, $apiRequest) { |
| 449 | $params += array( |
| 450 | 'field' => array( |
| 451 | 'title' => 'Field name', |
| 452 | 'api.required' => 1, |
| 453 | 'type' => CRM_Utils_Type::T_STRING, |
| 454 | ), |
| 455 | 'context' => array( |
| 456 | 'title' => 'Context', |
| 457 | 'type' => CRM_Utils_Type::T_STRING, |
| 458 | 'options' => CRM_Core_DAO::buildOptionsContext(), |
| 459 | ), |
| 460 | ); |
| 461 | |
| 462 | // Add available fields if requested |
| 463 | if (array_intersect(array('all', 'field'), $apiRequest['params']['options']['get_options'])) { |
| 464 | $fields = civicrm_api3_generic_getfields(array('entity' => $apiRequest['entity'], array('params' => array('action' => 'create')))); |
| 465 | $params['field']['options'] = array(); |
| 466 | foreach ($fields['values'] as $name => $field) { |
| 467 | if (isset($field['pseudoconstant']) || CRM_Utils_Array::value('type', $field) == CRM_Utils_Type::T_BOOLEAN) { |
| 468 | $params['field']['options'][$name] = CRM_Utils_Array::value('title', $field, $name); |
| 469 | } |
| 470 | } |
| 471 | } |
| 472 | } |
| 473 | |
| 474 | /** |
| 475 | * Get metadata. |
| 476 | * |
| 477 | * Function fills the 'options' array on the metadata returned by getfields if |
| 478 | * 1) the param option 'get_options' is defined - e.g. $params['options']['get_options'] => array('custom_1) |
| 479 | * (this is passed in as the $fieldsToResolve array) |
| 480 | * 2) the field is a pseudoconstant and is NOT an FK |
| 481 | * - the reason for this is that checking / transformation is done on pseudoconstants but |
| 482 | * - if the field is an FK then mysql will enforce the data quality (& we have handling on failure) |
| 483 | * @todo - if may be we should define a 'resolve' key on the pseudoconstant for when these rules are not fine enough |
| 484 | * |
| 485 | * This function is only split out for the purpose of code clarity / comment block documentation |
| 486 | * |
| 487 | * @param array $metadata |
| 488 | * The array of metadata that will form the result of the getfields function. |
| 489 | * @param array $apiRequest |
| 490 | * @param string $fieldname |
| 491 | * Field currently being processed. |
| 492 | * @param array $fieldSpec |
| 493 | * Metadata for that field. |
| 494 | */ |
| 495 | function _civicrm_api3_generic_get_metadata_options(&$metadata, $apiRequest, $fieldname, $fieldSpec) { |
| 496 | if (empty($fieldSpec['pseudoconstant']) && empty($fieldSpec['option_group_id'])) { |
| 497 | return; |
| 498 | } |
| 499 | |
| 500 | $fieldsToResolve = $apiRequest['params']['options']['get_options']; |
| 501 | |
| 502 | if (!empty($metadata[$fieldname]['options']) || (!in_array($fieldname, $fieldsToResolve) && !in_array('all', $fieldsToResolve))) { |
| 503 | return; |
| 504 | } |
| 505 | |
| 506 | // Allow caller to specify context |
| 507 | $context = CRM_Utils_Array::value('get_options_context', $apiRequest['params']['options']); |
| 508 | // Default to api action if it is a supported context. |
| 509 | if (!$context) { |
| 510 | $action = CRM_Utils_Array::value('action', $apiRequest['params']); |
| 511 | $contexts = CRM_Core_DAO::buildOptionsContext(); |
| 512 | if (isset($contexts[$action])) { |
| 513 | $context = $action; |
| 514 | } |
| 515 | } |
| 516 | |
| 517 | $options = civicrm_api($apiRequest['entity'], 'getoptions', array('version' => 3, 'field' => $fieldname, 'context' => $context)); |
| 518 | if (is_array(CRM_Utils_Array::value('values', $options))) { |
| 519 | $metadata[$fieldname]['options'] = $options['values']; |
| 520 | } |
| 521 | } |