4 * Get information about fields for a given api request. Getfields information
5 * is used for documentation, validation, default setting
6 * We first query the scheme using the $dao->fields function & then augment
7 * that information by calling the _spec functions that apply to the relevant function
8 * Note that we use 'unique' field names as described in the xml/schema files
9 * for get requests & just field name for create. This is because some get functions
10 * access multiple objects e.g. contact api accesses is_deleted from the activity
11 * table & from the contact table
13 * @param array $apiRequest
14 * Api request as an array. Keys are.
18 * - function: callback (mixed)
19 * - params: array, varies
20 * @return array API success object
22 function civicrm_api3_generic_getfields($apiRequest) {
23 static $results = array();
24 if ((CRM_Utils_Array
::value('cache_clear', $apiRequest['params']))) {
26 // we will also clear pseudoconstants here - should potentially be moved to relevant BAO classes
27 CRM_Core_PseudoConstant
::flush();
28 if (!empty($apiRequest['params']['fieldname'])) {
29 CRM_Utils_PseudoConstant
::flushConstant($apiRequest['params']['fieldname']);
31 if (!empty($apiRequest['params']['option_group_id'])) {
32 $optionGroupName = civicrm_api('option_group', 'getvalue', array('version' => 3, 'id' => $apiRequest['params']['option_group_id'], 'return' => 'name'));
33 if (is_string($optionGroupName)) {
34 CRM_Utils_PseudoConstant
::flushConstant(_civicrm_api_get_camel_name($optionGroupName));
38 $entity = _civicrm_api_get_camel_name($apiRequest['entity']);
39 $lcase_entity = _civicrm_api_get_entity_name_from_camel($entity);
40 $subentity = CRM_Utils_Array
::value('contact_type', $apiRequest['params']);
41 $action = strtolower(CRM_Utils_Array
::value('action', $apiRequest['params']));
42 $sequential = empty($apiRequest['params']) ?
0 : 1;
43 $apiOptions = CRM_Utils_Array
::value('options', $apiRequest['params'], array());
44 if (!$action ||
$action == 'getvalue' ||
$action == 'getcount') {
47 // determines whether to use unique field names - seem comment block above
49 if (empty($apiOptions) && isset($results[$entity . $subentity]) && isset($action, $results[$entity . $subentity])
50 && isset($action, $results[$entity . $subentity][$sequential])) {
51 return $results[$entity . $subentity][$action][$sequential];
53 // defaults based on data model and API policy
56 $values = _civicrm_api_get_fields($entity, FALSE, $apiRequest['params']);
57 return civicrm_api3_create_success($values, $apiRequest['params'], $entity, 'getfields');
65 $metadata = _civicrm_api_get_fields($apiRequest['entity'], $unique, $apiRequest['params']);
66 if (empty($metadata['id'])) {
67 // if id is not set we will set it eg. 'id' from 'case_id', case_id will be an alias
68 if (!empty($metadata[strtolower($apiRequest['entity']) . '_id'])) {
69 $metadata['id'] = $metadata[$lcase_entity . '_id'];
70 unset($metadata[$lcase_entity . '_id']);
71 $metadata['id']['api.aliases'] = array($lcase_entity . '_id');
75 // really the preference would be to set the unique name in the xml
76 // question is which is a less risky fix this close to a release - setting in xml for the known failure
77 // (note) or setting for all api where fields is returning 'id' & we want to accept 'note_id' @ the api layer
78 // nb we don't officially accept note_id anyway - rationale here is more about centralising a now-tested
80 $metadata['id']['api.aliases'] = array($lcase_entity . '_id');
87 'title' => $entity . ' ID',
90 'api.aliases' => array($lcase_entity . '_id'),
91 'type' => CRM_Utils_Type
::T_INT
,
99 'title' => 'Field name',
104 'title' => 'Context',
109 // oddballs are on their own
113 // find any supplemental information
114 $hypApiRequest = array('entity' => $apiRequest['entity'], 'action' => $action, 'version' => $apiRequest['version']);
116 list ($apiProvider, $hypApiRequest) = \Civi\Core\Container
::singleton()->get('civi_api_kernel')->resolve($hypApiRequest);
117 if (isset($hypApiRequest['function'])) {
118 $helper = '_' . $hypApiRequest['function'] . '_spec';
121 // not implemented MagicFunctionProvider
125 catch (\Civi\API\Exception\NotImplementedException
$e) {
128 if (function_exists($helper)) {
130 $helper($metadata, $apiRequest);
133 $fieldsToResolve = (array) CRM_Utils_Array
::value('get_options', $apiOptions, array());
135 foreach ($metadata as $fieldname => $fieldSpec) {
136 _civicrm_api3_generic_get_metadata_options($metadata, $apiRequest, $fieldname, $fieldSpec, $fieldsToResolve);
139 $results[$entity][$action][$sequential] = civicrm_api3_create_success($metadata, $apiRequest['params'], $entity, 'getfields');
140 return $results[$entity][$action][$sequential];
144 * API return function to reformat results as count
146 * @param array $apiRequest
147 * Api request as an array. Keys are.
149 * @throws API_Exception
150 * @return integer count of results
152 function civicrm_api3_generic_getcount($apiRequest) {
153 $apiRequest['params']['options']['is_count'] = TRUE;
154 $result = civicrm_api($apiRequest['entity'], 'get', $apiRequest['params']);
155 if (is_numeric(CRM_Utils_Array
::value('values', $result))) {
156 return (int) $result['values'];
158 if (!isset($result['count'])) {
159 throw new API_Exception(ts('Unexpected result from getcount') . print_r($result, TRUE));
161 return $result['count'];
165 * API return function to reformat results as single result
167 * @param array $apiRequest
168 * Api request as an array. Keys are.
170 * @return integer count of results
172 function civicrm_api3_generic_getsingle($apiRequest) {
173 // so the first entity is always result['values'][0]
174 $apiRequest['params']['sequential'] = 1;
175 $result = civicrm_api($apiRequest['entity'], 'get', $apiRequest['params']);
176 if ($result['is_error'] !== 0) {
179 if ($result['count'] === 1) {
180 return $result['values'][0];
182 if ($result['count'] !== 1) {
183 return civicrm_api3_create_error("Expected one " . $apiRequest['entity'] . " but found " . $result['count'], array('count' => $result['count']));
185 return civicrm_api3_create_error("Undefined behavior");
189 * API return function to reformat results as single value
191 * @param array $apiRequest
192 * Api request as an array. Keys are.
194 * @return integer count of results
196 function civicrm_api3_generic_getvalue($apiRequest) {
197 $apiRequest['params']['sequential'] = 1;
198 $result = civicrm_api($apiRequest['entity'], 'get', $apiRequest['params']);
199 if ($result['is_error'] !== 0) {
202 if ($result['count'] !== 1) {
203 $result = civicrm_api3_create_error("Expected one " . $apiRequest['entity'] . " but found " . $result['count'], array('count' => $result['count']));
207 // we only take "return=" as valid options
208 if (!empty($apiRequest['params']['return'])) {
209 if (!isset($result['values'][0][$apiRequest['params']['return']])) {
210 return civicrm_api3_create_error("field " . $apiRequest['params']['return'] . " unset or not existing", array('invalid_field' => $apiRequest['params']['return']));
213 return $result['values'][0][$apiRequest['params']['return']];
216 return civicrm_api3_create_error("missing param return=field you want to read the value of", array('error_type' => 'mandatory_missing', 'missing_param' => 'return'));
220 * @param array $params
222 function _civicrm_api3_generic_getrefcount_spec(&$params) {
223 $params['id']['api.required'] = 1;
224 $params['id']['title'] = 'Entity ID';
228 * API to determine if a record is in-use
230 * @param array $apiRequest
231 * Api request as an array.
233 * @throws API_Exception
234 * @return array API result (int 0 or 1)
236 function civicrm_api3_generic_getrefcount($apiRequest) {
237 $entityToClassMap = CRM_Core_DAO_AllCoreTables
::daoToClass();
238 if (!isset($entityToClassMap[$apiRequest['entity']])) {
239 throw new API_Exception("The entity '{$apiRequest['entity']}' is unknown or unsupported by 'getrefcount'. Consider implementing this API.", 'getrefcount_unsupported');
241 $daoClass = $entityToClassMap[$apiRequest['entity']];
243 /* @var $dao CRM_Core_DAO */
244 $dao = new $daoClass();
245 $dao->id
= $apiRequest['params']['id'];
246 if ($dao->find(TRUE)) {
247 return civicrm_api3_create_success($dao->getReferenceCounts());
250 return civicrm_api3_create_success(array());
255 * API wrapper for replace function
257 * @param array $apiRequest
258 * Api request as an array. Keys are.
260 * @return integer count of results
262 function civicrm_api3_generic_replace($apiRequest) {
263 return _civicrm_api3_generic_replace($apiRequest['entity'], $apiRequest['params']);
267 * API wrapper for getoptions function
269 * @param array $apiRequest
270 * Api request as an array.
272 * @return array of results
274 function civicrm_api3_generic_getoptions($apiRequest) {
276 $fieldName = _civicrm_api3_api_resolve_alias($apiRequest['entity'], $apiRequest['params']['field']);
278 return civicrm_api3_create_error("The field '{$apiRequest['params']['field']}' doesn't exist.");
280 // Validate 'context' from params
281 $context = CRM_Utils_Array
::value('context', $apiRequest['params']);
282 CRM_Core_DAO
::buildOptionsContext($context);
283 unset($apiRequest['params']['context'], $apiRequest['params']['field']);
285 $baoName = _civicrm_api3_get_BAO($apiRequest['entity']);
286 $options = $baoName::buildOptions($fieldName, $context, $apiRequest['params']);
287 if ($options === FALSE) {
288 return civicrm_api3_create_error("The field '{$fieldName}' has no associated option list.");
290 // Support 'sequential' output as a non-associative array
291 if (!empty($apiRequest['params']['sequential'])) {
292 $options = CRM_Utils_Array
::makeNonAssociative($options);
294 return civicrm_api3_create_success($options, $apiRequest['params'], $apiRequest['entity'], 'getoptions');
298 * Function fills the 'options' array on the metadata returned by getfields if
299 * 1) the param option 'get_options' is defined - e.g. $params['options']['get_options'] => array('custom_1)
300 * (this is passed in as the $fieldsToResolve array)
301 * 2) the field is a pseudoconstant and is NOT an FK
302 * - the reason for this is that checking / transformation is done on pseudoconstants but
303 * - if the field is an FK then mysql will enforce the data quality (& we have handling on failure)
304 * @todo - if may be we should define a 'resolve' key on the pseudoconstant for when these rules are not fine enough
306 * This function is only split out for the purpose of code clarity / comment block documentation
308 * @param array $metadata
309 * The array of metadata that will form the result of the getfields function.
311 * @param string $fieldname
312 * Field currently being processed.
313 * @param array $fieldSpec
314 * Metadata for that field.
315 * @param array $fieldsToResolve
316 * Anny field resolutions specifically requested.
318 function _civicrm_api3_generic_get_metadata_options(&$metadata, $apiRequest, $fieldname, $fieldSpec, $fieldsToResolve) {
319 if (empty($fieldSpec['pseudoconstant']) && empty($fieldSpec['option_group_id'])) {
323 if (!empty($metadata[$fieldname]['options']) ||
(!in_array($fieldname, $fieldsToResolve) && !in_array('all', $fieldsToResolve))) {
327 $options = civicrm_api($apiRequest['entity'], 'getoptions', array('version' => 3, 'field' => $fieldname, 'sequential' => !empty($apiRequest['params']['sequential'])));
328 if (is_array(CRM_Utils_Array
::value('values', $options))) {
329 $metadata[$fieldname]['options'] = $options['values'];