api/v3/Generic.php

   1 <?php
   2
   3 /**
   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
  12  *
  13  * @param array $apiRequest
  14  *   Api request as an array. Keys are.
  15  *  - entity: string
  16  *  - action: string
  17  *  - version: string
  18  *  - function: callback (mixed)
  19  *  - params: array, varies
  20  * @return array
  21    *   API success object
  22  */
  23 function civicrm_api3_generic_getfields($apiRequest) {
  24   static $results = array();
  25   if ((CRM_Utils_Array::value('cache_clear', $apiRequest['params']))) {
  26     $results = array();
  27     // we will also clear pseudoconstants here - should potentially be moved to relevant BAO classes
  28     CRM_Core_PseudoConstant::flush();
  29     if (!empty($apiRequest['params']['fieldname'])) {
  30       CRM_Utils_PseudoConstant::flushConstant($apiRequest['params']['fieldname']);
  31     }
  32     if (!empty($apiRequest['params']['option_group_id'])) {
  33       $optionGroupName = civicrm_api('option_group', 'getvalue', array('version' => 3, 'id' => $apiRequest['params']['option_group_id'], 'return' => 'name'));
  34       if (is_string($optionGroupName)) {
  35         CRM_Utils_PseudoConstant::flushConstant(_civicrm_api_get_camel_name($optionGroupName));
  36       }
  37     }
  38   }
  39   $entity       = _civicrm_api_get_camel_name($apiRequest['entity']);
  40   $lcase_entity = _civicrm_api_get_entity_name_from_camel($entity);
  41   $subentity    = CRM_Utils_Array::value('contact_type', $apiRequest['params']);
  42   $action       = strtolower(CRM_Utils_Array::value('action', $apiRequest['params']));
  43   $sequential = empty($apiRequest['params']) ? 0 : 1;
  44   $apiOptions = CRM_Utils_Array::value('options', $apiRequest['params'], array());
  45   if (!$action || $action == 'getvalue' || $action == 'getcount') {
  46     $action = 'get';
  47   }
  48   // determines whether to use unique field names - seem comment block above
  49   $unique = TRUE;
  50   if (empty($apiOptions) && isset($results[$entity . $subentity]) && isset($action, $results[$entity . $subentity])
  51     && isset($action, $results[$entity . $subentity][$sequential])) {
  52     return $results[$entity . $subentity][$action][$sequential];
  53   }
  54   // defaults based on data model and API policy
  55   switch ($action) {
  56     case 'getfields':
  57       $values = _civicrm_api_get_fields($entity, FALSE, $apiRequest['params']);
  58       return civicrm_api3_create_success($values, $apiRequest['params'], $entity, 'getfields');
  59     case 'create':
  60     case 'update':
  61     case 'replace':
  62       $unique = FALSE;
  63     case 'get':
  64     case 'getsingle':
  65     case 'getcount':
  66       $metadata = _civicrm_api_get_fields($apiRequest['entity'], $unique, $apiRequest['params']);
  67       if (empty($metadata['id'])) {
  68         // if id is not set we will set it eg. 'id' from 'case_id', case_id will be an alias
  69         if (!empty($metadata[strtolower($apiRequest['entity']) . '_id'])) {
  70           $metadata['id'] = $metadata[$lcase_entity . '_id'];
  71           unset($metadata[$lcase_entity . '_id']);
  72           $metadata['id']['api.aliases'] = array($lcase_entity . '_id');
  73         }
  74       }
  75       else {
  76         // really the preference would be to set the unique name in the xml
  77         // question is which is a less risky fix this close to a release - setting in xml for the known failure
  78         // (note) or setting for all api where fields is returning 'id' & we want to accept 'note_id' @ the api layer
  79         // nb we don't officially accept note_id anyway - rationale here is more about centralising a now-tested
  80         // inconsistency
  81         $metadata['id']['api.aliases'] = array($lcase_entity . '_id');
  82       }
  83       break;
  84
  85     case 'delete':
  86       $metadata = array(
  87         'id' => array(
  88           'title' => $entity . ' ID',
  89           'name' => 'id',
  90           'api.required' => 1,
  91           'api.aliases' => array($lcase_entity . '_id'),
  92           'type' => CRM_Utils_Type::T_INT,
  93         ));
  94       break;
  95
  96     case 'getoptions':
  97       $metadata = array(
  98         'field' => array(
  99           'name' => 'field',
 100           'title' => 'Field name',
 101           'api.required' => 1,
 102         ),
 103         'context' => array(
 104           'name' => 'context',
 105           'title' => 'Context',
 106         ),
 107       );
 108       break;
 109
 110     default:
 111       // oddballs are on their own
 112       $metadata = array();
 113   }
 114
 115   // find any supplemental information
 116   $hypApiRequest = array('entity' => $apiRequest['entity'], 'action' => $action, 'version' => $apiRequest['version']);
 117   try {
 118     list ($apiProvider, $hypApiRequest) = \Civi\Core\Container::singleton()->get('civi_api_kernel')->resolve($hypApiRequest);
 119     if (isset($hypApiRequest['function'])) {
 120       $helper = '_' . $hypApiRequest['function'] . '_spec';
 121     }
 122     else {
 123       // not implemented MagicFunctionProvider
 124       $helper = NULL;
 125     }
 126   }
 127   catch (\Civi\API\Exception\NotImplementedException $e) {
 128     $helper = NULL;
 129   }
 130   if (function_exists($helper)) {
 131     // alter
 132     $helper($metadata, $apiRequest);
 133   }
 134
 135   $fieldsToResolve = (array) CRM_Utils_Array::value('get_options', $apiOptions, array());
 136
 137   foreach ($metadata as $fieldname => $fieldSpec) {
 138     _civicrm_api3_generic_get_metadata_options($metadata, $apiRequest, $fieldname, $fieldSpec, $fieldsToResolve);
 139   }
 140
 141   $results[$entity][$action][$sequential] = civicrm_api3_create_success($metadata, $apiRequest['params'], $entity, 'getfields');
 142   return $results[$entity][$action][$sequential];
 143 }
 144
 145 /**
 146  * API return function to reformat results as count
 147  *
 148  * @param array $apiRequest
 149  *   Api request as an array. Keys are.
 150  *
 151  * @throws API_Exception
 152  * @return integer
 153    *   count of results
 154  */
 155 function civicrm_api3_generic_getcount($apiRequest) {
 156   $apiRequest['params']['options']['is_count'] = TRUE;
 157   $result = civicrm_api($apiRequest['entity'], 'get', $apiRequest['params']);
 158   if (is_numeric(CRM_Utils_Array::value('values', $result))) {
 159     return (int) $result['values'];
 160   }
 161   if (!isset($result['count'])) {
 162     throw new API_Exception(ts('Unexpected result from getcount') . print_r($result, TRUE));
 163   }
 164   return $result['count'];
 165 }
 166
 167 /**
 168  * API return function to reformat results as single result
 169  *
 170  * @param array $apiRequest
 171  *   Api request as an array. Keys are.
 172  *
 173  * @return integer
 174    *   count of results
 175  */
 176 function civicrm_api3_generic_getsingle($apiRequest) {
 177   // so the first entity is always result['values'][0]
 178   $apiRequest['params']['sequential'] = 1;
 179   $result = civicrm_api($apiRequest['entity'], 'get', $apiRequest['params']);
 180   if ($result['is_error'] !== 0) {
 181     return $result;
 182   }
 183   if ($result['count'] === 1) {
 184     return $result['values'][0];
 185   }
 186   if ($result['count'] !== 1) {
 187     return civicrm_api3_create_error("Expected one " . $apiRequest['entity'] . " but found " . $result['count'], array('count' => $result['count']));
 188   }
 189   return civicrm_api3_create_error("Undefined behavior");
 190 }
 191
 192 /**
 193  * API return function to reformat results as single value
 194  *
 195  * @param array $apiRequest
 196  *   Api request as an array. Keys are.
 197  *
 198  * @return integer
 199    *   count of results
 200  */
 201 function civicrm_api3_generic_getvalue($apiRequest) {
 202   $apiRequest['params']['sequential'] = 1;
 203   $result = civicrm_api($apiRequest['entity'], 'get', $apiRequest['params']);
 204   if ($result['is_error'] !== 0) {
 205     return $result;
 206   }
 207   if ($result['count'] !== 1) {
 208     $result = civicrm_api3_create_error("Expected one " . $apiRequest['entity'] . " but found " . $result['count'], array('count' => $result['count']));
 209     return $result;
 210   }
 211
 212   // we only take "return=" as valid options
 213   if (!empty($apiRequest['params']['return'])) {
 214     if (!isset($result['values'][0][$apiRequest['params']['return']])) {
 215       return civicrm_api3_create_error("field " . $apiRequest['params']['return'] . " unset or not existing", array('invalid_field' => $apiRequest['params']['return']));
 216     }
 217
 218     return $result['values'][0][$apiRequest['params']['return']];
 219   }
 220
 221   return civicrm_api3_create_error("missing param return=field you want to read the value of", array('error_type' => 'mandatory_missing', 'missing_param' => 'return'));
 222 }
 223
 224 /**
 225  * @param array $params
 226  */
 227 function _civicrm_api3_generic_getrefcount_spec(&$params) {
 228   $params['id']['api.required'] = 1;
 229   $params['id']['title'] = 'Entity ID';
 230 }
 231
 232 /**
 233  * API to determine if a record is in-use
 234  *
 235  * @param array $apiRequest
 236  *   Api request as an array.
 237  *
 238  * @throws API_Exception
 239  * @return array
 240    *   API result (int 0 or 1)
 241  */
 242 function civicrm_api3_generic_getrefcount($apiRequest) {
 243   $entityToClassMap = CRM_Core_DAO_AllCoreTables::daoToClass();
 244   if (!isset($entityToClassMap[$apiRequest['entity']])) {
 245     throw new API_Exception("The entity '{$apiRequest['entity']}' is unknown or unsupported by 'getrefcount'. Consider implementing this API.", 'getrefcount_unsupported');
 246   }
 247   $daoClass = $entityToClassMap[$apiRequest['entity']];
 248
 249   /* @var $dao CRM_Core_DAO */
 250   $dao = new $daoClass();
 251   $dao->id = $apiRequest['params']['id'];
 252   if ($dao->find(TRUE)) {
 253     return civicrm_api3_create_success($dao->getReferenceCounts());
 254   }
 255   else {
 256     return civicrm_api3_create_success(array());
 257   }
 258 }
 259
 260 /**
 261  * API wrapper for replace function
 262  *
 263  * @param array $apiRequest
 264  *   Api request as an array. Keys are.
 265  *
 266  * @return integer
 267    *   count of results
 268  */
 269 function civicrm_api3_generic_replace($apiRequest) {
 270   return _civicrm_api3_generic_replace($apiRequest['entity'], $apiRequest['params']);
 271 }
 272
 273 /**
 274  * API wrapper for getoptions function
 275  *
 276  * @param array $apiRequest
 277  *   Api request as an array.
 278  *
 279  * @return array
 280    *   of results
 281  */
 282 function civicrm_api3_generic_getoptions($apiRequest) {
 283   // Resolve aliases
 284   $fieldName = _civicrm_api3_api_resolve_alias($apiRequest['entity'], $apiRequest['params']['field']);
 285   if (!$fieldName) {
 286     return civicrm_api3_create_error("The field '{$apiRequest['params']['field']}' doesn't exist.");
 287   }
 288   // Validate 'context' from params
 289   $context = CRM_Utils_Array::value('context', $apiRequest['params']);
 290   CRM_Core_DAO::buildOptionsContext($context);
 291   unset($apiRequest['params']['context'], $apiRequest['params']['field']);
 292
 293   $baoName = _civicrm_api3_get_BAO($apiRequest['entity']);
 294   $options = $baoName::buildOptions($fieldName, $context, $apiRequest['params']);
 295   if ($options === FALSE) {
 296     return civicrm_api3_create_error("The field '{$fieldName}' has no associated option list.");
 297   }
 298   // Support 'sequential' output as a non-associative array
 299   if (!empty($apiRequest['params']['sequential'])) {
 300     $options = CRM_Utils_Array::makeNonAssociative($options);
 301   }
 302   return civicrm_api3_create_success($options, $apiRequest['params'], $apiRequest['entity'], 'getoptions');
 303 }
 304
 305 /**
 306  * Function fills the 'options' array on the metadata returned by getfields if
 307  * 1) the param option 'get_options' is defined - e.g. $params['options']['get_options'] => array('custom_1)
 308  * (this is passed in as the $fieldsToResolve array)
 309  * 2) the field is a pseudoconstant and is NOT an FK
 310  * - the reason for this is that checking / transformation is done on pseudoconstants but
 311  * - if the field is an FK then mysql will enforce the data quality (& we have handling on failure)
 312  * @todo - if may be we should define a 'resolve' key on the pseudoconstant for when these rules are not fine enough
 313  *
 314  * This function is only split out for the purpose of code clarity / comment block documentation
 315  *
 316  * @param array $metadata
 317  *   The array of metadata that will form the result of the getfields function.
 318  * @param $apiRequest
 319  * @param string $fieldname
 320  *   Field currently being processed.
 321  * @param array $fieldSpec
 322  *   Metadata for that field.
 323  * @param array $fieldsToResolve
 324  *   Anny field resolutions specifically requested.
 325  */
 326 function _civicrm_api3_generic_get_metadata_options(&$metadata, $apiRequest, $fieldname, $fieldSpec, $fieldsToResolve) {
 327   if (empty($fieldSpec['pseudoconstant']) && empty($fieldSpec['option_group_id'])) {
 328     return;
 329   }
 330
 331   if (!empty($metadata[$fieldname]['options']) || (!in_array($fieldname, $fieldsToResolve) && !in_array('all', $fieldsToResolve))) {
 332     return;
 333   }
 334
 335   $options = civicrm_api($apiRequest['entity'], 'getoptions', array('version' => 3, 'field' => $fieldname, 'sequential' => !empty($apiRequest['params']['sequential'])));
 336   if (is_array(CRM_Utils_Array::value('values', $options))) {
 337     $metadata[$fieldname]['options'] = $options['values'];
 338   }
 339 }