Merge remote-tracking branch 'upstream/4.3' into 4.3-master-2013-06-05-06-52-23

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

diff --git a/api/v3/Contribution.php b/api/v3/Contribution.php
index 0d774014158b61f893a2720119d306173d4c4b94..1635c0b5bdacddb647d924a652f4061f7b7d0612 100644 (file)
--- a/api/v3/Contribution.php
+++ b/api/v3/Contribution.php
@@ -1,5 +1,4 @@
 <?php
-// $Id$
 
 /*
  +--------------------------------------------------------------------+
@@ -57,7 +56,12 @@ function civicrm_api3_contribution_create(&$params) {
   _civicrm_api3_custom_format_params($params, $values, 'Contribution');
   $values["contact_id"] = CRM_Utils_Array::value('contact_id', $params);
   $values["source"] = CRM_Utils_Array::value('source', $params);
-
+  //legacy soft credit handling
+  if(!empty($params['soft_credit_to'])){
+    $values['soft_credit'] = array(array(
+      'contact_id' => $params['soft_credit_to'],
+      'amount' => $params['total_amount']));
+  }
   $ids = array();
   if (CRM_Utils_Array::value('id', $params)) {
     $ids['contribution'] = $params['id'];
@@ -71,7 +75,6 @@ function civicrm_api3_contribution_create(&$params) {
       }
     }
   }
-
   $contribution = CRM_Contribute_BAO_Contribution::create($values, $ids);
 
   if (is_a($contribution, 'CRM_Core_Error')) {
@@ -184,8 +187,6 @@ function civicrm_api3_contribution_get($params) {
   $smartGroupCache  = CRM_Utils_Array::value('smartGroupCache', $params);
   $inputParams      = CRM_Utils_Array::value('input_params', $options, array());
   $returnProperties = CRM_Utils_Array::value('return', $options, NULL);
-  require_once 'CRM/Contribute/BAO/Query.php';
-  require_once 'CRM/Contact/BAO/Query.php';
   if (empty($returnProperties)) {
     $returnProperties = CRM_Contribute_BAO_Query::defaultReturnProperties(CRM_Contact_BAO_Query::MODE_CONTRIBUTE);
   }
@@ -207,14 +208,30 @@ function civicrm_api3_contribution_get($params) {
   $contribution = array();
   while ($dao->fetch()) {
     //CRM-8662
-    $contribution_details = $query->store ( $dao );
-    $soft_params = array('contribution_id' => $dao->contribution_id);
-    $soft_contribution = CRM_Contribute_BAO_Contribution::getSoftContribution ( $soft_params , true);
-    $contribution [$dao->contribution_id] = array_merge($contribution_details, $soft_contribution);
+    $contribution_details = $query->store($dao);
+    $softContribution = CRM_Contribute_BAO_ContributionSoft::getSoftContribution($dao->contribution_id , TRUE);
+    $contribution[$dao->contribution_id] = array_merge($contribution_details, $softContribution);
+    if(isset($contribution[$dao->contribution_id]['financial_type_id'])){
+      $contribution[$dao->contribution_id]['financial_type_id'] = $contribution[$dao->contribution_id]['financial_type_id'];
+    }
+    // format soft credit for backward compatibility
+    _civicrm_api3_format_soft_credit($contribution[$dao->contribution_id]);
   }
   return civicrm_api3_create_success($contribution, $params, 'contribution', 'get', $dao);
 }
 
+/**
+ * This function is used to format the soft credit for backward compatibility
+ * as of v4.4 we support multiple soft credit, so now contribution returns array with 'soft_credit' as key
+ * but we still return first soft credit as a part of contribution array
+ */
+function _civicrm_api3_format_soft_credit(&$contribution) {
+  if (!empty($contribution['soft_credit'])) {
+    $contribution['soft_credit_to'] = $contribution['soft_credit'][1]['contact_id'];
+    $contribution['soft_credit_id'] = $contribution['soft_credit'][1]['soft_credit_id'];
+  }
+}
+
 /**
  * Adjust Metadata for Get action
  *
@@ -266,13 +283,6 @@ function _civicrm_api3_contribute_format_params($params, &$values, $create = FAL
         }
         break;
 
-      case 'soft_credit_to':// should be dealt with by validate integer
-        if (!CRM_Utils_Rule::integer($value)) {
-          return civicrm_api3_create_error("$key not a valid Id: $value");
-        }
-        $values['soft_credit_to'] = $value;
-        break;
-
       default:
         break;
     }
@@ -320,13 +330,11 @@ function civicrm_api3_contribution_transact($params) {
     $params['invoiceID'] = $params['invoice_id'];
   }
 
-  require_once 'CRM/Financial/BAO/PaymentProcessor.php';
   $paymentProcessor = CRM_Financial_BAO_PaymentProcessor::getPayment($params['payment_processor_id'], $params['payment_processor_mode']);
   if (civicrm_error($paymentProcessor)) {
     return $paymentProcessor;
   }
 
-  require_once 'CRM/Core/Payment.php';
   $payment = &CRM_Core_Payment::singleton($params['payment_processor_mode'], $paymentProcessor);
   if (civicrm_error($payment)) {
     return $payment;
@@ -364,12 +372,12 @@ function civicrm_api3_contribution_transact($params) {
 function civicrm_api3_contribution_sendconfirmation($params) {
   $contribution = new CRM_Contribute_BAO_Contribution();
   $contribution->id = $params['id'];
-  if (! $contribution->find(true)) {
+  if (! $contribution->find(TRUE)) {
     throw new Exception('Contribution does not exist');
 }
   $input = $ids = $cvalues = array('receipt_from_email' => $params['receipt_from_email']);
-  $contribution->loadRelatedObjects($input, $ids, FALSE, true);
-  $contribution->composeMessageArray($input, $ids, $cvalues, false, false);
+  $contribution->loadRelatedObjects($input, $ids, FALSE, TRUE);
+  $contribution->composeMessageArray($input, $ids, $cvalues, FALSE, FALSE);
 }
 
 /**