4 * File for the CiviCRM APIv3 API wrapper
6 * @package CiviCRM_APIv3
9 * @copyright CiviCRM LLC (c) 2004-2014
10 * @version $Id: api.php 30486 2010-11-02 16:12:09Z shot $
14 * @param string $entity
15 * type of entities to deal with
16 * @param string $action
17 * create, get, delete or some special action name.
18 * @param array $params
19 * array to be passed to function
24 function civicrm_api($entity, $action, $params, $extra = NULL) {
25 return \Civi\Core\Container
::singleton()->get('civi_api_kernel')->run($entity, $action, $params, $extra);
29 * Version 3 wrapper for civicrm_api. Throws exception
31 * @param string $entity
32 * Type of entities to deal with.
33 * @param string $action
34 * Create, get, delete or some special action name.
35 * @param array $params
36 * Array to be passed to function.
38 * @throws CiviCRM_API3_Exception
41 function civicrm_api3($entity, $action, $params = array()) {
42 $params['version'] = 3;
43 $result = civicrm_api($entity, $action, $params);
44 if (is_array($result) && !empty($result['is_error'])) {
45 throw new CiviCRM_API3_Exception($result['error_message'], CRM_Utils_Array
::value('error_code', $result, 'undefined'), $result);
51 * Call getfields from api wrapper. This function ensures that settings that
52 * could alter getfields output (e.g. action for all api & profile_id for
53 * profile api ) are consistently passed in.
55 * We check whether the api call is 'getfields' because if getfields is
56 * being called we return an empty array as no alias swapping, validation or
57 * default filling is done on getfields & we want to avoid a loop
59 * @todo other output modifiers include contact_type
61 * @param array $apiRequest
65 function _civicrm_api3_api_getfields(&$apiRequest) {
66 if (strtolower($apiRequest['action'] == 'getfields')) {
67 // the main param getfields takes is 'action' - however this param is not compatible with REST
68 // so we accept 'api_action' as an alias of action on getfields
69 if (!empty($apiRequest['params']['api_action'])) {
70 // $apiRequest['params']['action'] = $apiRequest['params']['api_action'];
71 // unset($apiRequest['params']['api_action']);
73 return array('action' => array('api.aliases' => array('api_action')));
75 $getFieldsParams = array('action' => $apiRequest['action']);
76 $entity = $apiRequest['entity'];
77 if ($entity == 'profile' && array_key_exists('profile_id', $apiRequest['params'])) {
78 $getFieldsParams['profile_id'] = $apiRequest['params']['profile_id'];
80 $fields = civicrm_api3($entity, 'getfields', $getFieldsParams);
81 return $fields['values'];
85 * Check if the result is an error. Note that this function has been retained from
86 * api v2 for convenience but the result is more standardised in v3 and param
87 * 'format.is_success' => 1
88 * will result in a boolean success /fail being returned if that is what you need.
93 * true if error, false otherwise
97 function civicrm_error($result) {
98 if (is_array($result)) {
99 return (array_key_exists('is_error', $result) &&
111 function _civicrm_api_get_camel_name($entity) {
112 return CRM_Utils_String
::convertStringToCamel($entity);
116 * Swap out any $values vars - ie. the value after $value is swapped for the parent $result
117 * 'activity_type_id' => '$value.testfield',
118 'tag_id' => '$value.api.tag.create.id',
119 'tag1_id' => '$value.api.entity.create.0.id'
121 function _civicrm_api_replace_variables($entity, $action, &$params, &$parentResult, $separator = '.') {
123 foreach ($params as $field => $value) {
125 if (is_string($value) && substr($value, 0, 6) == '$value') {
126 $valuesubstitute = substr($value, 7);
128 if (!empty($parentResult[$valuesubstitute])) {
129 $params[$field] = $parentResult[$valuesubstitute];
133 $stringParts = explode($separator, $value);
134 unset($stringParts[0]);
136 $fieldname = array_shift($stringParts);
138 //when our string is an array we will treat it as an array from that . onwards
139 $count = count($stringParts);
141 $fieldname .= "." . array_shift($stringParts);
142 if (array_key_exists($fieldname, $parentResult) && is_array($parentResult[$fieldname])) {
143 $arrayLocation = $parentResult[$fieldname];
144 foreach ($stringParts as $key => $value) {
145 $arrayLocation = CRM_Utils_Array
::value($value, $arrayLocation);
147 $params[$field] = $arrayLocation;
149 $count = count($stringParts);
157 * Convert possibly camel name to underscore separated entity name
159 * @param string $entity
160 * Entity name in various formats e.g. Contribution, contribution,
161 * OptionValue, option_value, UFJoin, uf_join.
163 * Entity name in underscore separated format.
165 * @fixme Why isn't this called first thing in civicrm_api wrapper?
167 function _civicrm_api_get_entity_name_from_camel($entity) {
168 if ($entity == strtolower($entity)) {
172 $entity = ltrim(strtolower(str_replace('U_F',
174 // That's CamelCase, beside an odd UFCamel that is expected as uf_camel
175 preg_replace('/(?=[A-Z])/', '_$0', $entity)
182 * Having a DAO object find the entity name
184 * DAO being passed in.
187 function _civicrm_api_get_entity_name_from_dao($bao) {
188 $daoName = str_replace("BAO", "DAO", get_class($bao));
189 return _civicrm_api_get_entity_name_from_camel(CRM_Core_DAO_AllCoreTables
::getBriefName($daoName));