Merge pull request #2674 from deepak-srivastava/CRM-12467-soft-credit-search

[civicrm-core.git] / api / v3 / Generic / Update.php

diff --git a/api/v3/Generic/Update.php b/api/v3/Generic/Update.php
index 636a5cc5f9be1f4cb929212202a97ca64be0b79e..1c95bcae6a14a942428067b237144afbbe51ae3a 100644 (file)
--- a/api/v3/Generic/Update.php
+++ b/api/v3/Generic/Update.php
@@ -1,11 +1,40 @@
 <?php
-// $Id$
+
+/*
+ +--------------------------------------------------------------------+
+ | CiviCRM version 4.4                                                |
+ +--------------------------------------------------------------------+
+ | Copyright CiviCRM LLC (c) 2004-2013                                |
+ +--------------------------------------------------------------------+
+ | This file is a part of CiviCRM.                                    |
+ |                                                                    |
+ | CiviCRM is free software; you can copy, modify, and distribute it  |
+ | under the terms of the GNU Affero General Public License           |
+ | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
+ |                                                                    |
+ | CiviCRM is distributed in the hope that it will be useful, but     |
+ | WITHOUT ANY WARRANTY; without even the implied warranty of         |
+ | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
+ | See the GNU Affero General Public License for more details.        |
+ |                                                                    |
+ | You should have received a copy of the GNU Affero General Public   |
+ | License and the CiviCRM Licensing Exception along                  |
+ | with this program; if not, contact CiviCRM LLC                     |
+ | at info[AT]civicrm[DOT]org. If you have questions about the        |
+ | GNU Affero General Public License or the licensing of CiviCRM,     |
+ | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
+ +--------------------------------------------------------------------+
+*/
 
 /**
- * Our original intention was not to have an update action. However, we wound up having
- * to retain it for backward compatibility. The only difference between update and create
- * is that update will throw an error if id is not a number
- * CRM-10908
+ * Update function is basically a hack to get around issues listed in
+ * http://issues.civicrm.org/jira/browse/CRM-12144
+ *
+ * It is not recommended & if update doesn't work & fix does then update will not be fixed
+ *
+ * To do this, perform a 'get' action to load the existing values, then merge in the updates
+ * and call 'create' to save the revised entity.
+ *
  * @param $apiRequest an array with keys:
  *  - entity: string
  *  - action: string
@@ -14,12 +43,33 @@
  *  - params: array, varies
  */
 function civicrm_api3_generic_update($apiRequest) {
+  $errorFnName = 'civicrm_api3_create_error';
 
-  if (!array_key_exists('id', $apiRequest['params']) ||
-      empty($apiRequest['params']['id']) ||
-      !is_numeric($apiRequest['params']['id'])) {
-    throw new api_Exception("Mandatory parameter missing `id`", 2000);
+  //$key_id = strtolower ($apiRequest['entity'])."_id";
+  $key_id = "id";
+  if (!array_key_exists($key_id, $apiRequest['params'])) {
+    return $errorFnName("Mandatory parameter missing $key_id");
+  }
+  // @fixme
+  // tests show that contribution works better with create
+  // this is horrible but to make it work we'll just handle it separately
+  if(strtolower($apiRequest['entity']) == 'contribution'){
+    return civicrm_api($apiRequest['entity'], 'create', $apiRequest['params']);
+  }
+  $seek = array($key_id => $apiRequest['params'][$key_id], 'version' => $apiRequest['version']);
+  $existing = civicrm_api($apiRequest['entity'], 'get', $seek);
+  if ($existing['is_error']) {
+    return $existing;
   }
-  return civicrm_api($apiRequest['entity'], 'create', $apiRequest['params']);
+  if ($existing['count'] > 1) {
+    return $errorFnName("More than one " . $apiRequest['entity'] . " with id " . $apiRequest['params'][$key_id]);
+  }
+  if ($existing['count'] == 0) {
+    return $errorFnName("No " . $apiRequest['entity'] . " with id " . $apiRequest['params'][$key_id]);
+  }
+
+  $existing = array_pop($existing['values']);
+  $p = array_merge($existing, $apiRequest['params']);
+  return civicrm_api($apiRequest['entity'], 'create', $p);
 }