api/api.php

   1 <?php
   2
   3 /**
   4  * File for the CiviCRM APIv3 API wrapper
   5  *
   6  * @package CiviCRM_APIv3
   7  * @subpackage API
   8  *
   9  * @copyright CiviCRM LLC (c) 2004-2014
  10  * @version $Id: api.php 30486 2010-11-02 16:12:09Z shot $
  11  */
  12
  13 /**
  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
  20  * @param null $extra
  21  *
  22  * @return array|int
  23  */
  24 function civicrm_api($entity, $action, $params, $extra = NULL) {
  25   return \Civi\Core\Container::singleton()->get('civi_api_kernel')->run($entity, $action, $params, $extra);
  26 }
  27
  28 /**
  29  * Version 3 wrapper for civicrm_api. Throws exception
  30  *
  31  * @param string $entity type of entities to deal with
  32  * @param string $action create, get, delete or some special action name.
  33  * @param array $params array to be passed to function
  34  *
  35  * @throws CiviCRM_API3_Exception
  36  * @return array
  37  */
  38 function civicrm_api3($entity, $action, $params = array()) {
  39   $params['version'] = 3;
  40   $result = civicrm_api($entity, $action, $params);
  41   if(is_array($result) && !empty($result['is_error'])){
  42     throw new CiviCRM_API3_Exception($result['error_message'], CRM_Utils_Array::value('error_code', $result, 'undefined'), $result);
  43   }
  44   return $result;
  45 }
  46
  47 /**
  48  * call getfields from api wrapper. This function ensures that settings that could alter
  49  * getfields output (e.g. action for all api & profile_id for profile api ) are consistently passed in.
  50  *
  51  * We check whether the api call is 'getfields' because if getfields is being called we return an empty array
  52  * as no alias swapping, validation or default filling is done on getfields & we want to avoid a loop
  53  *
  54  * @todo other output modifiers include contact_type
  55  *
  56  * @param array $apiRequest
  57  * @return array getfields output
  58  */
  59 function _civicrm_api3_api_getfields(&$apiRequest) {
  60   if (strtolower($apiRequest['action'] == 'getfields')) {
  61     // the main param getfields takes is 'action' - however this param is not compatible with REST
  62     // so we accept 'api_action' as an alias of action on getfields
  63     if (!empty($apiRequest['params']['api_action'])) {
  64     //  $apiRequest['params']['action'] = $apiRequest['params']['api_action'];
  65      // unset($apiRequest['params']['api_action']);
  66     }
  67     return array('action' => array('api.aliases' => array('api_action')));
  68   }
  69   $getFieldsParams = array('action' => $apiRequest['action']);
  70   $entity = $apiRequest['entity'];
  71   if($entity == 'profile' && array_key_exists('profile_id', $apiRequest['params'])) {
  72     $getFieldsParams['profile_id'] = $apiRequest['params']['profile_id'];
  73   }
  74   $fields = civicrm_api3($entity, 'getfields', $getFieldsParams);
  75   return $fields['values'];
  76 }
  77
  78 /**
  79  * Check if the result is an error. Note that this function has been retained from
  80  * api v2 for convenience but the result is more standardised in v3 and param
  81  * 'format.is_success' => 1
  82  * will result in a boolean success /fail being returned if that is what you need.
  83  *
  84  * @param $result
  85  *
  86  * @return boolean true if error, false otherwise
  87  * @static void
  88  * @access public
  89  */
  90 function civicrm_error($result) {
  91   if (is_array($result)) {
  92     return (array_key_exists('is_error', $result) &&
  93       $result['is_error']
  94     ) ? TRUE : FALSE;
  95   }
  96   return FALSE;
  97 }
  98
  99 /**
 100  * @param $entity
 101  *
 102  * @return string
 103  */
 104 function _civicrm_api_get_camel_name($entity) {
 105   return CRM_Utils_String::convertStringToCamel($entity);
 106 }
 107
 108 /**
 109  * Swap out any $values vars - ie. the value after $value is swapped for the parent $result
 110  * 'activity_type_id' => '$value.testfield',
 111    'tag_id'  => '$value.api.tag.create.id',
 112     'tag1_id' => '$value.api.entity.create.0.id'
 113  */
 114 function _civicrm_api_replace_variables($entity, $action, &$params, &$parentResult, $separator = '.') {
 115
 116
 117   foreach ($params as $field => $value) {
 118
 119     if (is_string($value) && substr($value, 0, 6) == '$value') {
 120       $valuesubstitute = substr($value, 7);
 121
 122       if (!empty($parentResult[$valuesubstitute])) {
 123         $params[$field] = $parentResult[$valuesubstitute];
 124       }
 125       else {
 126
 127         $stringParts = explode($separator, $value);
 128         unset($stringParts[0]);
 129
 130         $fieldname = array_shift($stringParts);
 131
 132         //when our string is an array we will treat it as an array from that . onwards
 133         $count = count($stringParts);
 134         while ($count > 0) {
 135           $fieldname .= "." . array_shift($stringParts);
 136           if (array_key_exists($fieldname, $parentResult) && is_array($parentResult[$fieldname])) {
 137             $arrayLocation = $parentResult[$fieldname];
 138             foreach ($stringParts as $key => $value) {
 139               $arrayLocation = CRM_Utils_Array::value($value, $arrayLocation);
 140             }
 141             $params[$field] = $arrayLocation;
 142           }
 143           $count = count($stringParts);
 144         }
 145       }
 146     }
 147   }
 148 }
 149
 150 /**
 151  * Convert possibly camel name to underscore separated entity name
 152  *
 153  * @param string $entity entity name in various formats e.g. Contribution, contribution, OptionValue, option_value, UFJoin, uf_join
 154  * @return string $entity entity name in underscore separated format
 155  *
 156  * FIXME: Why isn't this called first thing in civicrm_api wrapper?
 157  */
 158 function _civicrm_api_get_entity_name_from_camel($entity) {
 159   if ($entity == strtolower($entity)) {
 160     return $entity;
 161   }
 162   else {
 163     $entity = ltrim(strtolower(str_replace('U_F',
 164           'uf',
 165           // That's CamelCase, beside an odd UFCamel that is expected as uf_camel
 166           preg_replace('/(?=[A-Z])/', '_$0', $entity)
 167         )), '_');
 168   }
 169   return $entity;
 170 }
 171
 172 /**
 173  * Having a DAO object find the entity name
 174  * @param object $bao DAO being passed in
 175  * @return string
 176  */
 177 function _civicrm_api_get_entity_name_from_dao($bao){
 178   $daoName = str_replace("BAO", "DAO", get_class($bao));
 179   return _civicrm_api_get_entity_name_from_camel(CRM_Core_DAO_AllCoreTables::getBriefName($daoName));
 180 }
 181