<?php
-// $Id$
/**
* Get information about fields for a given api request. Getfields information
if ((CRM_Utils_Array::value('cache_clear', $apiRequest['params']))) {
$results = array();
// we will also clear pseudoconstants here - should potentially be moved to relevant BAO classes
+ CRM_Core_PseudoConstant::flush();
if(!empty($apiRequest['params']['fieldname'])){
CRM_Utils_PseudoConstant::flushConstant($apiRequest['params']['fieldname']);
}
$lcase_entity = _civicrm_api_get_entity_name_from_camel($entity);
$subentity = CRM_Utils_Array::value('contact_type', $apiRequest['params']);
$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') {
$action = 'get';
}
// determines whether to use unique field names - seem comment block above
$unique = TRUE;
- if (isset($results[$entity . $subentity]) && CRM_Utils_Array::value($action, $results[$entity])
- && empty($apiOptions)) {
- return $results[$entity . $subentity][$action];
+ if (empty($apiOptions) && isset($results[$entity . $subentity]) && isset($action, $results[$entity . $subentity])
+ && isset($action, $results[$entity . $subentity][$sequential])) {
+ return $results[$entity . $subentity][$action][$sequential];
}
// defaults based on data model and API policy
switch ($action) {
case 'getfields':
$values = _civicrm_api_get_fields($entity, false, $apiRequest['params']);
- $results[$entity][$action] = civicrm_api3_create_success($values,
- $apiRequest['params'], $entity, 'getfields'
- );
- return $results[$entity][$action];
-
- case 'getfields':
- return civicrm_api3_create_success(_civicrm_api_get_fields($apiRequest['entity']));
+ return civicrm_api3_create_success($values, $apiRequest['params'], $entity, 'getfields');
case 'create':
case 'update':
case 'replace':
// inconsistency
$metadata['id']['api.aliases'] = array($lcase_entity . '_id');
}
-
break;
case 'delete':
'id' => array('title' => 'Unique Identifier',
'api.required' => 1,
'api.aliases' => array($lcase_entity . '_id'),
+ 'type' => CRM_Utils_Type::T_INT,
));
break;
case 'getoptions':
$metadata = array(
- 'field' => array('title' => 'Field to retrieve options for',
- 'api.required' => 1,
- ));
+ 'field' => array(
+ 'title' => 'Field to retrieve options for',
+ 'api.required' => 1,
+ ),
+ 'context' => array(
+ 'title' => 'Context string',
+ ),
+ );
break;
default:
// oddballs are on their own
$helper = '_' . $hypApiRequest['function'] . '_spec';
if (function_exists($helper)) {
// alter
- $helper($metadata);
+ $helper($metadata, $apiRequest);
}
- $fieldsToResolve = CRM_Utils_Array::value('get_options', $apiOptions, array());
+ $fieldsToResolve = (array) CRM_Utils_Array::value('get_options', $apiOptions, array());
foreach ($metadata as $fieldname => $fieldSpec) {
- _civicrm_api3_generic_get_metadata_options($metadata, $fieldname, $fieldSpec, $fieldsToResolve);
+ _civicrm_api3_generic_get_metadata_options($metadata, $apiRequest['entity'], $fieldname, $fieldSpec, $fieldsToResolve);
}
- $results[$entity][$action] = civicrm_api3_create_success($metadata, $apiRequest['params'], NULL, 'getfields');
- return $results[$entity][$action];
+ $results[$entity][$action][$sequential] = civicrm_api3_create_success($metadata, $apiRequest['params'], NULL, 'getfields');
+ return $results[$entity][$action][$sequential];
}
/**
* @return integer count of results
*/
function civicrm_api3_generic_getcount($apiRequest) {
+ $apiRequest['params']['options']['is_count'] = TRUE;
$result = civicrm_api($apiRequest['entity'], 'get', $apiRequest['params']);
+ if(is_numeric (CRM_Utils_Array::value('values', $result))) {
+ return (int) $result['values'];
+ }
+ if(!isset($result['count'])) {
+ throw new API_Exception(ts('Unexpected result from getcount') . print_r($result, TRUE));
+ }
return $result['count'];
}
/**
* API wrapper for getoptions function
*
- * @param array $apiRequest api request as an array. Keys are
+ * @param array $apiRequest api request as an array.
*
* @return array of results
*/
function civicrm_api3_generic_getoptions($apiRequest) {
- $field = $apiRequest['params']['field'];
- $getFieldsArray = array(
- 'version' => 3,
- 'action' => 'create',
- 'options' => array('get_options' => $field),
- );
- // First try to retrieve the options from getfields
- $result = civicrm_api($apiRequest['entity'], 'getfields', $getFieldsArray);
- if (!isset($result['values'][$field]) && isset($result['values'][$field . '_id'])) {
- $field = $field . '_id';
+ // Resolve aliases
+ $fieldName = _civicrm_api3_api_resolve_alias($apiRequest['entity'], $apiRequest['params']['field']);
+ if (!$fieldName) {
+ return civicrm_api3_create_error("The field '{$apiRequest['params']['field']}' doesn't exist.");
}
- if (!empty($result['values'][$field]['options'])) {
- return civicrm_api3_create_success($result['values'][$field]['options']);
- }
- // If that didn't work, try the constant api
- if (substr($field, -3) == '_id') {
- // Convert foo_id to just plain foo
- $field = substr($field, 0, -3);
- }
- $params = array('name' => _civicrm_api_get_camel_name($field));
- $entity = strtolower($apiRequest['entity']);
- if ($entity == 'contribution') {
- $params['class'] = 'CRM_Contribute_PseudoConstant';
- }
- elseif ($entity == 'event' || $entity == 'participant') {
- $params['class'] = 'CRM_Event_PseudoConstant';
+ // 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 = $output = $baoName::buildOptions($fieldName, $context, $apiRequest['params']);
+ if ($options === FALSE) {
+ return civicrm_api3_create_error("The field '{$fieldName}' has no associated option list.");
}
- elseif (strpos($entity, 'membership') === 0) {
- $params['class'] = 'CRM_Member_PseudoConstant';
+ // 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);
+ }
}
- require_once 'api/v3/Constant.php';
- return civicrm_api3_constant_get($params);
+ return civicrm_api3_create_success($output);
}
/**
* @param array $fieldSpec metadata for that field
* @param array $fieldsToResolve anny field resolutions specifically requested
*/
-function _civicrm_api3_generic_get_metadata_options(&$metadata, $fieldname, $fieldSpec, $fieldsToResolve){
- if (array_key_exists('enumValues', $fieldSpec)) {
- // use of a space after the comma is inconsistent in xml
- $enumStr = str_replace(', ', ',', $fieldSpec['enumValues']);
- $metadata[$fieldname]['options'] = explode(',', $enumStr);
+function _civicrm_api3_generic_get_metadata_options(&$metadata, $entity, $fieldname, $fieldSpec, $fieldsToResolve){
+ if(empty($fieldSpec['pseudoconstant']) && empty($fieldSpec['enumValues'])) {
return;
}
- if(empty($fieldSpec['pseudoconstant'])){
- return ;
- }
- elseif(!empty($fieldSpec['FKClassName']) && !in_array($fieldname, $fieldsToResolve)){
+ if (!empty($metadata[$fieldname]['options']) || (!in_array($fieldname, $fieldsToResolve) && !in_array('all', $fieldsToResolve))) {
return;
}
- if(substr($fieldname, -3) == '_id'){
- $metadata[$fieldname]['api.aliases'][] = substr($fieldname, 0, -3);
- }
- $pseudoParams = $fieldSpec['pseudoconstant'];
- $pseudoParams['version'] = 3;
- $options = civicrm_api('constant', 'get', $pseudoParams);
+ $options = civicrm_api($entity, 'getoptions', array('version' => 3, 'field' => $fieldname));
if (is_array(CRM_Utils_Array::value('values', $options))) {
$metadata[$fieldname]['options'] = $options['values'];
}
projects / civicrm-core.git / blobdiff