$action = strtolower(CRM_Utils_Array::value('action', $apiRequest['params']));
$sequential = empty($apiRequest['params']) ? 0 : 1;
$apiOptions = CRM_Utils_Array::value('options', $apiRequest['params'], array());
- if ($action == 'getvalue' || $action == 'getvalue' || $action == 'getcount') {
+ if (!$action || $action == 'getvalue' || $action == 'getcount') {
$action = 'get';
}
-
- if (empty($action)) {
- $action='get';
- }
// determines whether to use unique field names - seem comment block above
$unique = TRUE;
if (empty($apiOptions) && isset($results[$entity . $subentity]) && isset($action, $results[$entity . $subentity])
$helper = '_' . $hypApiRequest['function'] . '_spec';
if (function_exists($helper)) {
// alter
- $helper($metadata);
+ $helper($metadata, $apiRequest);
}
$fieldsToResolve = (array) CRM_Utils_Array::value('get_options', $apiOptions, array());
}
// we only take "return=" as valid options
- if (CRM_Utils_Array::value('return', $apiRequest['params'])) {
+ if (!empty($apiRequest['params']['return'])) {
if (!isset($result['values'][0][$apiRequest['params']['return']])) {
return civicrm_api3_create_error("field " . $apiRequest['params']['return'] . " unset or not existing", array('invalid_field' => $apiRequest['params']['return']));
}
// Validate 'context' from params
$context = CRM_Utils_Array::value('context', $apiRequest['params']);
CRM_Core_DAO::buildOptionsContext($context);
+ unset($apiRequest['params']['context'], $apiRequest['params']['field']);
$baoName = _civicrm_api3_get_BAO($apiRequest['entity']);
- $options = $baoName::buildOptions($fieldName, $context);
+ $options = $output = $baoName::buildOptions($fieldName, $context, $apiRequest['params']);
if ($options === FALSE) {
return civicrm_api3_create_error("The field '{$fieldName}' has no associated option list.");
}
- return civicrm_api3_create_success($options);
+ // Support 'sequential' output as a non-associative array
+ if (!empty($apiRequest['params']['sequential'])) {
+ $output = array();
+ foreach ($options as $key => $val) {
+ $output[] = array('key' => $key, 'value' => $val);
+ }
+ }
+ return civicrm_api3_create_success($output, $apiRequest['params'], $apiRequest['entity'], 'getoptions');
}
/**
* - the reason for this is that checking / transformation is done on pseudoconstants but
* - if the field is an FK then mysql will enforce the data quality (& we have handling on failure)
* @todo - if may be we should define a 'resolve' key on the psuedoconstant for when these rules are not fine enough
- * 3) if there is an 'enum' then it is split up into the relevant options
*
* This function is only split out for the purpose of code clarity / comment block documentation
* @param array $metadata the array of metadata that will form the result of the getfields function
* @param array $fieldsToResolve anny field resolutions specifically requested
*/
function _civicrm_api3_generic_get_metadata_options(&$metadata, $entity, $fieldname, $fieldSpec, $fieldsToResolve){
- if(empty($fieldSpec['pseudoconstant']) && empty($fieldSpec['enumValues'])) {
+ if (empty($fieldSpec['pseudoconstant'])) {
return;
}