3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2015 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
29 * @package CiviCRM_APIv3
33 * Get information about fields for a given api request.
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
43 * @param array $apiRequest
44 * Api request as an array. Keys are.
48 * - function: callback (mixed)
49 * - params: array, varies
54 function civicrm_api3_generic_getfields($apiRequest) {
55 static $results = array();
56 if ((CRM_Utils_Array
::value('cache_clear', $apiRequest['params']))) {
58 // we will also clear pseudoconstants here - should potentially be moved to relevant BAO classes
59 CRM_Core_PseudoConstant
::flush();
60 if (!empty($apiRequest['params']['fieldname'])) {
61 CRM_Utils_PseudoConstant
::flushConstant($apiRequest['params']['fieldname']);
63 if (!empty($apiRequest['params']['option_group_id'])) {
64 $optionGroupName = civicrm_api('option_group', 'getvalue', array(
66 'id' => $apiRequest['params']['option_group_id'],
69 if (is_string($optionGroupName)) {
70 CRM_Utils_PseudoConstant
::flushConstant(_civicrm_api_get_camel_name($optionGroupName));
74 $entity = $apiRequest['entity'];
75 $lowercase_entity = _civicrm_api_get_entity_name_from_camel($entity);
76 $subentity = CRM_Utils_Array
::value('contact_type', $apiRequest['params']);
77 $action = CRM_Utils_Array
::value('action', $apiRequest['params']);
78 $sequential = empty($apiRequest['params']['sequential']) ?
0 : 1;
79 $apiRequest['params']['options'] = CRM_Utils_Array
::value('options', $apiRequest['params'], array());
80 $optionsToResolve = (array) CRM_Utils_Array
::value('get_options', $apiRequest['params']['options'], array());
82 if (!$action ||
$action == 'getvalue' ||
$action == 'getcount') {
85 // determines whether to use unique field names - see comment block above
87 // If no options, return results from cache
88 if (!$apiRequest['params']['options'] && isset($results[$entity . $subentity]) && isset($action, $results[$entity . $subentity])
89 && isset($action, $results[$entity . $subentity][$sequential])) {
90 return $results[$entity . $subentity][$action][$sequential];
92 // defaults based on data model and API policy
95 $values = _civicrm_api_get_fields($entity, FALSE, $apiRequest['params']);
96 return civicrm_api3_create_success($values, $apiRequest['params'], $entity, 'getfields');
106 $metadata = _civicrm_api_get_fields($apiRequest['entity'], $unique, $apiRequest['params']);
107 if (empty($metadata['id'])) {
108 // if id is not set we will set it eg. 'id' from 'case_id', case_id will be an alias
109 if (!empty($metadata[strtolower($apiRequest['entity']) . '_id'])) {
110 $metadata['id'] = $metadata[$lowercase_entity . '_id'];
111 unset($metadata[$lowercase_entity . '_id']);
112 $metadata['id']['api.aliases'] = array($lowercase_entity . '_id');
116 // really the preference would be to set the unique name in the xml
117 // question is which is a less risky fix this close to a release - setting in xml for the known failure
118 // (note) or setting for all api where fields is returning 'id' & we want to accept 'note_id' @ the api layer
119 // nb we don't officially accept note_id anyway - rationale here is more about centralising a now-tested
121 $metadata['id']['api.aliases'] = array($lowercase_entity . '_id');
128 'title' => $entity . ' ID',
130 'api.aliases' => array($lowercase_entity . '_id'),
131 'type' => CRM_Utils_Type
::T_INT
,
135 // Note: adding setvalue case here instead of in a generic spec function because
136 // some APIs override the generic setvalue fn which causes the generic spec to be overlooked.
140 'title' => 'Field name',
142 'type' => CRM_Utils_Type
::T_STRING
,
145 'title' => $entity . ' ID',
147 'type' => CRM_Utils_Type
::T_INT
,
151 'description' => "Field value to set",
155 if (array_intersect(array('all', 'field'), $optionsToResolve)) {
156 $options = civicrm_api3_generic_getfields(array('entity' => $entity, array('params' => array('action' => 'create'))));
157 $metadata['field']['options'] = CRM_Utils_Array
::collect('title', $options['values']);
162 // oddballs are on their own
166 // Normalize this for the sake of spec funcions
167 $apiRequest['params']['options']['get_options'] = $optionsToResolve;
169 // find any supplemental information
170 $hypApiRequest = array('entity' => $apiRequest['entity'], 'action' => $action, 'version' => $apiRequest['version']);
172 list ($apiProvider, $hypApiRequest) = \Civi\Core\Container
::singleton()->get('civi_api_kernel')->resolve($hypApiRequest);
173 if (isset($hypApiRequest['function'])) {
174 $helper = '_' . $hypApiRequest['function'] . '_spec';
177 // not implemented MagicFunctionProvider
181 catch (\Civi\API\Exception\NotImplementedException
$e) {
184 if (function_exists($helper)) {
186 $helper($metadata, $apiRequest);
189 foreach ($metadata as $fieldname => $fieldSpec) {
190 // Ensure 'name' is set
191 if (!isset($fieldSpec['name'])) {
192 $metadata[$fieldname]['name'] = $fieldname;
194 _civicrm_api3_generic_get_metadata_options($metadata, $apiRequest, $fieldname, $fieldSpec);
196 // Convert options to "sequential" format
197 if ($sequential && !empty($metadata[$fieldname]['options'])) {
198 $metadata[$fieldname]['options'] = CRM_Utils_Array
::makeNonAssociative($metadata[$fieldname]['options']);
202 $results[$entity][$action][$sequential] = civicrm_api3_create_success($metadata, $apiRequest['params'], $entity, 'getfields');
203 return $results[$entity][$action][$sequential];
207 * API return function to reformat results as count.
209 * @param array $apiRequest
210 * Api request as an array. Keys are.
212 * @throws API_Exception
216 function civicrm_api3_generic_getcount($apiRequest) {
217 $apiRequest['params']['options']['is_count'] = TRUE;
218 $result = civicrm_api($apiRequest['entity'], 'get', $apiRequest['params']);
219 if (is_numeric(CRM_Utils_Array
::value('values', $result))) {
220 return (int) $result['values'];
222 if (!isset($result['count'])) {
223 throw new API_Exception(ts('Unexpected result from getcount') . print_r($result, TRUE));
225 return $result['count'];
229 * API return function to reformat results as single result.
231 * @param array $apiRequest
232 * Api request as an array. Keys are.
237 function civicrm_api3_generic_getsingle($apiRequest) {
238 // So the first entity is always result['values'][0].
239 $apiRequest['params']['sequential'] = 1;
240 $result = civicrm_api($apiRequest['entity'], 'get', $apiRequest['params']);
241 if ($result['is_error'] !== 0) {
244 if ($result['count'] === 1) {
245 return $result['values'][0];
247 if ($result['count'] !== 1) {
248 return civicrm_api3_create_error("Expected one " . $apiRequest['entity'] . " but found " . $result['count'], array('count' => $result['count']));
250 return civicrm_api3_create_error("Undefined behavior");
254 * API return function to reformat results as single value.
256 * @param array $apiRequest
257 * Api request as an array. Keys are.
262 function civicrm_api3_generic_getvalue($apiRequest) {
263 $apiRequest['params']['sequential'] = 1;
264 $result = civicrm_api($apiRequest['entity'], 'get', $apiRequest['params']);
265 if ($result['is_error'] !== 0) {
268 if ($result['count'] !== 1) {
269 $result = civicrm_api3_create_error("Expected one " . $apiRequest['entity'] . " but found " . $result['count'], array('count' => $result['count']));
273 // we only take "return=" as valid options
274 if (!empty($apiRequest['params']['return'])) {
275 if (!isset($result['values'][0][$apiRequest['params']['return']])) {
276 return civicrm_api3_create_error("field " . $apiRequest['params']['return'] . " unset or not existing", array('invalid_field' => $apiRequest['params']['return']));
279 return $result['values'][0][$apiRequest['params']['return']];
282 return civicrm_api3_create_error("missing param return=field you want to read the value of", array('error_type' => 'mandatory_missing', 'missing_param' => 'return'));
286 * Get count of contact references.
288 * @param array $params
290 function _civicrm_api3_generic_getrefcount_spec(&$params, $apiRequest) {
291 $params['id']['api.required'] = 1;
292 $params['id']['title'] = $apiRequest['entity'] . ' ID';
293 $params['id']['type'] = CRM_Utils_Type
::T_INT
;
297 * API to determine if a record is in-use.
299 * @param array $apiRequest
300 * Api request as an array.
302 * @throws API_Exception
304 * API result (int 0 or 1)
306 function civicrm_api3_generic_getrefcount($apiRequest) {
307 $entityToClassMap = CRM_Core_DAO_AllCoreTables
::daoToClass();
308 if (!isset($entityToClassMap[$apiRequest['entity']])) {
309 throw new API_Exception("The entity '{$apiRequest['entity']}' is unknown or unsupported by 'getrefcount'. Consider implementing this API.", 'getrefcount_unsupported');
311 $daoClass = $entityToClassMap[$apiRequest['entity']];
313 /* @var $dao CRM_Core_DAO */
314 $dao = new $daoClass();
315 $dao->id
= $apiRequest['params']['id'];
316 if ($dao->find(TRUE)) {
317 return civicrm_api3_create_success($dao->getReferenceCounts());
320 return civicrm_api3_create_success(array());
325 * API wrapper for replace function.
327 * @param array $apiRequest
328 * Api request as an array. Keys are.
333 function civicrm_api3_generic_replace($apiRequest) {
334 return _civicrm_api3_generic_replace($apiRequest['entity'], $apiRequest['params']);
338 * API wrapper for getoptions function.
340 * @param array $apiRequest
341 * Api request as an array.
346 function civicrm_api3_generic_getoptions($apiRequest) {
348 $fieldName = _civicrm_api3_api_resolve_alias($apiRequest['entity'], $apiRequest['params']['field']);
350 return civicrm_api3_create_error("The field '{$apiRequest['params']['field']}' doesn't exist.");
352 // Validate 'context' from params
353 $context = CRM_Utils_Array
::value('context', $apiRequest['params']);
354 CRM_Core_DAO
::buildOptionsContext($context);
355 unset($apiRequest['params']['context'], $apiRequest['params']['field']);
357 $baoName = _civicrm_api3_get_BAO($apiRequest['entity']);
358 $options = $baoName::buildOptions($fieldName, $context, $apiRequest['params']);
359 if ($options === FALSE) {
360 return civicrm_api3_create_error("The field '{$fieldName}' has no associated option list.");
362 // Support 'sequential' output as a non-associative array
363 if (!empty($apiRequest['params']['sequential'])) {
364 $options = CRM_Utils_Array
::makeNonAssociative($options);
366 return civicrm_api3_create_success($options, $apiRequest['params'], $apiRequest['entity'], 'getoptions');
370 * Provide metadata for this generic action
375 function _civicrm_api3_generic_getoptions_spec(&$params, $apiRequest) {
378 'title' => 'Field name',
380 'type' => CRM_Utils_Type
::T_STRING
,
383 'title' => 'Context',
384 'type' => CRM_Utils_Type
::T_STRING
,
385 'options' => CRM_Core_DAO
::buildOptionsContext(),
389 // Add available fields if requested
390 if (array_intersect(array('all', 'field'), $apiRequest['params']['options']['get_options'])) {
391 $fields = civicrm_api3_generic_getfields(array('entity' => $apiRequest['entity'], array('params' => array('action' => 'create'))));
392 $params['field']['options'] = array();
393 foreach ($fields['values'] as $name => $field) {
394 if (isset($field['pseudoconstant']) || CRM_Utils_Array
::value('type', $field) == CRM_Utils_Type
::T_BOOLEAN
) {
395 $params['field']['options'][$name] = CRM_Utils_Array
::value('title', $field, $name);
404 * Function fills the 'options' array on the metadata returned by getfields if
405 * 1) the param option 'get_options' is defined - e.g. $params['options']['get_options'] => array('custom_1)
406 * (this is passed in as the $fieldsToResolve array)
407 * 2) the field is a pseudoconstant and is NOT an FK
408 * - the reason for this is that checking / transformation is done on pseudoconstants but
409 * - if the field is an FK then mysql will enforce the data quality (& we have handling on failure)
410 * @todo - if may be we should define a 'resolve' key on the pseudoconstant for when these rules are not fine enough
412 * This function is only split out for the purpose of code clarity / comment block documentation
414 * @param array $metadata
415 * The array of metadata that will form the result of the getfields function.
416 * @param array $apiRequest
417 * @param string $fieldname
418 * Field currently being processed.
419 * @param array $fieldSpec
420 * Metadata for that field.
422 function _civicrm_api3_generic_get_metadata_options(&$metadata, $apiRequest, $fieldname, $fieldSpec) {
423 if (empty($fieldSpec['pseudoconstant']) && empty($fieldSpec['option_group_id'])) {
427 $fieldsToResolve = $apiRequest['params']['options']['get_options'];
429 if (!empty($metadata[$fieldname]['options']) ||
(!in_array($fieldname, $fieldsToResolve) && !in_array('all', $fieldsToResolve))) {
433 // Allow caller to specify context
434 $context = CRM_Utils_Array
::value('get_options_context', $apiRequest['params']['options']);
435 // Default to api action if it is a supported context.
437 $action = CRM_Utils_Array
::value('action', $apiRequest['params']);
438 $contexts = CRM_Core_DAO
::buildOptionsContext();
439 if (isset($contexts[$action])) {
444 $options = civicrm_api($apiRequest['entity'], 'getoptions', array('version' => 3, 'field' => $fieldname, 'context' => $context));
445 if (is_array(CRM_Utils_Array
::value('values', $options))) {
446 $metadata[$fieldname]['options'] = $options['values'];