| 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 api request as an array. Keys are |
| 14 | * - entity: string |
| 15 | * - action: string |
| 16 | * - version: string |
| 17 | * - function: callback (mixed) |
| 18 | * - params: array, varies |
| 19 | * @return array API success object |
| 20 | */ |
| 21 | function civicrm_api3_generic_getfields($apiRequest) { |
| 22 | static $results = array(); |
| 23 | if ((CRM_Utils_Array::value('cache_clear', $apiRequest['params']))) { |
| 24 | $results = array(); |
| 25 | // we will also clear pseudoconstants here - should potentially be moved to relevant BAO classes |
| 26 | CRM_Core_PseudoConstant::flush(); |
| 27 | if(!empty($apiRequest['params']['fieldname'])){ |
| 28 | CRM_Utils_PseudoConstant::flushConstant($apiRequest['params']['fieldname']); |
| 29 | } |
| 30 | if(!empty($apiRequest['params']['option_group_id'])){ |
| 31 | $optionGroupName = civicrm_api('option_group', 'getvalue', array('version' => 3, 'id' => $apiRequest['params']['option_group_id'], 'return' => 'name') ); |
| 32 | if(is_string($optionGroupName)){ |
| 33 | CRM_Utils_PseudoConstant::flushConstant(_civicrm_api_get_camel_name($optionGroupName)); |
| 34 | } |
| 35 | } |
| 36 | } |
| 37 | $entity = _civicrm_api_get_camel_name($apiRequest['entity']); |
| 38 | $lcase_entity = _civicrm_api_get_entity_name_from_camel($entity); |
| 39 | $subentity = CRM_Utils_Array::value('contact_type', $apiRequest['params']); |
| 40 | $action = strtolower(CRM_Utils_Array::value('action', $apiRequest['params'])); |
| 41 | $sequential = empty($apiRequest['params']) ? 0 : 1; |
| 42 | $apiOptions = CRM_Utils_Array::value('options', $apiRequest['params'], array()); |
| 43 | if ($action == 'getvalue' || $action == 'getvalue' || $action == 'getcount') { |
| 44 | $action = 'get'; |
| 45 | } |
| 46 | |
| 47 | if (empty($action)) { |
| 48 | $action='get'; |
| 49 | } |
| 50 | // determines whether to use unique field names - seem comment block above |
| 51 | $unique = TRUE; |
| 52 | if (empty($apiOptions) && isset($results[$entity . $subentity]) && isset($action, $results[$entity . $subentity]) |
| 53 | && isset($action, $results[$entity . $subentity][$sequential])) { |
| 54 | return $results[$entity . $subentity][$action][$sequential]; |
| 55 | } |
| 56 | // defaults based on data model and API policy |
| 57 | switch ($action) { |
| 58 | case 'getfields': |
| 59 | $values = _civicrm_api_get_fields($entity, false, $apiRequest['params']); |
| 60 | return civicrm_api3_create_success($values, $apiRequest['params'], $entity, 'getfields'); |
| 61 | case 'create': |
| 62 | case 'update': |
| 63 | case 'replace': |
| 64 | $unique = FALSE; |
| 65 | case 'get': |
| 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('title' => 'Unique Identifier', |
| 88 | 'api.required' => 1, |
| 89 | 'api.aliases' => array($lcase_entity . '_id'), |
| 90 | 'type' => CRM_Utils_Type::T_INT, |
| 91 | )); |
| 92 | break; |
| 93 | |
| 94 | case 'getoptions': |
| 95 | $metadata = array( |
| 96 | 'field' => array( |
| 97 | 'title' => 'Field to retrieve options for', |
| 98 | 'api.required' => 1, |
| 99 | ), |
| 100 | 'context' => array( |
| 101 | 'title' => 'Context string', |
| 102 | ), |
| 103 | ); |
| 104 | break; |
| 105 | default: |
| 106 | // oddballs are on their own |
| 107 | $metadata = array(); |
| 108 | } |
| 109 | |
| 110 | // find any supplemental information |
| 111 | $hypApiRequest = array('entity' => $apiRequest['entity'], 'action' => $action, 'version' => $apiRequest['version']); |
| 112 | $hypApiRequest += _civicrm_api_resolve($hypApiRequest); |
| 113 | $helper = '_' . $hypApiRequest['function'] . '_spec'; |
| 114 | if (function_exists($helper)) { |
| 115 | // alter |
| 116 | $helper($metadata); |
| 117 | } |
| 118 | |
| 119 | $fieldsToResolve = (array) CRM_Utils_Array::value('get_options', $apiOptions, array()); |
| 120 | |
| 121 | foreach ($metadata as $fieldname => $fieldSpec) { |
| 122 | _civicrm_api3_generic_get_metadata_options($metadata, $apiRequest['entity'], $fieldname, $fieldSpec, $fieldsToResolve); |
| 123 | } |
| 124 | |
| 125 | $results[$entity][$action][$sequential] = civicrm_api3_create_success($metadata, $apiRequest['params'], NULL, 'getfields'); |
| 126 | return $results[$entity][$action][$sequential]; |
| 127 | } |
| 128 | |
| 129 | /** |
| 130 | * API return function to reformat results as count |
| 131 | * |
| 132 | * @param array $apiRequest api request as an array. Keys are |
| 133 | * |
| 134 | * @return integer count of results |
| 135 | */ |
| 136 | function civicrm_api3_generic_getcount($apiRequest) { |
| 137 | $apiRequest['params']['options']['is_count'] = TRUE; |
| 138 | $result = civicrm_api($apiRequest['entity'], 'get', $apiRequest['params']); |
| 139 | if(is_numeric (CRM_Utils_Array::value('values', $result))) { |
| 140 | return (int) $result['values']; |
| 141 | } |
| 142 | if(!isset($result['count'])) { |
| 143 | throw new API_Exception(ts('Unexpected result from getcount') . print_r($result, TRUE)); |
| 144 | } |
| 145 | return $result['count']; |
| 146 | } |
| 147 | |
| 148 | /** |
| 149 | * API return function to reformat results as single result |
| 150 | * |
| 151 | * @param array $apiRequest api request as an array. Keys are |
| 152 | * |
| 153 | * @return integer count of results |
| 154 | */ |
| 155 | function civicrm_api3_generic_getsingle($apiRequest) { |
| 156 | // so the first entity is always result['values'][0] |
| 157 | $apiRequest['params']['sequential'] = 1; |
| 158 | $result = civicrm_api($apiRequest['entity'], 'get', $apiRequest['params']); |
| 159 | if ($result['is_error'] !== 0) { |
| 160 | return $result; |
| 161 | } |
| 162 | if ($result['count'] === 1) { |
| 163 | return $result['values'][0]; |
| 164 | } |
| 165 | if ($result['count'] !== 1) { |
| 166 | return civicrm_api3_create_error("Expected one " . $apiRequest['entity'] . " but found " . $result['count'], array('count' => $result['count'])); |
| 167 | } |
| 168 | return civicrm_api3_create_error("Undefined behavior"); |
| 169 | } |
| 170 | |
| 171 | /** |
| 172 | * API return function to reformat results as single value |
| 173 | * |
| 174 | * @param array $apiRequest api request as an array. Keys are |
| 175 | * |
| 176 | * @return integer count of results |
| 177 | */ |
| 178 | function civicrm_api3_generic_getvalue($apiRequest) { |
| 179 | $apiRequest['params']['sequential'] = 1; |
| 180 | $result = civicrm_api($apiRequest['entity'], 'get', $apiRequest['params']); |
| 181 | if ($result['is_error'] !== 0) { |
| 182 | return $result; |
| 183 | } |
| 184 | if ($result['count'] !== 1) { |
| 185 | $result = civicrm_api3_create_error("Expected one " . $apiRequest['entity'] . " but found " . $result['count'], array('count' => $result['count'])); |
| 186 | return $result; |
| 187 | } |
| 188 | |
| 189 | // we only take "return=" as valid options |
| 190 | if (CRM_Utils_Array::value('return', $apiRequest['params'])) { |
| 191 | if (!isset($result['values'][0][$apiRequest['params']['return']])) { |
| 192 | return civicrm_api3_create_error("field " . $apiRequest['params']['return'] . " unset or not existing", array('invalid_field' => $apiRequest['params']['return'])); |
| 193 | } |
| 194 | |
| 195 | return $result['values'][0][$apiRequest['params']['return']]; |
| 196 | } |
| 197 | |
| 198 | return civicrm_api3_create_error("missing param return=field you want to read the value of", array('error_type' => 'mandatory_missing', 'missing_param' => 'return')); |
| 199 | } |
| 200 | |
| 201 | /** |
| 202 | * API wrapper for replace function |
| 203 | * |
| 204 | * @param array $apiRequest api request as an array. Keys are |
| 205 | * |
| 206 | * @return integer count of results |
| 207 | */ |
| 208 | function civicrm_api3_generic_replace($apiRequest) { |
| 209 | return _civicrm_api3_generic_replace($apiRequest['entity'], $apiRequest['params']); |
| 210 | } |
| 211 | |
| 212 | /** |
| 213 | * API wrapper for getoptions function |
| 214 | * |
| 215 | * @param array $apiRequest api request as an array. |
| 216 | * |
| 217 | * @return array of results |
| 218 | */ |
| 219 | function civicrm_api3_generic_getoptions($apiRequest) { |
| 220 | // Resolve aliases |
| 221 | $fieldName = _civicrm_api3_api_resolve_alias($apiRequest['entity'], $apiRequest['params']['field']); |
| 222 | if (!$fieldName) { |
| 223 | return civicrm_api3_create_error("The field '{$apiRequest['params']['field']}' doesn't exist."); |
| 224 | } |
| 225 | // Validate 'context' from params |
| 226 | $context = CRM_Utils_Array::value('context', $apiRequest['params']); |
| 227 | CRM_Core_DAO::buildOptionsContext($context); |
| 228 | unset($apiRequest['params']['context'], $apiRequest['params']['field']); |
| 229 | |
| 230 | $baoName = _civicrm_api3_get_BAO($apiRequest['entity']); |
| 231 | $options = $baoName::buildOptions($fieldName, $context, $apiRequest['params']); |
| 232 | if ($options === FALSE) { |
| 233 | return civicrm_api3_create_error("The field '{$fieldName}' has no associated option list."); |
| 234 | } |
| 235 | return civicrm_api3_create_success($options); |
| 236 | } |
| 237 | |
| 238 | /** |
| 239 | * Function fills the 'options' array on the metadata returned by getfields if |
| 240 | * 1) the param option 'get_options' is defined - e.g. $params['options']['get_options'] => array('custom_1) |
| 241 | * (this is passed in as the $fieldsToResolve array) |
| 242 | * 2) the field is a pseudoconstant and is NOT an FK |
| 243 | * - the reason for this is that checking / transformation is done on pseudoconstants but |
| 244 | * - if the field is an FK then mysql will enforce the data quality (& we have handling on failure) |
| 245 | * @todo - if may be we should define a 'resolve' key on the psuedoconstant for when these rules are not fine enough |
| 246 | * 3) if there is an 'enum' then it is split up into the relevant options |
| 247 | * |
| 248 | * This function is only split out for the purpose of code clarity / comment block documentation |
| 249 | * @param array $metadata the array of metadata that will form the result of the getfields function |
| 250 | * @param string $fieldname field currently being processed |
| 251 | * @param array $fieldSpec metadata for that field |
| 252 | * @param array $fieldsToResolve anny field resolutions specifically requested |
| 253 | */ |
| 254 | function _civicrm_api3_generic_get_metadata_options(&$metadata, $entity, $fieldname, $fieldSpec, $fieldsToResolve){ |
| 255 | if(empty($fieldSpec['pseudoconstant']) && empty($fieldSpec['enumValues'])) { |
| 256 | return; |
| 257 | } |
| 258 | |
| 259 | if (!empty($metadata[$fieldname]['options']) || (!in_array($fieldname, $fieldsToResolve) && !in_array('all', $fieldsToResolve))) { |
| 260 | return; |
| 261 | } |
| 262 | |
| 263 | $options = civicrm_api($entity, 'getoptions', array('version' => 3, 'field' => $fieldname)); |
| 264 | if (is_array(CRM_Utils_Array::value('values', $options))) { |
| 265 | $metadata[$fieldname]['options'] = $options['values']; |
| 266 | } |
| 267 | } |