Merge pull request #3286 from kurund/CRM-14703

[civicrm-core.git] / api / api.php

diff --git a/api/api.php b/api/api.php
index f3b2be9d37050a9c4ad3ca1be9babcbef783af87..c09d220249775dfe0cc439890f1aa65e28676fb1 100644 (file)
--- a/api/api.php
+++ b/api/api.php
@@ -54,7 +54,7 @@ function civicrm_api3($entity, $action, $params = array()) {
  * @todo other output modifiers include contact_type
  *
  * @param array $apiRequest
- * @return getfields output
+ * @return array getfields output
  */
 function _civicrm_api3_api_getfields(&$apiRequest) {
   if (strtolower($apiRequest['action'] == 'getfields')) {
@@ -98,6 +98,12 @@ function civicrm_error($result) {
   return FALSE;
 }
 
+/**
+ * @param $entity
+ * @param null $version
+ *
+ * @return string
+ */
 function _civicrm_api_get_camel_name($entity, $version = NULL) {
   $fragments = explode('_', $entity);
   foreach ($fragments as & $fragment) {
@@ -110,108 +116,6 @@ function _civicrm_api_get_camel_name($entity, $version = NULL) {
   return implode('', $fragments);
 }
 
-/**
- * Call any nested api calls
- */
-function _civicrm_api_call_nested_api(&$params, &$result, $action, $entity, $version) {
-  $entity = _civicrm_api_get_entity_name_from_camel($entity);
-
-  //we don't need to worry about nested api in the getfields/getoptions actions, so just return immediately
-  if (in_array(strtolower($action), array('getfields', 'getoptions'))) {
-    return;
-  }
-
-  if(strtolower($action) == 'getsingle'){
-    // I don't understand the protocol here, but we don't want
-    // $result to be a recursive array
-    // $result['values'][0] = $result;
-    $oldResult = $result;
-    $result = array('values' => array(0 => $oldResult));
-  }
-  foreach ($params as $field => $newparams) {
-    if ((is_array($newparams) || $newparams === 1) && $field <> 'api.has_parent' && substr($field, 0, 3) == 'api') {
-
-      // 'api.participant.delete' => 1 is a valid options - handle 1 instead of an array
-      if ($newparams === 1) {
-        $newparams = array('version' => $version);
-      }
-      // can be api_ or api.
-      $separator = $field[3];
-      if (!($separator == '.' || $separator == '_')) {
-        continue;
-      }
-      $subAPI = explode($separator, $field);
-
-      $subaction = empty($subAPI[2]) ? $action : $subAPI[2];
-      $subParams = array(
-        'debug' => CRM_Utils_Array::value('debug', $params),
-      );
-      $subEntity = $subAPI[1];
-
-      foreach ($result['values'] as $idIndex => $parentAPIValues) {
-
-        if (strtolower($subEntity) != 'contact') {
-          //contact spits the dummy at activity_id so what else won't it like?
-          //set entity_id & entity table based on the parent's id & entity. e.g for something like
-          //note if the parent call is contact 'entity_table' will be set to 'contact' & 'id' to the contact id from
-          //the parent call.
-          //in this case 'contact_id' will also be set to the parent's id
-          $subParams["entity_id"] = $parentAPIValues['id'];
-          $subParams['entity_table'] = 'civicrm_' . _civicrm_api_get_entity_name_from_camel($entity);
-          $subParams[strtolower($entity) . "_id"] = $parentAPIValues['id'];
-        }
-        if (strtolower($entity) != 'contact' && CRM_Utils_Array::value(strtolower($subEntity . "_id"), $parentAPIValues)) {
-          //e.g. if event_id is in the values returned & subentity is event then pass in event_id as 'id'
-          //don't do this for contact as it does some wierd things like returning primary email &
-          //thus limiting the ability to chain email
-          //TODO - this might need the camel treatment
-          $subParams['id'] = $parentAPIValues[$subEntity . "_id"];
-        }
-
-        if (CRM_Utils_Array::value('entity_table', $result['values'][$idIndex]) == $subEntity) {
-          $subParams['id'] = $result['values'][$idIndex]['entity_id'];
-        }
-        // if we are dealing with the same entity pass 'id' through (useful for get + delete for example)
-        if (strtolower($entity) == strtolower($subEntity)) {
-          $subParams['id'] = $result['values'][$idIndex]['id'];
-        }
-
-
-        $subParams['version'] = $version;
-        if(!empty($params['check_permissions'])){
-          $subParams['check_permissions'] = $params['check_permissions'];
-        }
-        $subParams['sequential'] = 1;
-        $subParams['api.has_parent'] = 1;
-        if (array_key_exists(0, $newparams)) {
-          $genericParams = $subParams;
-          // it is a numerically indexed array - ie. multiple creates
-          foreach ($newparams as $entityparams) {
-            $subParams = array_merge($genericParams, $entityparams);
-            _civicrm_api_replace_variables($subAPI[1], $subaction, $subParams, $result['values'][$idIndex], $separator);
-            $result['values'][$result['id']][$field][] = civicrm_api($subEntity, $subaction, $subParams);
-            if ($result['is_error'] === 1) {
-              throw new Exception($subEntity . ' ' . $subaction . 'call failed with' . $result['error_message']);
-            }
-          }
-        }
-        else {
-
-          $subParams = array_merge($subParams, $newparams);
-          _civicrm_api_replace_variables($subAPI[1], $subaction, $subParams, $result['values'][$idIndex], $separator);
-          $result['values'][$idIndex][$field] = civicrm_api($subEntity, $subaction, $subParams);
-          if (!empty($result['is_error'])) {
-            throw new Exception($subEntity . ' ' . $subaction . 'call failed with' . $result['error_message']);
-          }
-        }
-      }
-    }
-  }
-  if(strtolower($action) == 'getsingle'){
-    $result = $result['values'][0];
-  }
-}
-
 /**
  * Swap out any $values vars - ie. the value after $value is swapped for the parent $result
  * 'activity_type_id' => '$value.testfield',