CRM/Contribute/BAO/Contribution.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2019                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2019
  32  */
  33 class CRM_Contribute_BAO_Contribution extends CRM_Contribute_DAO_Contribution {
  34
  35   /**
  36    * Static field for all the contribution information that we can potentially import
  37    *
  38    * @var array
  39    */
  40   static $_importableFields = NULL;
  41
  42   /**
  43    * Static field for all the contribution information that we can potentially export
  44    *
  45    * @var array
  46    */
  47   static $_exportableFields = NULL;
  48
  49   /**
  50    * Static field to hold financial trxn id's.
  51    *
  52    * @var array
  53    */
  54   static $_trxnIDs = NULL;
  55
  56   /**
  57    * Field for all the objects related to this contribution
  58    * @var array of objects (e.g membership object, participant object)
  59    */
  60   public $_relatedObjects = array();
  61
  62   /**
  63    * Field for the component - either 'event' (participant) or 'contribute'
  64    * (any item related to a contribution page e.g. membership, pledge, contribution)
  65    * This is used for composing messages because they have dependency on the
  66    * contribution_page or event page - although over time we may eliminate that
  67    *
  68    * @var string component or event
  69    */
  70   public $_component = NULL;
  71
  72   /**
  73    * Possibly obsolete variable.
  74    *
  75    * If you use it please explain why it is set in the create function here.
  76    *
  77    * @var string
  78    */
  79   public $trxn_result_code;
  80
  81   /**
  82    * Class constructor.
  83    */
  84   public function __construct() {
  85     parent::__construct();
  86   }
  87
  88   /**
  89    * Takes an associative array and creates a contribution object.
  90    *
  91    * the function extract all the params it needs to initialize the create a
  92    * contribution object. the params array could contain additional unused name/value
  93    * pairs
  94    *
  95    * @param array $params
  96    *   (reference ) an assoc array of name/value pairs.
  97    * @param array $ids
  98    *   The array that holds all the db ids.
  99    *
 100    * @return \CRM_Contribute_BAO_Contribution
 101    * @throws \CRM_Core_Exception
 102    */
 103   public static function add(&$params, $ids = array()) {
 104     if (empty($params)) {
 105       return NULL;
 106     }
 107     //per http://wiki.civicrm.org/confluence/display/CRM/Database+layer we are moving away from $ids array
 108     $contributionID = CRM_Utils_Array::value('contribution', $ids, CRM_Utils_Array::value('id', $params));
 109     $duplicates = array();
 110     if (self::checkDuplicate($params, $duplicates, $contributionID)) {
 111       $message = ts("Duplicate error - existing contribution record(s) have a matching Transaction ID or Invoice ID. Contribution record ID(s) are: " . implode(', ', $duplicates));
 112       throw new CRM_Core_Exception($message);
 113     }
 114
 115     // first clean up all the money fields
 116     $moneyFields = array(
 117       'total_amount',
 118       'net_amount',
 119       'fee_amount',
 120       'non_deductible_amount',
 121     );
 122
 123     //if priceset is used, no need to cleanup money
 124     if (!empty($params['skipCleanMoney'])) {
 125       $moneyFields = [];
 126     }
 127     else {
 128       // @todo put a deprecated here - this should be done in the form layer.
 129       $params['skipCleanMoney'] = FALSE;
 130       Civi::log()->warning('Deprecated code path. Money should always be clean before it hits the BAO.', array('civi.tag' => 'deprecated'));
 131     }
 132
 133     foreach ($moneyFields as $field) {
 134       if (isset($params[$field])) {
 135         $params[$field] = CRM_Utils_Rule::cleanMoney($params[$field]);
 136       }
 137     }
 138
 139     //set defaults in create mode
 140     if (!$contributionID) {
 141       CRM_Core_DAO::setCreateDefaults($params, self::getDefaults());
 142
 143       if (empty($params['invoice_number'])) {
 144         $nextContributionID = CRM_Core_DAO::singleValueQuery("SELECT COALESCE(MAX(id) + 1, 1) FROM civicrm_contribution");
 145         $params['invoice_number'] = self::getInvoiceNumber($nextContributionID);
 146       }
 147     }
 148
 149     $contributionStatus = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');
 150     //if contribution is created with cancelled or refunded status, add credit note id
 151     if (!empty($params['contribution_status_id'])) {
 152       // @todo - should we include Chargeback? If so use self::isContributionStatusNegative($params['contribution_status_id'])
 153       if (($params['contribution_status_id'] == array_search('Refunded', $contributionStatus)
 154         || $params['contribution_status_id'] == array_search('Cancelled', $contributionStatus))
 155       ) {
 156         if (empty($params['creditnote_id']) || $params['creditnote_id'] == "null") {
 157           $params['creditnote_id'] = self::createCreditNoteId();
 158         }
 159       }
 160     }
 161     else {
 162       // Since the fee amount is expecting this (later on) ensure it is always set.
 163       // It would only not be set for an update where it is unchanged.
 164       $params['contribution_status_id'] = civicrm_api3('Contribution', 'getvalue', array('id' => $contributionID, 'return' => 'contribution_status_id'));
 165     }
 166
 167     if (!$contributionID
 168       && CRM_Utils_Array::value('membership_id', $params)
 169       && self::checkContributeSettings('deferred_revenue_enabled')
 170     ) {
 171       $memberStartDate = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_Membership', $params['membership_id'], 'start_date');
 172       if ($memberStartDate) {
 173         $params['revenue_recognition_date'] = date('Ymd', strtotime($memberStartDate));
 174       }
 175     }
 176     self::calculateMissingAmountParams($params, $contributionID);
 177
 178     if (!empty($params['payment_instrument_id'])) {
 179       $paymentInstruments = CRM_Contribute_PseudoConstant::paymentInstrument('name');
 180       if ($params['payment_instrument_id'] != array_search('Check', $paymentInstruments)) {
 181         $params['check_number'] = 'null';
 182       }
 183     }
 184
 185     $setPrevContribution = TRUE;
 186     // CRM-13964 partial payment
 187     if (!empty($params['partial_payment_total']) && !empty($params['partial_amount_to_pay'])) {
 188       $partialAmtTotal = $params['partial_payment_total'];
 189       $partialAmtPay = $params['partial_amount_to_pay'];
 190       $params['total_amount'] = $partialAmtTotal;
 191       if ($partialAmtPay < $partialAmtTotal) {
 192         $params['contribution_status_id'] = CRM_Core_PseudoConstant::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Partially paid');
 193         $params['is_pay_later'] = 0;
 194         $setPrevContribution = FALSE;
 195       }
 196     }
 197     if ($contributionID && $setPrevContribution) {
 198       $params['prevContribution'] = self::getOriginalContribution($contributionID);
 199     }
 200
 201     if ($contributionID && !empty($params['revenue_recognition_date']) && !empty($params['prevContribution'])
 202       && !($contributionStatus[$params['prevContribution']->contribution_status_id] == 'Pending')
 203       && !self::allowUpdateRevenueRecognitionDate($contributionID)
 204     ) {
 205       unset($params['revenue_recognition_date']);
 206     }
 207
 208     if (!isset($params['tax_amount']) && $setPrevContribution && (isset($params['total_amount']) ||
 209      isset($params['financial_type_id']))) {
 210       $params = CRM_Contribute_BAO_Contribution::checkTaxAmount($params);
 211     }
 212
 213     if ($contributionID) {
 214       CRM_Utils_Hook::pre('edit', 'Contribution', $contributionID, $params);
 215     }
 216     else {
 217       CRM_Utils_Hook::pre('create', 'Contribution', NULL, $params);
 218     }
 219     $contribution = new CRM_Contribute_BAO_Contribution();
 220     $contribution->copyValues($params);
 221
 222     $contribution->id = $contributionID;
 223
 224     if (empty($contribution->id)) {
 225       // (only) on 'create', make sure that a valid currency is set (CRM-16845)
 226       if (!CRM_Utils_Rule::currencyCode($contribution->currency)) {
 227         $contribution->currency = CRM_Core_Config::singleton()->defaultCurrency;
 228       }
 229     }
 230
 231     $result = $contribution->save();
 232
 233     // Add financial_trxn details as part of fix for CRM-4724
 234     $contribution->trxn_result_code = CRM_Utils_Array::value('trxn_result_code', $params);
 235     $contribution->payment_processor = CRM_Utils_Array::value('payment_processor', $params);
 236
 237     //add Account details
 238     $params['contribution'] = $contribution;
 239     self::recordFinancialAccounts($params);
 240
 241     if (self::isUpdateToRecurringContribution($params)) {
 242       CRM_Contribute_BAO_ContributionRecur::updateOnNewPayment(
 243         (!empty($params['contribution_recur_id']) ? $params['contribution_recur_id'] : $params['prevContribution']->contribution_recur_id),
 244         $contributionStatus[$params['contribution_status_id']],
 245         CRM_Utils_Array::value('receive_date', $params)
 246       );
 247     }
 248
 249     CRM_Contact_BAO_GroupContactCache::opportunisticCacheFlush();
 250
 251     if ($contributionID) {
 252       CRM_Utils_Hook::post('edit', 'Contribution', $contribution->id, $contribution);
 253     }
 254     else {
 255       CRM_Utils_Hook::post('create', 'Contribution', $contribution->id, $contribution);
 256     }
 257
 258     return $result;
 259   }
 260
 261   /**
 262    * Is this contribution updating an existing recurring contribution.
 263    *
 264    * We need to upd the status of the linked recurring contribution if we have a new payment against it, or the initial
 265    * pending payment is being confirmed (or failing).
 266    *
 267    * @param array $params
 268    *
 269    * @return bool
 270    */
 271   public static function isUpdateToRecurringContribution($params) {
 272     if (!empty($params['contribution_recur_id']) && empty($params['id'])) {
 273       return TRUE;
 274     }
 275     if (empty($params['prevContribution']) || empty($params['contribution_status_id'])) {
 276       return FALSE;
 277     }
 278     if (empty($params['contribution_recur_id']) && empty($params['prevContribution']->contribution_recur_id)) {
 279       return FALSE;
 280     }
 281     $contributionStatus = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');
 282     if ($params['prevContribution']->contribution_status_id == array_search('Pending', $contributionStatus)) {
 283       return TRUE;
 284     }
 285     return FALSE;
 286   }
 287
 288   /**
 289    * Get defaults for new entity.
 290    * @return array
 291    */
 292   public static function getDefaults() {
 293     return array(
 294       'payment_instrument_id' => key(CRM_Core_OptionGroup::values('payment_instrument',
 295           FALSE, FALSE, FALSE, 'AND is_default = 1')
 296       ),
 297       'contribution_status_id' => CRM_Core_Pseudoconstant::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Completed'),
 298     );
 299   }
 300
 301   /**
 302    * Fetch the object and store the values in the values array.
 303    *
 304    * @param array $params
 305    *   Input parameters to find object.
 306    * @param array $values
 307    *   Output values of the object.
 308    * @param array $ids
 309    *   The array that holds all the db ids.
 310    *
 311    * @return CRM_Contribute_BAO_Contribution|null
 312    *   The found object or null
 313    */
 314   public static function getValues($params, &$values, &$ids) {
 315     if (empty($params)) {
 316       return NULL;
 317     }
 318     $contribution = new CRM_Contribute_BAO_Contribution();
 319
 320     $contribution->copyValues($params);
 321
 322     if ($contribution->find(TRUE)) {
 323       $ids['contribution'] = $contribution->id;
 324
 325       CRM_Core_DAO::storeValues($contribution, $values);
 326
 327       return $contribution;
 328     }
 329     $null = NULL; // return by reference
 330     return $null;
 331   }
 332
 333   /**
 334    * Get the values and resolve the most common mappings.
 335    *
 336    * Since contribution status is resolved in almost every function that calls getValues it makes
 337    * sense to have an extra function to resolve it rather than repeat the code.
 338    *
 339    * Think carefully before adding more mappings to be resolved as there could be performance implications
 340    * if this function starts to be called from more iterative functions.
 341    *
 342    * @param array $params
 343    *   Input parameters to find object.
 344    *
 345    * @return array
 346    *   Array of the found contribution.
 347    * @throws CRM_Core_Exception
 348    */
 349   public static function getValuesWithMappings($params) {
 350     $values = $ids = array();
 351     $contribution = self::getValues($params, $values, $ids);
 352     if (is_null($contribution)) {
 353       throw new CRM_Core_Exception('No contribution found');
 354     }
 355     $values['contribution_status'] = CRM_Core_PseudoConstant::getName('CRM_Contribute_BAO_Contribution', 'contribution_status_id', $values['contribution_status_id']);
 356     return $values;
 357   }
 358
 359   /**
 360    * Calculate net_amount & fee_amount if they are not set.
 361    *
 362    * Net amount should be total - fee.
 363    * This should only be called for new contributions.
 364    *
 365    * @param array $params
 366    *   Params for a new contribution before they are saved.
 367    * @param int|null $contributionID
 368    *   Contribution ID if we are dealing with an update.
 369    *
 370    * @throws \CiviCRM_API3_Exception
 371    */
 372   public static function calculateMissingAmountParams(&$params, $contributionID) {
 373     if (!$contributionID && !isset($params['fee_amount'])) {
 374       if (isset($params['total_amount']) && isset($params['net_amount'])) {
 375         $params['fee_amount'] = $params['total_amount'] - $params['net_amount'];
 376       }
 377       else {
 378         $params['fee_amount'] = 0;
 379       }
 380     }
 381     if (!isset($params['net_amount'])) {
 382       if (!$contributionID) {
 383         $params['net_amount'] = $params['total_amount'] - $params['fee_amount'];
 384       }
 385       else {
 386         if (isset($params['fee_amount']) || isset($params['total_amount'])) {
 387           // We have an existing contribution and fee_amount or total_amount has been passed in but not net_amount.
 388           // net_amount may need adjusting.
 389           $contribution = civicrm_api3('Contribution', 'getsingle', array(
 390             'id' => $contributionID,
 391             'return' => array('total_amount', 'net_amount', 'fee_amount'),
 392           ));
 393           $totalAmount = isset($params['total_amount']) ? $params['total_amount'] : CRM_Utils_Array::value('total_amount', $contribution);
 394           $feeAmount = isset($params['fee_amount']) ? $params['fee_amount'] : CRM_Utils_Array::value('fee_amount', $contribution);
 395           $params['net_amount'] = $totalAmount - $feeAmount;
 396         }
 397       }
 398     }
 399   }
 400
 401   /**
 402    * @param $params
 403    * @param $billingLocationTypeID
 404    *
 405    * @return array
 406    */
 407   protected static function getBillingAddressParams($params, $billingLocationTypeID) {
 408     $hasBillingField = FALSE;
 409     $billingFields = array(
 410       'street_address',
 411       'city',
 412       'state_province_id',
 413       'postal_code',
 414       'country_id',
 415     );
 416
 417     //build address array
 418     $addressParams = array();
 419     $addressParams['location_type_id'] = $billingLocationTypeID;
 420     $addressParams['is_billing'] = 1;
 421
 422     $billingFirstName = CRM_Utils_Array::value('billing_first_name', $params);
 423     $billingMiddleName = CRM_Utils_Array::value('billing_middle_name', $params);
 424     $billingLastName = CRM_Utils_Array::value('billing_last_name', $params);
 425     $addressParams['address_name'] = "{$billingFirstName}" . CRM_Core_DAO::VALUE_SEPARATOR . "{$billingMiddleName}" . CRM_Core_DAO::VALUE_SEPARATOR . "{$billingLastName}";
 426
 427     foreach ($billingFields as $value) {
 428       $addressParams[$value] = CRM_Utils_Array::value("billing_{$value}-{$billingLocationTypeID}", $params);
 429       if (!empty($addressParams[$value])) {
 430         $hasBillingField = TRUE;
 431       }
 432     }
 433     return array($hasBillingField, $addressParams);
 434   }
 435
 436   /**
 437    * Get address params ready to be passed to the payment processor.
 438    *
 439    * We need address params in a couple of formats. For the payment processor we wan state_province_id-5.
 440    * To create an address we need state_province_id.
 441    *
 442    * @param array $params
 443    * @param int $billingLocationTypeID
 444    *
 445    * @return array
 446    */
 447   public static function getPaymentProcessorReadyAddressParams($params, $billingLocationTypeID) {
 448     list($hasBillingField, $addressParams) = self::getBillingAddressParams($params, $billingLocationTypeID);
 449     foreach ($addressParams as $name => $field) {
 450       if (substr($name, 0, 8) == 'billing_') {
 451         $addressParams[substr($name, 9)] = $addressParams[$field];
 452       }
 453     }
 454     return array($hasBillingField, $addressParams);
 455   }
 456
 457   /**
 458    * Get the number of terms for this contribution for a given membership type
 459    * based on querying the line item table and relevant price field values
 460    * Note that any one contribution should only be able to have one line item relating to a particular membership
 461    * type
 462    *
 463    * @param int $membershipTypeID
 464    *
 465    * @param int $contributionID
 466    *
 467    * @return int
 468    */
 469   public function getNumTermsByContributionAndMembershipType($membershipTypeID, $contributionID) {
 470     $numTerms = CRM_Core_DAO::singleValueQuery("
 471       SELECT membership_num_terms FROM civicrm_line_item li
 472       LEFT JOIN civicrm_price_field_value v ON li.price_field_value_id = v.id
 473       WHERE contribution_id = %1 AND membership_type_id = %2",
 474       array(1 => array($contributionID, 'Integer'), 2 => array($membershipTypeID, 'Integer'))
 475     );
 476     // default of 1 is precautionary
 477     return empty($numTerms) ? 1 : $numTerms;
 478   }
 479
 480   /**
 481    * Takes an associative array and creates a contribution object.
 482    *
 483    * @param array $params
 484    *   (reference ) an assoc array of name/value pairs.
 485    * @param array $ids
 486    *   The array that holds all the db ids.
 487    *
 488    * @return CRM_Contribute_BAO_Contribution
 489    */
 490   public static function create(&$params, $ids = array()) {
 491     $dateFields = array('receive_date', 'cancel_date', 'receipt_date', 'thankyou_date', 'revenue_recognition_date');
 492     foreach ($dateFields as $df) {
 493       if (isset($params[$df])) {
 494         $params[$df] = CRM_Utils_Date::isoToMysql($params[$df]);
 495       }
 496     }
 497
 498     $transaction = new CRM_Core_Transaction();
 499
 500     try {
 501       $contribution = self::add($params, $ids);
 502     }
 503     catch (CRM_Core_Exception $e) {
 504       $transaction->rollback();
 505       throw $e;
 506     }
 507
 508     $params['contribution_id'] = $contribution->id;
 509
 510     if (!empty($params['custom']) &&
 511       is_array($params['custom'])
 512     ) {
 513       CRM_Core_BAO_CustomValueTable::store($params['custom'], 'civicrm_contribution', $contribution->id);
 514     }
 515
 516     $session = CRM_Core_Session::singleton();
 517
 518     if (!empty($params['note'])) {
 519       $noteParams = array(
 520         'entity_table' => 'civicrm_contribution',
 521         'note' => $params['note'],
 522         'entity_id' => $contribution->id,
 523         'contact_id' => $session->get('userID'),
 524         'modified_date' => date('Ymd'),
 525       );
 526       if (!$noteParams['contact_id']) {
 527         $noteParams['contact_id'] = $params['contact_id'];
 528       }
 529       CRM_Core_BAO_Note::add($noteParams);
 530     }
 531
 532     // make entry in batch entity batch table
 533     if (!empty($params['batch_id'])) {
 534       // in some update cases we need to get extra fields - ie an update that doesn't pass in all these params
 535       $titleFields = array(
 536         'contact_id',
 537         'total_amount',
 538         'currency',
 539         'financial_type_id',
 540       );
 541       $retrieveRequired = 0;
 542       foreach ($titleFields as $titleField) {
 543         if (!isset($contribution->$titleField)) {
 544           $retrieveRequired = 1;
 545           break;
 546         }
 547       }
 548       if ($retrieveRequired == 1) {
 549         $contribution->find(TRUE);
 550       }
 551     }
 552
 553     CRM_Contribute_BAO_ContributionSoft::processSoftContribution($params, $contribution);
 554
 555     $transaction->commit();
 556
 557     $activity = civicrm_api3('Activity', 'get', array(
 558       'source_record_id' => $contribution->id,
 559       'options' => array('limit' => 1),
 560       'sequential' => 1,
 561       'activity_type_id' => 'Contribution',
 562       'return' => array('id', 'campaign'),
 563     ));
 564
 565     //CRM-18406: Update activity when edit contribution.
 566     if ($activity['count']) {
 567       // CRM-13237 : if activity record found, update it with campaign id of contribution
 568       // @todo compare campaign ids first.
 569       CRM_Core_DAO::setFieldValue('CRM_Activity_BAO_Activity', $activity['id'], 'campaign_id', $contribution->campaign_id);
 570       $contribution->activity_id = $activity['id'];
 571     }
 572
 573     if (empty($contribution->contact_id)) {
 574       $contribution->find(TRUE);
 575     }
 576     CRM_Activity_BAO_Activity::addActivity($contribution, 'Contribution');
 577
 578     // do not add to recent items for import, CRM-4399
 579     if (empty($params['skipRecentView'])) {
 580       $url = CRM_Utils_System::url('civicrm/contact/view/contribution',
 581         "action=view&reset=1&id={$contribution->id}&cid={$contribution->contact_id}&context=home"
 582       );
 583       // in some update cases we need to get extra fields - ie an update that doesn't pass in all these params
 584       $titleFields = array(
 585         'contact_id',
 586         'total_amount',
 587         'currency',
 588         'financial_type_id',
 589       );
 590       $retrieveRequired = 0;
 591       foreach ($titleFields as $titleField) {
 592         if (!isset($contribution->$titleField)) {
 593           $retrieveRequired = 1;
 594           break;
 595         }
 596       }
 597       if ($retrieveRequired == 1) {
 598         $contribution->find(TRUE);
 599       }
 600       $financialType = CRM_Contribute_PseudoConstant::financialType($contribution->financial_type_id);
 601       $title = CRM_Contact_BAO_Contact::displayName($contribution->contact_id) . ' - (' . CRM_Utils_Money::format($contribution->total_amount, $contribution->currency) . ' ' . ' - ' . $financialType . ')';
 602
 603       $recentOther = array();
 604       if (CRM_Core_Permission::checkActionPermission('CiviContribute', CRM_Core_Action::UPDATE)) {
 605         $recentOther['editUrl'] = CRM_Utils_System::url('civicrm/contact/view/contribution',
 606           "action=update&reset=1&id={$contribution->id}&cid={$contribution->contact_id}&context=home"
 607         );
 608       }
 609
 610       if (CRM_Core_Permission::checkActionPermission('CiviContribute', CRM_Core_Action::DELETE)) {
 611         $recentOther['deleteUrl'] = CRM_Utils_System::url('civicrm/contact/view/contribution',
 612           "action=delete&reset=1&id={$contribution->id}&cid={$contribution->contact_id}&context=home"
 613         );
 614       }
 615
 616       // add the recently created Contribution
 617       CRM_Utils_Recent::add($title,
 618         $url,
 619         $contribution->id,
 620         'Contribution',
 621         $contribution->contact_id,
 622         NULL,
 623         $recentOther
 624       );
 625     }
 626
 627     return $contribution;
 628   }
 629
 630   /**
 631    * Get the values for pseudoconstants for name->value and reverse.
 632    *
 633    * @param array $defaults
 634    *   (reference) the default values, some of which need to be resolved.
 635    * @param bool $reverse
 636    *   True if we want to resolve the values in the reverse direction (value -> name).
 637    */
 638   public static function resolveDefaults(&$defaults, $reverse = FALSE) {
 639     self::lookupValue($defaults, 'financial_type', CRM_Contribute_PseudoConstant::financialType(), $reverse);
 640     self::lookupValue($defaults, 'payment_instrument', CRM_Contribute_PseudoConstant::paymentInstrument(), $reverse);
 641     self::lookupValue($defaults, 'contribution_status', CRM_Contribute_PseudoConstant::contributionStatus(), $reverse);
 642     self::lookupValue($defaults, 'pcp', CRM_Contribute_PseudoConstant::pcPage(), $reverse);
 643   }
 644
 645   /**
 646    * Convert associative array names to values and vice-versa.
 647    *
 648    * This function is used by both the web form layer and the api. Note that
 649    * the api needs the name => value conversion, also the view layer typically
 650    * requires value => name conversion
 651    *
 652    * @param array $defaults
 653    * @param string $property
 654    * @param array $lookup
 655    * @param bool $reverse
 656    *
 657    * @return bool
 658    */
 659   public static function lookupValue(&$defaults, $property, &$lookup, $reverse) {
 660     $id = $property . '_id';
 661
 662     $src = $reverse ? $property : $id;
 663     $dst = $reverse ? $id : $property;
 664
 665     if (!array_key_exists($src, $defaults)) {
 666       return FALSE;
 667     }
 668
 669     $look = $reverse ? array_flip($lookup) : $lookup;
 670
 671     if (is_array($look)) {
 672       if (!array_key_exists($defaults[$src], $look)) {
 673         return FALSE;
 674       }
 675     }
 676     $defaults[$dst] = $look[$defaults[$src]];
 677     return TRUE;
 678   }
 679
 680   /**
 681    * Retrieve DB object based on input parameters.
 682    *
 683    * It also stores all the retrieved values in the default array.
 684    *
 685    * @param array $params
 686    *   (reference ) an assoc array of name/value pairs.
 687    * @param array $defaults
 688    *   (reference ) an assoc array to hold the name / value pairs.
 689    *                        in a hierarchical manner
 690    * @param array $ids
 691    *   (reference) the array that holds all the db ids.
 692    *
 693    * @return CRM_Contribute_BAO_Contribution
 694    */
 695   public static function retrieve(&$params, &$defaults, &$ids) {
 696     $contribution = CRM_Contribute_BAO_Contribution::getValues($params, $defaults, $ids);
 697     return $contribution;
 698   }
 699
 700   /**
 701    * Combine all the importable fields from the lower levels object.
 702    *
 703    * The ordering is important, since currently we do not have a weight
 704    * scheme. Adding weight is super important and should be done in the
 705    * next week or so, before this can be called complete.
 706    *
 707    * @param string $contactType
 708    * @param bool $status
 709    *
 710    * @return array
 711    *   array of importable Fields
 712    */
 713   public static function &importableFields($contactType = 'Individual', $status = TRUE) {
 714     if (!self::$_importableFields) {
 715       if (!self::$_importableFields) {
 716         self::$_importableFields = array();
 717       }
 718
 719       if (!$status) {
 720         $fields = array('' => array('title' => ts('- do not import -')));
 721       }
 722       else {
 723         $fields = array('' => array('title' => ts('- Contribution Fields -')));
 724       }
 725
 726       $note = CRM_Core_DAO_Note::import();
 727       $tmpFields = CRM_Contribute_DAO_Contribution::import();
 728       unset($tmpFields['option_value']);
 729       $optionFields = CRM_Core_OptionValue::getFields($mode = 'contribute');
 730       $contactFields = CRM_Contact_BAO_Contact::importableFields($contactType, NULL);
 731
 732       // Using new Dedupe rule.
 733       $ruleParams = array(
 734         'contact_type' => $contactType,
 735         'used' => 'Unsupervised',
 736       );
 737       $fieldsArray = CRM_Dedupe_BAO_Rule::dedupeRuleFields($ruleParams);
 738       $tmpContactField = array();
 739       if (is_array($fieldsArray)) {
 740         foreach ($fieldsArray as $value) {
 741           //skip if there is no dupe rule
 742           if ($value == 'none') {
 743             continue;
 744           }
 745           $customFieldId = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_CustomField',
 746             $value,
 747             'id',
 748             'column_name'
 749           );
 750           $value = $customFieldId ? 'custom_' . $customFieldId : $value;
 751           $tmpContactField[trim($value)] = $contactFields[trim($value)];
 752           if (!$status) {
 753             $title = $tmpContactField[trim($value)]['title'] . ' ' . ts('(match to contact)');
 754           }
 755           else {
 756             $title = $tmpContactField[trim($value)]['title'];
 757           }
 758           $tmpContactField[trim($value)]['title'] = $title;
 759         }
 760       }
 761
 762       $tmpContactField['external_identifier'] = $contactFields['external_identifier'];
 763       $tmpContactField['external_identifier']['title'] = $contactFields['external_identifier']['title'] . ' ' . ts('(match to contact)');
 764       $tmpFields['contribution_contact_id']['title'] = $tmpFields['contribution_contact_id']['title'] . ' ' . ts('(match to contact)');
 765       $fields = array_merge($fields, $tmpContactField);
 766       $fields = array_merge($fields, $tmpFields);
 767       $fields = array_merge($fields, $note);
 768       $fields = array_merge($fields, $optionFields);
 769       $fields = array_merge($fields, CRM_Financial_DAO_FinancialType::export());
 770       $fields = array_merge($fields, CRM_Core_BAO_CustomField::getFieldsForImport('Contribution'));
 771       self::$_importableFields = $fields;
 772     }
 773     return self::$_importableFields;
 774   }
 775
 776   /**
 777    * Combine all the exportable fields from the lower level objects.
 778    *
 779    * @param bool $checkPermission
 780    *
 781    * @return array
 782    *   array of exportable Fields
 783    */
 784   public static function &exportableFields($checkPermission = TRUE) {
 785     if (!self::$_exportableFields) {
 786       if (!self::$_exportableFields) {
 787         self::$_exportableFields = array();
 788       }
 789
 790       $fields = CRM_Contribute_DAO_Contribution::export();
 791       if (CRM_Contribute_BAO_Query::isSiteHasProducts()) {
 792         $fields = array_merge(
 793           $fields,
 794           CRM_Contribute_DAO_Product::export(),
 795           CRM_Contribute_DAO_ContributionProduct::export(),
 796           // CRM-16713 - contribution search by Premiums on 'Find Contribution' form.
 797           [
 798             'contribution_product_id' => [
 799               'title' => ts('Premium'),
 800               'name' => 'contribution_product_id',
 801               'where' => 'civicrm_product.id',
 802               'data_type' => CRM_Utils_Type::T_INT,
 803             ],
 804           ]
 805         );
 806       }
 807       $typeField = CRM_Financial_DAO_FinancialType::export();
 808       $financialAccount = CRM_Financial_DAO_FinancialAccount::export();
 809
 810       $contributionPage = array(
 811         'contribution_page' => array(
 812           'title' => ts('Contribution Page'),
 813           'name' => 'contribution_page',
 814           'where' => 'civicrm_contribution_page.title',
 815           'data_type' => CRM_Utils_Type::T_STRING,
 816         ),
 817       );
 818
 819       $contributionNote = array(
 820         'contribution_note' => array(
 821           'title' => ts('Contribution Note'),
 822           'name' => 'contribution_note',
 823           'data_type' => CRM_Utils_Type::T_TEXT,
 824         ),
 825       );
 826
 827       $extraFields = array(
 828         'contribution_batch' => array(
 829           'title' => ts('Batch Name'),
 830         ),
 831       );
 832
 833       // CRM-17787
 834       $campaignTitle = array(
 835         'contribution_campaign_title' => array(
 836           'title' => ts('Campaign Title'),
 837           'name' => 'campaign_title',
 838           'where' => 'civicrm_campaign.title',
 839           'data_type' => CRM_Utils_Type::T_STRING,
 840         ),
 841       );
 842       $softCreditFields = array(
 843         'contribution_soft_credit_name' => array(
 844           'name' => 'contribution_soft_credit_name',
 845           'title' => ts('Soft Credit For'),
 846           'where' => 'civicrm_contact_d.display_name',
 847           'data_type' => CRM_Utils_Type::T_STRING,
 848         ),
 849         'contribution_soft_credit_amount' => array(
 850           'name' => 'contribution_soft_credit_amount',
 851           'title' => ts('Soft Credit Amount'),
 852           'where' => 'civicrm_contribution_soft.amount',
 853           'data_type' => CRM_Utils_Type::T_MONEY,
 854         ),
 855         'contribution_soft_credit_type' => array(
 856           'name' => 'contribution_soft_credit_type',
 857           'title' => ts('Soft Credit Type'),
 858           'where' => 'contribution_softcredit_type.label',
 859           'data_type' => CRM_Utils_Type::T_STRING,
 860         ),
 861         'contribution_soft_credit_contribution_id' => array(
 862           'name' => 'contribution_soft_credit_contribution_id',
 863           'title' => ts('Soft Credit For Contribution ID'),
 864           'where' => 'civicrm_contribution_soft.contribution_id',
 865           'data_type' => CRM_Utils_Type::T_INT,
 866         ),
 867         'contribution_soft_credit_contact_id' => array(
 868           'name' => 'contribution_soft_credit_contact_id',
 869           'title' => ts('Soft Credit For Contact ID'),
 870           'where' => 'civicrm_contact_d.id',
 871           'data_type' => CRM_Utils_Type::T_INT,
 872         ),
 873       );
 874
 875       $fields = array_merge($fields, $typeField, $contributionPage,
 876         $contributionNote, $extraFields, $softCreditFields, $financialAccount, $campaignTitle,
 877         CRM_Core_BAO_CustomField::getFieldsForImport('Contribution', FALSE, FALSE, FALSE, $checkPermission)
 878       );
 879
 880       self::$_exportableFields = $fields;
 881     }
 882
 883     return self::$_exportableFields;
 884   }
 885
 886   /**
 887    * @param $contributionId
 888    * @param $paymentType
 889    * @param $participantId
 890    *
 891    * @param $financialTrxn
 892    */
 893   protected static function recordPaymentActivity($contributionId, $participantId, $financialTrxn) {
 894     $activityType = ($financialTrxn->total_amount < 0) ? 'Refund' : 'Payment';
 895     if ($participantId) {
 896       $inputParams['id'] = $participantId;
 897       $values = [];
 898       $ids = [];
 899       $component = 'event';
 900       $entityObj = CRM_Event_BAO_Participant::getValues($inputParams, $values, $ids);
 901       $entityObj = $entityObj[$participantId];
 902     }
 903     else {
 904       $entityObj = new CRM_Contribute_BAO_Contribution();
 905       $entityObj->id = $contributionId;
 906       $entityObj->find(TRUE);
 907       $component = 'contribution';
 908     }
 909
 910     self::addActivityForPayment($entityObj, $financialTrxn, $activityType, $component, $contributionId);
 911   }
 912
 913   /**
 914    * @inheritDoc
 915    */
 916   public function addSelectWhereClause() {
 917     $whereClauses = parent::addSelectWhereClause();
 918     if ($whereClauses !== []) {
 919       // In this case permisssions have been applied & we assume the
 920       // financialaclreport is applying these
 921       // https://github.com/JMAConsulting/biz.jmaconsulting.financialaclreport/blob/master/financialaclreport.php#L107
 922       return $whereClauses;
 923     }
 924
 925     if (!CRM_Financial_BAO_FinancialType::isACLFinancialTypeStatus()) {
 926       return $whereClauses;
 927     }
 928     $types = CRM_Financial_BAO_FinancialType::getAllEnabledAvailableFinancialTypes();
 929     if (empty($types)) {
 930       $whereClauses['financial_type_id'] = 'IN (0)';
 931     }
 932     else {
 933       $whereClauses['financial_type_id'] = [
 934         'IN (' . implode(',', array_keys($types)) . ')'
 935       ];
 936     }
 937     return $whereClauses;
 938   }
 939
 940   /**
 941    * @param null $status
 942    * @param null $startDate
 943    * @param null $endDate
 944    *
 945    * @return array|null
 946    */
 947   public static function getTotalAmountAndCount($status = NULL, $startDate = NULL, $endDate = NULL) {
 948     $where = array();
 949     switch ($status) {
 950       case 'Valid':
 951         $where[] = 'contribution_status_id = 1';
 952         break;
 953
 954       case 'Cancelled':
 955         $where[] = 'contribution_status_id = 3';
 956         break;
 957     }
 958
 959     if ($startDate) {
 960       $where[] = "receive_date >= '" . CRM_Utils_Type::escape($startDate, 'Timestamp') . "'";
 961     }
 962     if ($endDate) {
 963       $where[] = "receive_date <= '" . CRM_Utils_Type::escape($endDate, 'Timestamp') . "'";
 964     }
 965     $financialTypeACLJoin = '';
 966     if (CRM_Financial_BAO_FinancialType::isACLFinancialTypeStatus()) {
 967       $financialTypeACLJoin = " LEFT JOIN civicrm_line_item i ON (i.contribution_id = c.id AND i.entity_table = 'civicrm_contribution') ";
 968       $financialTypes = CRM_Contribute_PseudoConstant::financialType();
 969       CRM_Financial_BAO_FinancialType::getAvailableFinancialTypes($financialTypes);
 970       if ($financialTypes) {
 971         $where[] = "c.financial_type_id IN (" . implode(',', array_keys($financialTypes)) . ")";
 972         $where[] = "i.financial_type_id IN (" . implode(',', array_keys($financialTypes)) . ")";
 973       }
 974       else {
 975         $where[] = "c.financial_type_id IN (0)";
 976       }
 977     }
 978
 979     $whereCond = implode(' AND ', $where);
 980
 981     $query = "
 982     SELECT  sum( total_amount ) as total_amount,
 983             count( c.id ) as total_count,
 984             currency
 985       FROM  civicrm_contribution c
 986 INNER JOIN  civicrm_contact contact ON ( contact.id = c.contact_id )
 987      $financialTypeACLJoin
 988      WHERE  $whereCond
 989        AND  ( is_test = 0 OR is_test IS NULL )
 990        AND  contact.is_deleted = 0
 991   GROUP BY  currency
 992 ";
 993
 994     $dao = CRM_Core_DAO::executeQuery($query);
 995     $amount = array();
 996     $count = 0;
 997     while ($dao->fetch()) {
 998       $count += $dao->total_count;
 999       $amount[] = CRM_Utils_Money::format($dao->total_amount, $dao->currency);
1000     }
1001     if ($count) {
1002       return array(
1003         'amount' => implode(', ', $amount),
1004         'count' => $count,
1005       );
1006     }
1007     return NULL;
1008   }
1009
1010   /**
1011    * Delete the indirect records associated with this contribution first.
1012    *
1013    * @param int $id
1014    *
1015    * @return mixed|null
1016    *   $results no of deleted Contribution on success, false otherwise
1017    */
1018   public static function deleteContribution($id) {
1019     CRM_Utils_Hook::pre('delete', 'Contribution', $id, CRM_Core_DAO::$_nullArray);
1020
1021     $transaction = new CRM_Core_Transaction();
1022
1023     $results = NULL;
1024     //delete activity record
1025     $params = array(
1026       'source_record_id' => $id,
1027       // activity type id for contribution
1028       'activity_type_id' => 6,
1029     );
1030
1031     CRM_Activity_BAO_Activity::deleteActivity($params);
1032
1033     //delete billing address if exists for this contribution.
1034     self::deleteAddress($id);
1035
1036     //update pledge and pledge payment, CRM-3961
1037     CRM_Pledge_BAO_PledgePayment::resetPledgePayment($id);
1038
1039     // remove entry from civicrm_price_set_entity, CRM-5095
1040     if (CRM_Price_BAO_PriceSet::getFor('civicrm_contribution', $id)) {
1041       CRM_Price_BAO_PriceSet::removeFrom('civicrm_contribution', $id);
1042     }
1043     // cleanup line items.
1044     $participantId = CRM_Core_DAO::getFieldValue('CRM_Event_DAO_ParticipantPayment', $id, 'participant_id', 'contribution_id');
1045
1046     // delete any related entity_financial_trxn, financial_trxn and financial_item records.
1047     CRM_Core_BAO_FinancialTrxn::deleteFinancialTrxn($id);
1048
1049     if ($participantId) {
1050       CRM_Price_BAO_LineItem::deleteLineItems($participantId, 'civicrm_participant');
1051     }
1052     else {
1053       CRM_Price_BAO_LineItem::deleteLineItems($id, 'civicrm_contribution');
1054     }
1055
1056     //delete note.
1057     $note = CRM_Core_BAO_Note::getNote($id, 'civicrm_contribution');
1058     $noteId = key($note);
1059     if ($noteId) {
1060       CRM_Core_BAO_Note::del($noteId, FALSE);
1061     }
1062
1063     $dao = new CRM_Contribute_DAO_Contribution();
1064     $dao->id = $id;
1065
1066     $results = $dao->delete();
1067
1068     $transaction->commit();
1069
1070     CRM_Utils_Hook::post('delete', 'Contribution', $dao->id, $dao);
1071
1072     // delete the recently created Contribution
1073     $contributionRecent = array(
1074       'id' => $id,
1075       'type' => 'Contribution',
1076     );
1077     CRM_Utils_Recent::del($contributionRecent);
1078
1079     return $results;
1080   }
1081
1082   /**
1083    * React to a financial transaction (payment) failure.
1084    *
1085    * Prior to CRM-16417 these were simply removed from the database but it has been agreed that seeing attempted
1086    * payments is important for forensic and outreach reasons.
1087    *
1088    * @param int $contributionID
1089    * @param int $contactID
1090    * @param string $message
1091    *
1092    * @throws \CiviCRM_API3_Exception
1093    */
1094   public static function failPayment($contributionID, $contactID, $message) {
1095     civicrm_api3('activity', 'create', array(
1096       'activity_type_id' => 'Failed Payment',
1097       'details' => $message,
1098       'subject' => ts('Payment failed at payment processor'),
1099       'source_record_id' => $contributionID,
1100       'source_contact_id' => CRM_Core_Session::getLoggedInContactID() ? CRM_Core_Session::getLoggedInContactID() :
1101         $contactID,
1102     ));
1103
1104     // CRM-20336 Make sure that the contribution status is Failed, not Pending.
1105     civicrm_api3('contribution', 'create', array(
1106       'id' => $contributionID,
1107       'contribution_status_id' => 'Failed',
1108     ));
1109   }
1110
1111   /**
1112    * Check if there is a contribution with the same trxn_id or invoice_id.
1113    *
1114    * @param array $input
1115    *   An assoc array of name/value pairs.
1116    * @param array $duplicates
1117    *   (reference) store ids of duplicate contribs.
1118    * @param int $id
1119    *
1120    * @return bool
1121    *   true if duplicate, false otherwise
1122    */
1123   public static function checkDuplicate($input, &$duplicates, $id = NULL) {
1124     if (!$id) {
1125       $id = CRM_Utils_Array::value('id', $input);
1126     }
1127     $trxn_id = CRM_Utils_Array::value('trxn_id', $input);
1128     $invoice_id = CRM_Utils_Array::value('invoice_id', $input);
1129
1130     $clause = array();
1131     $input = array();
1132
1133     if ($trxn_id) {
1134       $clause[] = "trxn_id = %1";
1135       $input[1] = array($trxn_id, 'String');
1136     }
1137
1138     if ($invoice_id) {
1139       $clause[] = "invoice_id = %2";
1140       $input[2] = array($invoice_id, 'String');
1141     }
1142
1143     if (empty($clause)) {
1144       return FALSE;
1145     }
1146
1147     $clause = implode(' OR ', $clause);
1148     if ($id) {
1149       $clause = "( $clause ) AND id != %3";
1150       $input[3] = array($id, 'Integer');
1151     }
1152
1153     $query = "SELECT id FROM civicrm_contribution WHERE $clause";
1154     $dao = CRM_Core_DAO::executeQuery($query, $input);
1155     $result = FALSE;
1156     while ($dao->fetch()) {
1157       $duplicates[] = $dao->id;
1158       $result = TRUE;
1159     }
1160     return $result;
1161   }
1162
1163   /**
1164    * Takes an associative array and creates a contribution_product object.
1165    *
1166    * the function extract all the params it needs to initialize the create a
1167    * contribution_product object. the params array could contain additional unused name/value
1168    * pairs
1169    *
1170    * @param array $params
1171    *   (reference) an assoc array of name/value pairs.
1172    *
1173    * @return CRM_Contribute_DAO_ContributionProduct
1174    */
1175   public static function addPremium(&$params) {
1176     $contributionProduct = new CRM_Contribute_DAO_ContributionProduct();
1177     $contributionProduct->copyValues($params);
1178     return $contributionProduct->save();
1179   }
1180
1181   /**
1182    * Get list of contribution fields for profile.
1183    * For now we only allow custom contribution fields to be in
1184    * profile
1185    *
1186    * @param bool $addExtraFields
1187    *   True if special fields needs to be added.
1188    *
1189    * @return array
1190    *   the list of contribution fields
1191    */
1192   public static function getContributionFields($addExtraFields = TRUE) {
1193     $contributionFields = CRM_Contribute_DAO_Contribution::export();
1194     // @todo remove this - this line was added because payment_instrument_id was not
1195     // set to exportable - but now it is.
1196     $contributionFields = array_merge($contributionFields, CRM_Core_OptionValue::getFields($mode = 'contribute'));
1197
1198     if ($addExtraFields) {
1199       $contributionFields = array_merge($contributionFields, self::getSpecialContributionFields());
1200     }
1201
1202     $contributionFields = array_merge($contributionFields, CRM_Financial_DAO_FinancialType::export());
1203
1204     foreach ($contributionFields as $key => $var) {
1205       if ($key == 'contribution_contact_id') {
1206         continue;
1207       }
1208       elseif ($key == 'contribution_campaign_id') {
1209         $var['title'] = ts('Campaign');
1210       }
1211       $fields[$key] = $var;
1212     }
1213
1214     $fields = array_merge($fields, CRM_Core_BAO_CustomField::getFieldsForImport('Contribution'));
1215     return $fields;
1216   }
1217
1218   /**
1219    * Add extra fields specific to contribution.
1220    */
1221   public static function getSpecialContributionFields() {
1222     $extraFields = array(
1223       'contribution_soft_credit_name' => array(
1224         'name' => 'contribution_soft_credit_name',
1225         'title' => ts('Soft Credit Name'),
1226         'headerPattern' => '/^soft_credit_name$/i',
1227         'where' => 'civicrm_contact_d.display_name',
1228       ),
1229       'contribution_soft_credit_email' => array(
1230         'name' => 'contribution_soft_credit_email',
1231         'title' => ts('Soft Credit Email'),
1232         'headerPattern' => '/^soft_credit_email$/i',
1233         'where' => 'soft_email.email',
1234       ),
1235       'contribution_soft_credit_phone' => array(
1236         'name' => 'contribution_soft_credit_phone',
1237         'title' => ts('Soft Credit Phone'),
1238         'headerPattern' => '/^soft_credit_phone$/i',
1239         'where' => 'soft_phone.phone',
1240       ),
1241       'contribution_soft_credit_contact_id' => array(
1242         'name' => 'contribution_soft_credit_contact_id',
1243         'title' => ts('Soft Credit Contact ID'),
1244         'headerPattern' => '/^soft_credit_contact_id$/i',
1245         'where' => 'civicrm_contribution_soft.contact_id',
1246       ),
1247       'contribution_pcp_title' => array(
1248         'name' => 'contribution_pcp_title',
1249         'title' => ts('Personal Campaign Page Title'),
1250         'headerPattern' => '/^contribution_pcp_title$/i',
1251         'where' => 'contribution_pcp.title',
1252       ),
1253     );
1254
1255     return $extraFields;
1256   }
1257
1258   /**
1259    * @param int $pageID
1260    *
1261    * @return array
1262    */
1263   public static function getCurrentandGoalAmount($pageID) {
1264     $query = "
1265 SELECT p.goal_amount as goal, sum( c.total_amount ) as total
1266   FROM civicrm_contribution_page p,
1267        civicrm_contribution      c
1268  WHERE p.id = c.contribution_page_id
1269    AND p.id = %1
1270    AND c.cancel_date is null
1271 GROUP BY p.id
1272 ";
1273
1274     $config = CRM_Core_Config::singleton();
1275     $params = array(1 => array($pageID, 'Integer'));
1276     $dao = CRM_Core_DAO::executeQuery($query, $params);
1277
1278     if ($dao->fetch()) {
1279       return array($dao->goal, $dao->total);
1280     }
1281     else {
1282       return array(NULL, NULL);
1283     }
1284   }
1285
1286   /**
1287    * Get list of contributions which credit the passed in contact ID.
1288    *
1289    * The returned array provides details about the original contribution & donor.
1290    *
1291    * @todo - this is a confusing function called from one place. It has a test. It would be
1292    * nice to deprecate it.
1293    *
1294    * @param int $honorId
1295    *   In Honor of Contact ID.
1296    *
1297    * @return array
1298    *   list of contribution fields
1299    */
1300   public static function getHonorContacts($honorId) {
1301     $params = array();
1302     $honorDAO = new CRM_Contribute_DAO_ContributionSoft();
1303     $honorDAO->contact_id = $honorId;
1304     $honorDAO->find();
1305
1306     $type = CRM_Contribute_PseudoConstant::financialType();
1307
1308     while ($honorDAO->fetch()) {
1309       $contributionDAO = new CRM_Contribute_DAO_Contribution();
1310       $contributionDAO->id = $honorDAO->contribution_id;
1311
1312       if ($contributionDAO->find(TRUE)) {
1313         $params[$contributionDAO->id]['honor_type'] = CRM_Core_PseudoConstant::getLabel('CRM_Contribute_BAO_ContributionSoft', 'soft_credit_type_id', $honorDAO->soft_credit_type_id);
1314         $params[$contributionDAO->id]['honorId'] = $contributionDAO->contact_id;
1315         $params[$contributionDAO->id]['display_name'] = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $contributionDAO->contact_id, 'display_name');
1316         $params[$contributionDAO->id]['type'] = $type[$contributionDAO->financial_type_id];
1317         $params[$contributionDAO->id]['type_id'] = $contributionDAO->financial_type_id;
1318         $params[$contributionDAO->id]['amount'] = CRM_Utils_Money::format($contributionDAO->total_amount, $contributionDAO->currency);
1319         $params[$contributionDAO->id]['source'] = $contributionDAO->source;
1320         $params[$contributionDAO->id]['receive_date'] = $contributionDAO->receive_date;
1321         $params[$contributionDAO->id]['contribution_status'] = CRM_Contribute_PseudoConstant::contributionStatus($contributionDAO->contribution_status_id);
1322       }
1323     }
1324
1325     return $params;
1326   }
1327
1328   /**
1329    * Get the sort name of a contact for a particular contribution.
1330    *
1331    * @param int $id
1332    *   Id of the contribution.
1333    *
1334    * @return null|string
1335    *   sort name of the contact if found
1336    */
1337   public static function sortName($id) {
1338     $id = CRM_Utils_Type::escape($id, 'Integer');
1339
1340     $query = "
1341 SELECT civicrm_contact.sort_name
1342 FROM   civicrm_contribution, civicrm_contact
1343 WHERE  civicrm_contribution.contact_id = civicrm_contact.id
1344   AND  civicrm_contribution.id = {$id}
1345 ";
1346     return CRM_Core_DAO::singleValueQuery($query);
1347   }
1348
1349   /**
1350    * Generate summary of amount received in the current fiscal year to date from the contact or contacts.
1351    *
1352    * @param int|array $contactIDs
1353    *
1354    * @return array
1355    */
1356   public static function annual($contactIDs) {
1357     if (!is_array($contactIDs)) {
1358       // In practice I can't fine any evidence that this function is ever called with
1359       // anything other than a single contact id, but left like this due to .... fear.
1360       $contactIDs = explode(',', $contactIDs);
1361     }
1362
1363     $query = self::getAnnualQuery($contactIDs);
1364     $dao = CRM_Core_DAO::executeQuery($query);
1365     $count = 0;
1366     $amount = $average = array();
1367     while ($dao->fetch()) {
1368       if ($dao->count > 0 && $dao->amount > 0) {
1369         $count += $dao->count;
1370         $amount[] = CRM_Utils_Money::format($dao->amount, $dao->currency);
1371         $average[] = CRM_Utils_Money::format($dao->average, $dao->currency);
1372       }
1373     }
1374     if ($count > 0) {
1375       return array(
1376         $count,
1377         implode(',&nbsp;', $amount),
1378         implode(',&nbsp;', $average),
1379       );
1380     }
1381     return array(0, 0, 0);
1382   }
1383
1384   /**
1385    * Check if there is a contribution with the params passed in.
1386    *
1387    * Used for trxn_id,invoice_id and contribution_id
1388    *
1389    * @param array $params
1390    *   An assoc array of name/value pairs.
1391    *
1392    * @return array
1393    *   contribution id if success else NULL
1394    */
1395   public static function checkDuplicateIds($params) {
1396     $dao = new CRM_Contribute_DAO_Contribution();
1397
1398     $clause = array();
1399     $input = array();
1400     foreach ($params as $k => $v) {
1401       if ($v) {
1402         $clause[] = "$k = '$v'";
1403       }
1404     }
1405     $clause = implode(' AND ', $clause);
1406     $query = "SELECT id FROM civicrm_contribution WHERE $clause";
1407     $dao = CRM_Core_DAO::executeQuery($query, $input);
1408
1409     while ($dao->fetch()) {
1410       $result = $dao->id;
1411       return $result;
1412     }
1413     return NULL;
1414   }
1415
1416   /**
1417    * Get the contribution details for component export.
1418    *
1419    * @param int $exportMode
1420    *   Export mode.
1421    * @param array $componentIds
1422    *   Component ids.
1423    *
1424    * @return array
1425    *   associated array
1426    */
1427   public static function getContributionDetails($exportMode, $componentIds) {
1428     $paymentDetails = array();
1429     $componentClause = ' IN ( ' . implode(',', $componentIds) . ' ) ';
1430
1431     if ($exportMode == CRM_Export_Form_Select::EVENT_EXPORT) {
1432       $componentSelect = " civicrm_participant_payment.participant_id id";
1433       $additionalClause = "
1434 INNER JOIN civicrm_participant_payment ON (civicrm_contribution.id = civicrm_participant_payment.contribution_id
1435 AND civicrm_participant_payment.participant_id {$componentClause} )
1436 ";
1437     }
1438     elseif ($exportMode == CRM_Export_Form_Select::MEMBER_EXPORT) {
1439       $componentSelect = " civicrm_membership_payment.membership_id id";
1440       $additionalClause = "
1441 INNER JOIN civicrm_membership_payment ON (civicrm_contribution.id = civicrm_membership_payment.contribution_id
1442 AND civicrm_membership_payment.membership_id {$componentClause} )
1443 ";
1444     }
1445     elseif ($exportMode == CRM_Export_Form_Select::PLEDGE_EXPORT) {
1446       $componentSelect = " civicrm_pledge_payment.id id";
1447       $additionalClause = "
1448 INNER JOIN civicrm_pledge_payment ON (civicrm_contribution.id = civicrm_pledge_payment.contribution_id
1449 AND civicrm_pledge_payment.pledge_id {$componentClause} )
1450 ";
1451     }
1452
1453     $query = " SELECT total_amount, contribution_status.name as status_id, contribution_status.label as status, payment_instrument.name as payment_instrument, receive_date,
1454                           trxn_id, {$componentSelect}
1455 FROM civicrm_contribution
1456 LEFT JOIN civicrm_option_group option_group_payment_instrument ON ( option_group_payment_instrument.name = 'payment_instrument')
1457 LEFT JOIN civicrm_option_value payment_instrument ON (civicrm_contribution.payment_instrument_id = payment_instrument.value
1458      AND option_group_payment_instrument.id = payment_instrument.option_group_id )
1459 LEFT JOIN civicrm_option_group option_group_contribution_status ON (option_group_contribution_status.name = 'contribution_status')
1460 LEFT JOIN civicrm_option_value contribution_status ON (civicrm_contribution.contribution_status_id = contribution_status.value
1461                                AND option_group_contribution_status.id = contribution_status.option_group_id )
1462 {$additionalClause}
1463 ";
1464
1465     $dao = CRM_Core_DAO::executeQuery($query);
1466
1467     while ($dao->fetch()) {
1468       $paymentDetails[$dao->id] = array(
1469         'total_amount' => $dao->total_amount,
1470         'contribution_status' => $dao->status,
1471         'receive_date' => $dao->receive_date,
1472         'pay_instru' => $dao->payment_instrument,
1473         'trxn_id' => $dao->trxn_id,
1474       );
1475     }
1476
1477     return $paymentDetails;
1478   }
1479
1480   /**
1481    * Create address associated with contribution record.
1482    *
1483    * As long as there is one or more billing field in the parameters we will create the address.
1484    *
1485    * (historically the decision to create or not was based on the payment 'type' but these lines are greyer than once
1486    * thought).
1487    *
1488    * @param array $params
1489    * @param int $billingLocationTypeID
1490    *
1491    * @return int
1492    *   address id
1493    */
1494   public static function createAddress($params, $billingLocationTypeID) {
1495     list($hasBillingField, $addressParams) = self::getBillingAddressParams($params, $billingLocationTypeID);
1496     if ($hasBillingField) {
1497       $address = CRM_Core_BAO_Address::add($addressParams, FALSE);
1498       return $address->id;
1499     }
1500     return NULL;
1501
1502   }
1503
1504   /**
1505    * Delete billing address record related contribution.
1506    *
1507    * @param int $contributionId
1508    * @param int $contactId
1509    */
1510   public static function deleteAddress($contributionId = NULL, $contactId = NULL) {
1511     $clauses = array();
1512     $contactJoin = NULL;
1513
1514     if ($contributionId) {
1515       $clauses[] = "cc.id = {$contributionId}";
1516     }
1517
1518     if ($contactId) {
1519       $clauses[] = "cco.id = {$contactId}";
1520       $contactJoin = "INNER JOIN civicrm_contact cco ON cc.contact_id = cco.id";
1521     }
1522
1523     if (empty($clauses)) {
1524       CRM_Core_Error::fatal();
1525     }
1526
1527     $condition = implode(' OR ', $clauses);
1528
1529     $query = "
1530 SELECT     ca.id
1531 FROM       civicrm_address ca
1532 INNER JOIN civicrm_contribution cc ON cc.address_id = ca.id
1533            $contactJoin
1534 WHERE      $condition
1535 ";
1536     $dao = CRM_Core_DAO::executeQuery($query);
1537
1538     while ($dao->fetch()) {
1539       $params = array('id' => $dao->id);
1540       CRM_Core_BAO_Block::blockDelete('Address', $params);
1541     }
1542   }
1543
1544   /**
1545    * This function check online pending contribution associated w/
1546    * Online Event Registration or Online Membership signup.
1547    *
1548    * @param int $componentId
1549    *   Participant/membership id.
1550    * @param string $componentName
1551    *   Event/Membership.
1552    *
1553    * @return int
1554    *   pending contribution id.
1555    */
1556   public static function checkOnlinePendingContribution($componentId, $componentName) {
1557     $contributionId = NULL;
1558     if (!$componentId ||
1559       !in_array($componentName, array('Event', 'Membership'))
1560     ) {
1561       return $contributionId;
1562     }
1563
1564     if ($componentName == 'Event') {
1565       $idName = 'participant_id';
1566       $componentTable = 'civicrm_participant';
1567       $paymentTable = 'civicrm_participant_payment';
1568       $source = ts('Online Event Registration');
1569     }
1570
1571     if ($componentName == 'Membership') {
1572       $idName = 'membership_id';
1573       $componentTable = 'civicrm_membership';
1574       $paymentTable = 'civicrm_membership_payment';
1575       $source = ts('Online Contribution');
1576     }
1577
1578     $pendingStatusId = array_search('Pending', CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name'));
1579
1580     $query = "
1581    SELECT  component.id as {$idName},
1582            componentPayment.contribution_id as contribution_id,
1583            contribution.source source,
1584            contribution.contribution_status_id as contribution_status_id,
1585            contribution.is_pay_later as is_pay_later
1586      FROM  $componentTable component
1587 LEFT JOIN  $paymentTable componentPayment    ON ( componentPayment.{$idName} = component.id )
1588 LEFT JOIN  civicrm_contribution contribution ON ( componentPayment.contribution_id = contribution.id )
1589     WHERE  component.id = {$componentId}";
1590
1591     $dao = CRM_Core_DAO::executeQuery($query);
1592
1593     while ($dao->fetch()) {
1594       if ($dao->contribution_id &&
1595         $dao->is_pay_later &&
1596         $dao->contribution_status_id == $pendingStatusId &&
1597         strpos($dao->source, $source) !== FALSE
1598       ) {
1599         $contributionId = $dao->contribution_id;
1600         $dao->free();
1601       }
1602     }
1603
1604     return $contributionId;
1605   }
1606
1607   /**
1608    * Update contribution as well as related objects.
1609    *
1610    * This function by-passes hooks - to address this - don't use this function.
1611    *
1612    * @deprecated
1613    *
1614    * Use api contribute.completetransaction
1615    * For failures use failPayment (preferably exposing by api in the process).
1616    *
1617    * @param array $params
1618    * @param bool $processContributionObject
1619    *
1620    * @return array
1621    * @throws \Exception
1622    */
1623   public static function transitionComponents($params, $processContributionObject = FALSE) {
1624     // get minimum required values.
1625     $contactId = CRM_Utils_Array::value('contact_id', $params);
1626     $componentId = CRM_Utils_Array::value('component_id', $params);
1627     $componentName = CRM_Utils_Array::value('componentName', $params);
1628     $contributionId = CRM_Utils_Array::value('contribution_id', $params);
1629     $contributionStatusId = CRM_Utils_Array::value('contribution_status_id', $params);
1630
1631     // if we already processed contribution object pass previous status id.
1632     $previousContriStatusId = CRM_Utils_Array::value('previous_contribution_status_id', $params);
1633
1634     $updateResult = array();
1635
1636     $contributionStatuses = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');
1637
1638     // we process only ( Completed, Cancelled, or Failed ) contributions.
1639     if (!$contributionId ||
1640       !in_array($contributionStatusId, array(
1641         array_search('Completed', $contributionStatuses),
1642         array_search('Cancelled', $contributionStatuses),
1643         array_search('Failed', $contributionStatuses),
1644       ))
1645     ) {
1646       return $updateResult;
1647     }
1648
1649     if (!$componentName || !$componentId) {
1650       // get the related component details.
1651       $componentDetails = self::getComponentDetails($contributionId);
1652     }
1653     else {
1654       $componentDetails['contact_id'] = $contactId;
1655       $componentDetails['component'] = $componentName;
1656
1657       if ($componentName == 'event') {
1658         $componentDetails['participant'] = $componentId;
1659       }
1660       else {
1661         $componentDetails['membership'] = $componentId;
1662       }
1663     }
1664
1665     if (!empty($componentDetails['contact_id'])) {
1666       $componentDetails['contact_id'] = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_Contribution',
1667         $contributionId,
1668         'contact_id'
1669       );
1670     }
1671
1672     // do check for required ids.
1673     if (empty($componentDetails['membership']) && empty($componentDetails['participant']) && empty($componentDetails['pledge_payment']) || empty($componentDetails['contact_id'])) {
1674       return $updateResult;
1675     }
1676
1677     //now we are ready w/ required ids, start processing.
1678
1679     $baseIPN = new CRM_Core_Payment_BaseIPN();
1680
1681     $input = $ids = $objects = array();
1682
1683     $input['component'] = CRM_Utils_Array::value('component', $componentDetails);
1684     $ids['contribution'] = $contributionId;
1685     $ids['contact'] = CRM_Utils_Array::value('contact_id', $componentDetails);
1686     $ids['membership'] = CRM_Utils_Array::value('membership', $componentDetails);
1687     $ids['participant'] = CRM_Utils_Array::value('participant', $componentDetails);
1688     $ids['event'] = CRM_Utils_Array::value('event', $componentDetails);
1689     $ids['pledge_payment'] = CRM_Utils_Array::value('pledge_payment', $componentDetails);
1690     $ids['contributionRecur'] = NULL;
1691     $ids['contributionPage'] = NULL;
1692
1693     if (!$baseIPN->validateData($input, $ids, $objects, FALSE)) {
1694       CRM_Core_Error::fatal();
1695     }
1696
1697     $memberships = &$objects['membership'];
1698     $participant = &$objects['participant'];
1699     $pledgePayment = &$objects['pledge_payment'];
1700     $contribution = &$objects['contribution'];
1701
1702     if ($pledgePayment) {
1703       $pledgePaymentIDs = array();
1704       foreach ($pledgePayment as $key => $object) {
1705         $pledgePaymentIDs[] = $object->id;
1706       }
1707       $pledgeID = $pledgePayment[0]->pledge_id;
1708     }
1709
1710     $membershipStatuses = CRM_Member_PseudoConstant::membershipStatus();
1711
1712     if ($participant) {
1713       $participantStatuses = CRM_Event_PseudoConstant::participantStatus();
1714       $oldStatus = CRM_Core_DAO::getFieldValue('CRM_Event_DAO_Participant',
1715         $participant->id,
1716         'status_id'
1717       );
1718     }
1719     // we might want to process contribution object.
1720     $processContribution = FALSE;
1721     if ($contributionStatusId == array_search('Cancelled', $contributionStatuses)) {
1722       if (is_array($memberships)) {
1723         foreach ($memberships as $membership) {
1724           $update = TRUE;
1725           //Update Membership status if there is no other completed contribution associated with the membership.
1726           $relatedContributions = CRM_Member_BAO_Membership::getMembershipContributionId($membership->id, TRUE);
1727           foreach ($relatedContributions as $contriId) {
1728             if ($contriId == $contributionId) {
1729               continue;
1730             }
1731             $statusId = CRM_Core_DAO::getFieldValue('CRM_Contribute_BAO_Contribution', $contriId, 'contribution_status_id');
1732             if (CRM_Core_PseudoConstant::getName('CRM_Contribute_BAO_Contribution', 'contribution_status_id', $statusId) === 'Completed') {
1733               $update = FALSE;
1734             }
1735           }
1736           if ($membership && $update) {
1737             $newStatus = array_search('Cancelled', $membershipStatuses);
1738
1739             // Create activity
1740             $allStatus = CRM_Member_BAO_Membership::buildOptions('status_id', 'get');
1741             $activityParam = array(
1742               'subject' => "Status changed from {$allStatus[$membership->status_id]} to {$allStatus[$newStatus]}",
1743               'source_contact_id' => CRM_Core_Session::singleton()->get('userID'),
1744               'target_contact_id' => $membership->contact_id,
1745               'source_record_id' => $membership->id,
1746               'activity_type_id' => 'Change Membership Status',
1747               'status_id' => 'Completed',
1748               'priority_id' => 'Normal',
1749               'activity_date_time' => 'now',
1750             );
1751
1752             $membership->status_id = $newStatus;
1753             $membership->is_override = TRUE;
1754             $membership->status_override_end_date = 'null';
1755             $membership->save();
1756             civicrm_api3('activity', 'create', $activityParam);
1757
1758             $updateResult['updatedComponents']['CiviMember'] = $membership->status_id;
1759             if ($processContributionObject) {
1760               $processContribution = TRUE;
1761             }
1762           }
1763         }
1764       }
1765
1766       if ($participant) {
1767         $updatedStatusId = array_search('Cancelled', $participantStatuses);
1768         CRM_Event_BAO_Participant::updateParticipantStatus($participant->id, $oldStatus, $updatedStatusId, TRUE);
1769
1770         $updateResult['updatedComponents']['CiviEvent'] = $updatedStatusId;
1771         if ($processContributionObject) {
1772           $processContribution = TRUE;
1773         }
1774       }
1775
1776       if ($pledgePayment) {
1777         CRM_Pledge_BAO_PledgePayment::updatePledgePaymentStatus($pledgeID, $pledgePaymentIDs, $contributionStatusId);
1778
1779         $updateResult['updatedComponents']['CiviPledge'] = $contributionStatusId;
1780         if ($processContributionObject) {
1781           $processContribution = TRUE;
1782         }
1783       }
1784     }
1785     elseif ($contributionStatusId == array_search('Failed', $contributionStatuses)) {
1786       if (is_array($memberships)) {
1787         foreach ($memberships as $membership) {
1788           $update = TRUE;
1789           //Update Membership status if there is no other completed contribution associated with the membership.
1790           $relatedContributions = CRM_Member_BAO_Membership::getMembershipContributionId($membership->id, TRUE);
1791           foreach ($relatedContributions as $contriId) {
1792             if ($contriId == $contributionId) {
1793               continue;
1794             }
1795             $statusId = CRM_Core_DAO::getFieldValue('CRM_Contribute_BAO_Contribution', $contriId, 'contribution_status_id');
1796             if (CRM_Core_PseudoConstant::getName('CRM_Contribute_BAO_Contribution', 'contribution_status_id', $statusId) === 'Completed') {
1797               $update = FALSE;
1798             }
1799           }
1800           if ($membership && $update) {
1801             $membership->status_id = array_search('Expired', $membershipStatuses);
1802             $membership->is_override = TRUE;
1803             $membership->status_override_end_date = 'null';
1804             $membership->save();
1805
1806             $updateResult['updatedComponents']['CiviMember'] = $membership->status_id;
1807             if ($processContributionObject) {
1808               $processContribution = TRUE;
1809             }
1810           }
1811         }
1812       }
1813       if ($participant) {
1814         $updatedStatusId = array_search('Cancelled', $participantStatuses);
1815         CRM_Event_BAO_Participant::updateParticipantStatus($participant->id, $oldStatus, $updatedStatusId, TRUE);
1816
1817         $updateResult['updatedComponents']['CiviEvent'] = $updatedStatusId;
1818         if ($processContributionObject) {
1819           $processContribution = TRUE;
1820         }
1821       }
1822
1823       if ($pledgePayment) {
1824         CRM_Pledge_BAO_PledgePayment::updatePledgePaymentStatus($pledgeID, $pledgePaymentIDs, $contributionStatusId);
1825
1826         $updateResult['updatedComponents']['CiviPledge'] = $contributionStatusId;
1827         if ($processContributionObject) {
1828           $processContribution = TRUE;
1829         }
1830       }
1831     }
1832     elseif ($contributionStatusId == array_search('Completed', $contributionStatuses)) {
1833
1834       // only pending contribution related object processed.
1835       if ($previousContriStatusId &&
1836         !in_array($contributionStatuses[$previousContriStatusId], array('Pending', 'Partially paid'))
1837       ) {
1838         // this is case when we already processed contribution object.
1839         return $updateResult;
1840       }
1841       elseif (!$previousContriStatusId &&
1842         !in_array($contributionStatuses[$contribution->contribution_status_id], array('Pending', 'Partially paid'))
1843       ) {
1844         // this is case when we are going to process contribution object later.
1845         return $updateResult;
1846       }
1847
1848       if (is_array($memberships)) {
1849         foreach ($memberships as $membership) {
1850           if ($membership) {
1851             $format = '%Y%m%d';
1852
1853             //CRM-4523
1854             $currentMembership = CRM_Member_BAO_Membership::getContactMembership($membership->contact_id,
1855               $membership->membership_type_id,
1856               $membership->is_test, $membership->id
1857             );
1858
1859             // CRM-8141 update the membership type with the value recorded in log when membership created/renewed
1860             // this picks up membership type changes during renewals
1861             $sql = "
1862               SELECT    membership_type_id
1863               FROM      civicrm_membership_log
1864               WHERE     membership_id=$membership->id
1865               ORDER BY  id DESC
1866               LIMIT     1;";
1867             $dao = new CRM_Core_DAO();
1868             $dao->query($sql);
1869             if ($dao->fetch()) {
1870               if (!empty($dao->membership_type_id)) {
1871                 $membership->membership_type_id = $dao->membership_type_id;
1872                 $membership->save();
1873               }
1874             }
1875             // else fall back to using current membership type
1876             $dao->free();
1877
1878             // Figure out number of terms
1879             $numterms = 1;
1880             $lineitems = CRM_Price_BAO_LineItem::getLineItemsByContributionID($contributionId);
1881             foreach ($lineitems as $lineitem) {
1882               if ($membership->membership_type_id == CRM_Utils_Array::value('membership_type_id', $lineitem)) {
1883                 $numterms = CRM_Utils_Array::value('membership_num_terms', $lineitem);
1884
1885                 // in case membership_num_terms comes through as null or zero
1886                 $numterms = $numterms >= 1 ? $numterms : 1;
1887                 break;
1888               }
1889             }
1890
1891             // CRM-15735-to update the membership status as per the contribution receive date
1892             $joinDate = NULL;
1893             $oldStatus = $membership->status_id;
1894             if (!empty($params['receive_date'])) {
1895               $joinDate = $params['receive_date'];
1896               $status = CRM_Member_BAO_MembershipStatus::getMembershipStatusByDate($membership->start_date,
1897                 $membership->end_date,
1898                 $membership->join_date,
1899                 $params['receive_date'],
1900                 FALSE,
1901                 $membership->membership_type_id,
1902                 (array) $membership
1903               );
1904               $membership->status_id = CRM_Utils_Array::value('id', $status, $membership->status_id);
1905               $membership->save();
1906             }
1907
1908             if ($currentMembership) {
1909               CRM_Member_BAO_Membership::fixMembershipStatusBeforeRenew($currentMembership, NULL);
1910               $dates = CRM_Member_BAO_MembershipType::getRenewalDatesForMembershipType($membership->id, NULL, NULL, $numterms);
1911               $dates['join_date'] = CRM_Utils_Date::customFormat($currentMembership['join_date'], $format);
1912             }
1913             else {
1914               $dates = CRM_Member_BAO_MembershipType::getDatesForMembershipType($membership->membership_type_id, $joinDate, NULL, NULL, $numterms);
1915             }
1916
1917             //get the status for membership.
1918             $calcStatus = CRM_Member_BAO_MembershipStatus::getMembershipStatusByDate($dates['start_date'],
1919               $dates['end_date'],
1920               $dates['join_date'],
1921               'today',
1922               TRUE,
1923               $membership->membership_type_id,
1924               (array) $membership
1925             );
1926
1927             $formattedParams = array(
1928               'status_id' => CRM_Utils_Array::value('id', $calcStatus,
1929                 array_search('Current', $membershipStatuses)
1930               ),
1931               'join_date' => CRM_Utils_Date::customFormat($dates['join_date'], $format),
1932               'start_date' => CRM_Utils_Date::customFormat($dates['start_date'], $format),
1933               'end_date' => CRM_Utils_Date::customFormat($dates['end_date'], $format),
1934             );
1935
1936             CRM_Utils_Hook::pre('edit', 'Membership', $membership->id, $formattedParams);
1937
1938             $membership->copyValues($formattedParams);
1939             $membership->save();
1940
1941             //updating the membership log
1942             $membershipLog = array();
1943             $membershipLog = $formattedParams;
1944             $logStartDate = CRM_Utils_Date::customFormat(CRM_Utils_Array::value('log_start_date', $dates), $format);
1945             $logStartDate = ($logStartDate) ? CRM_Utils_Date::isoToMysql($logStartDate) : $formattedParams['start_date'];
1946
1947             $membershipLog['start_date'] = $logStartDate;
1948             $membershipLog['membership_id'] = $membership->id;
1949             $membershipLog['modified_id'] = $membership->contact_id;
1950             $membershipLog['modified_date'] = date('Ymd');
1951             $membershipLog['membership_type_id'] = $membership->membership_type_id;
1952
1953             CRM_Member_BAO_MembershipLog::add($membershipLog);
1954
1955             //update related Memberships.
1956             CRM_Member_BAO_Membership::updateRelatedMemberships($membership->id, $formattedParams);
1957
1958             foreach (array('Membership Signup', 'Membership Renewal') as $activityType) {
1959               $scheduledActivityID = CRM_Utils_Array::value('id',
1960                 civicrm_api3('Activity', 'Get',
1961                   array(
1962                     'source_record_id' => $membership->id,
1963                     'activity_type_id' => $activityType,
1964                     'status_id' => 'Scheduled',
1965                     'options' => array(
1966                       'limit' => 1,
1967                       'sort' => 'id DESC',
1968                     ),
1969                   )
1970                 )
1971               );
1972               // 1. Update Schedule Membership Signup/Renewal activity to completed on successful payment of pending membership
1973               // 2. OR Create renewal activity scheduled if its membership renewal will be paid later
1974               if ($scheduledActivityID) {
1975                 CRM_Activity_BAO_Activity::addActivity($membership, $activityType, $membership->contact_id, array('id' => $scheduledActivityID));
1976                 break;
1977               }
1978             }
1979
1980             // track membership status change if any
1981             if (!empty($oldStatus) && $membership->status_id != $oldStatus) {
1982               $allStatus = CRM_Member_BAO_Membership::buildOptions('status_id', 'get');
1983               CRM_Activity_BAO_Activity::addActivity($membership,
1984                 'Change Membership Status',
1985                 NULL,
1986                 array(
1987                   'subject' => "Status changed from {$allStatus[$oldStatus]} to {$allStatus[$membership->status_id]}",
1988                   'source_contact_id' => $membershipLog['modified_id'],
1989                   'priority_id' => 'Normal',
1990                 )
1991               );
1992             }
1993
1994             $updateResult['membership_end_date'] = CRM_Utils_Date::customFormat($dates['end_date'],
1995               '%B %E%f, %Y'
1996             );
1997             $updateResult['updatedComponents']['CiviMember'] = $membership->status_id;
1998             if ($processContributionObject) {
1999               $processContribution = TRUE;
2000             }
2001
2002             CRM_Utils_Hook::post('edit', 'Membership', $membership->id, $membership);
2003           }
2004         }
2005       }
2006
2007       if ($participant) {
2008         $updatedStatusId = array_search('Registered', $participantStatuses);
2009         CRM_Event_BAO_Participant::updateParticipantStatus($participant->id, $oldStatus, $updatedStatusId, TRUE);
2010
2011         $updateResult['updatedComponents']['CiviEvent'] = $updatedStatusId;
2012         if ($processContributionObject) {
2013           $processContribution = TRUE;
2014         }
2015       }
2016
2017       if ($pledgePayment) {
2018         CRM_Pledge_BAO_PledgePayment::updatePledgePaymentStatus($pledgeID, $pledgePaymentIDs, $contributionStatusId);
2019
2020         $updateResult['updatedComponents']['CiviPledge'] = $contributionStatusId;
2021         if ($processContributionObject) {
2022           $processContribution = TRUE;
2023         }
2024       }
2025     }
2026
2027     // process contribution object.
2028     if ($processContribution) {
2029       $contributionParams = array();
2030       $fields = array(
2031         'contact_id',
2032         'total_amount',
2033         'receive_date',
2034         'is_test',
2035         'campaign_id',
2036         'payment_instrument_id',
2037         'trxn_id',
2038         'invoice_id',
2039         'financial_type_id',
2040         'contribution_status_id',
2041         'non_deductible_amount',
2042         'receipt_date',
2043         'check_number',
2044       );
2045       foreach ($fields as $field) {
2046         if (empty($params[$field])) {
2047           continue;
2048         }
2049         $contributionParams[$field] = $params[$field];
2050       }
2051
2052       $ids = array('contribution' => $contributionId);
2053       $contribution = CRM_Contribute_BAO_Contribution::create($contributionParams, $ids);
2054     }
2055
2056     return $updateResult;
2057   }
2058
2059   /**
2060    * Returns all contribution related object ids.
2061    *
2062    * @param $contributionId
2063    *
2064    * @return array
2065    */
2066   public static function getComponentDetails($contributionId) {
2067     $componentDetails = $pledgePayment = array();
2068     if (!$contributionId) {
2069       return $componentDetails;
2070     }
2071
2072     $query = "
2073       SELECT    c.id                 as contribution_id,
2074                 c.contact_id         as contact_id,
2075                 c.contribution_recur_id,
2076                 mp.membership_id     as membership_id,
2077                 m.membership_type_id as membership_type_id,
2078                 pp.participant_id    as participant_id,
2079                 p.event_id           as event_id,
2080                 pgp.id               as pledge_payment_id
2081       FROM      civicrm_contribution c
2082       LEFT JOIN civicrm_membership_payment  mp   ON mp.contribution_id = c.id
2083       LEFT JOIN civicrm_participant_payment pp   ON pp.contribution_id = c.id
2084       LEFT JOIN civicrm_participant         p    ON pp.participant_id  = p.id
2085       LEFT JOIN civicrm_membership          m    ON m.id  = mp.membership_id
2086       LEFT JOIN civicrm_pledge_payment      pgp  ON pgp.contribution_id  = c.id
2087       WHERE     c.id = $contributionId";
2088
2089     $dao = CRM_Core_DAO::executeQuery($query);
2090     $componentDetails = array();
2091
2092     while ($dao->fetch()) {
2093       $componentDetails['component'] = $dao->participant_id ? 'event' : 'contribute';
2094       $componentDetails['contact_id'] = $dao->contact_id;
2095       if ($dao->event_id) {
2096         $componentDetails['event'] = $dao->event_id;
2097       }
2098       if ($dao->participant_id) {
2099         $componentDetails['participant'] = $dao->participant_id;
2100       }
2101       if ($dao->membership_id) {
2102         if (!isset($componentDetails['membership'])) {
2103           $componentDetails['membership'] = $componentDetails['membership_type'] = array();
2104         }
2105         $componentDetails['membership'][] = $dao->membership_id;
2106         $componentDetails['membership_type'][] = $dao->membership_type_id;
2107       }
2108       if ($dao->pledge_payment_id) {
2109         $pledgePayment[] = $dao->pledge_payment_id;
2110       }
2111       if ($dao->contribution_recur_id) {
2112         $componentDetails['contributionRecur'] = $dao->contribution_recur_id;
2113       }
2114     }
2115
2116     if ($pledgePayment) {
2117       $componentDetails['pledge_payment'] = $pledgePayment;
2118     }
2119
2120     return $componentDetails;
2121   }
2122
2123   /**
2124    * @param int $contactId
2125    * @param bool $includeSoftCredit
2126    *
2127    * @return null|string
2128    */
2129   public static function contributionCount($contactId, $includeSoftCredit = TRUE) {
2130     if (!$contactId) {
2131       return 0;
2132     }
2133     $financialTypes = CRM_Financial_BAO_FinancialType::getAllAvailableFinancialTypes();
2134     $additionalWhere = " AND contribution.financial_type_id IN (0)";
2135     $liWhere = " AND i.financial_type_id IN (0)";
2136     if (!empty($financialTypes)) {
2137       $additionalWhere = " AND contribution.financial_type_id IN (" . implode(',', array_keys($financialTypes)) . ")";
2138       $liWhere = " AND i.financial_type_id NOT IN (" . implode(',', array_keys($financialTypes)) . ")";
2139     }
2140     $contactContributionsSQL = "
2141       SELECT contribution.id AS id
2142       FROM civicrm_contribution contribution
2143       LEFT JOIN civicrm_line_item i ON i.contribution_id = contribution.id AND i.entity_table = 'civicrm_contribution' $liWhere
2144       WHERE contribution.is_test = 0 AND contribution.contact_id = {$contactId}
2145       $additionalWhere
2146       AND i.id IS NULL";
2147
2148     $contactSoftCreditContributionsSQL = "
2149       SELECT contribution.id
2150       FROM civicrm_contribution contribution INNER JOIN civicrm_contribution_soft softContribution
2151       ON ( contribution.id = softContribution.contribution_id )
2152       WHERE contribution.is_test = 0 AND softContribution.contact_id = {$contactId} ";
2153     $query = "SELECT count( x.id ) count FROM ( ";
2154     $query .= $contactContributionsSQL;
2155
2156     if ($includeSoftCredit) {
2157       $query .= " UNION ";
2158       $query .= $contactSoftCreditContributionsSQL;
2159     }
2160
2161     $query .= ") x";
2162
2163     return CRM_Core_DAO::singleValueQuery($query);
2164   }
2165
2166   /**
2167    * Repeat a transaction as part of a recurring series.
2168    *
2169    * Only call this via the api as it is being refactored. The intention is that the repeatTransaction function
2170    * (possibly living on the ContributionRecur BAO) would be called first to create a pending contribution with a
2171    * subsequent call to the contribution.completetransaction api.
2172    *
2173    * The completeTransaction functionality has historically been overloaded to both complete and repeat payments.
2174    *
2175    * @param CRM_Contribute_BAO_Contribution $contribution
2176    * @param array $input
2177    * @param array $contributionParams
2178    * @param int $paymentProcessorID
2179    *
2180    * @return bool
2181    * @throws CiviCRM_API3_Exception
2182    */
2183   protected static function repeatTransaction(&$contribution, &$input, $contributionParams, $paymentProcessorID) {
2184     if (!empty($contribution->id)) {
2185       return FALSE;
2186     }
2187     if (empty($contribution->id)) {
2188       // Unclear why this would only be set for repeats.
2189       if (!empty($input['amount'])) {
2190         $contribution->total_amount = $contributionParams['total_amount'] = $input['amount'];
2191       }
2192
2193       if (!empty($contributionParams['contribution_recur_id'])) {
2194         $recurringContribution = civicrm_api3('ContributionRecur', 'getsingle', array(
2195           'id' => $contributionParams['contribution_recur_id'],
2196         ));
2197         if (!empty($recurringContribution['campaign_id'])) {
2198           // CRM-17718 the campaign id on the contribution recur record should get precedence.
2199           $contributionParams['campaign_id'] = $recurringContribution['campaign_id'];
2200         }
2201         if (!empty($recurringContribution['financial_type_id'])) {
2202           // CRM-17718 the campaign id on the contribution recur record should get precedence.
2203           $contributionParams['financial_type_id'] = $recurringContribution['financial_type_id'];
2204         }
2205       }
2206       $templateContribution = CRM_Contribute_BAO_ContributionRecur::getTemplateContribution(
2207         $contributionParams['contribution_recur_id'],
2208         array_intersect_key($contributionParams, array('total_amount' => TRUE, 'financial_type_id' => TRUE))
2209       );
2210       $input['line_item'] = $contributionParams['line_item'] = $templateContribution['line_item'];
2211
2212       $contributionParams['status_id'] = 'Pending';
2213       if (isset($contributionParams['financial_type_id'])) {
2214         // Give precedence to passed in type.
2215         $contribution->financial_type_id = $contributionParams['financial_type_id'];
2216       }
2217       else {
2218         $contributionParams['financial_type_id'] = $templateContribution['financial_type_id'];
2219       }
2220       $contributionParams['contact_id'] = $templateContribution['contact_id'];
2221       $contributionParams['source'] = empty($templateContribution['source']) ? ts('Recurring contribution') : $templateContribution['source'];
2222
2223       //CRM-18805 -- Contribution page not recorded on recurring transactions, Recurring contribution payments
2224       //do not create CC or BCC emails or profile notifications.
2225       //The if is just to be safe. Not sure if we can ever arrive with this unset
2226       // but per CRM-19478 it seems it can be 'null'
2227       if (isset($contribution->contribution_page_id) && is_numeric($contribution->contribution_page_id)) {
2228         $contributionParams['contribution_page_id'] = $contribution->contribution_page_id;
2229       }
2230
2231       $createContribution = civicrm_api3('Contribution', 'create', $contributionParams);
2232       $contribution->id = $createContribution['id'];
2233       CRM_Contribute_BAO_ContributionRecur::copyCustomValues($contributionParams['contribution_recur_id'], $contribution->id);
2234       return TRUE;
2235     }
2236   }
2237
2238   /**
2239    * Get individual id for onbehalf contribution.
2240    *
2241    * @param int $contributionId
2242    *   Contribution id.
2243    * @param int $contributorId
2244    *   Contributor id.
2245    *
2246    * @return array
2247    *   containing organization id and individual id
2248    */
2249   public static function getOnbehalfIds($contributionId, $contributorId = NULL) {
2250
2251     $ids = array();
2252
2253     if (!$contributionId) {
2254       return $ids;
2255     }
2256
2257     // fetch contributor id if null
2258     if (!$contributorId) {
2259       $contributorId = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_Contribution',
2260         $contributionId, 'contact_id'
2261       );
2262     }
2263
2264     $activityTypeIds = CRM_Core_PseudoConstant::activityType(TRUE, FALSE, FALSE, 'name');
2265     $activityTypeId = array_search('Contribution', $activityTypeIds);
2266
2267     if ($activityTypeId && $contributorId) {
2268       $activityQuery = "
2269 SELECT     civicrm_activity_contact.contact_id
2270   FROM     civicrm_activity_contact
2271 INNER JOIN civicrm_activity ON civicrm_activity_contact.activity_id = civicrm_activity.id
2272  WHERE     civicrm_activity.activity_type_id   = %1
2273    AND     civicrm_activity.source_record_id   = %2
2274    AND     civicrm_activity_contact.record_type_id = %3
2275 ";
2276
2277       $activityContacts = CRM_Activity_BAO_ActivityContact::buildOptions('record_type_id', 'validate');
2278       $sourceID = CRM_Utils_Array::key('Activity Source', $activityContacts);
2279
2280       $params = array(
2281         1 => array($activityTypeId, 'Integer'),
2282         2 => array($contributionId, 'Integer'),
2283         3 => array($sourceID, 'Integer'),
2284       );
2285
2286       $sourceContactId = CRM_Core_DAO::singleValueQuery($activityQuery, $params);
2287
2288       // for on behalf contribution source is individual and contributor is organization
2289       if ($sourceContactId && $sourceContactId != $contributorId) {
2290         $relationshipTypeIds = CRM_Core_PseudoConstant::relationshipType('name');
2291         // get rel type id for employee of relation
2292         foreach ($relationshipTypeIds as $id => $typeVals) {
2293           if ($typeVals['name_a_b'] == 'Employee of') {
2294             $relationshipTypeId = $id;
2295             break;
2296           }
2297         }
2298
2299         $rel = new CRM_Contact_DAO_Relationship();
2300         $rel->relationship_type_id = $relationshipTypeId;
2301         $rel->contact_id_a = $sourceContactId;
2302         $rel->contact_id_b = $contributorId;
2303         if ($rel->find(TRUE)) {
2304           $ids['individual_id'] = $rel->contact_id_a;
2305           $ids['organization_id'] = $rel->contact_id_b;
2306         }
2307       }
2308     }
2309
2310     return $ids;
2311   }
2312
2313   /**
2314    * @return array
2315    */
2316   public static function getContributionDates() {
2317     $config = CRM_Core_Config::singleton();
2318     $currentMonth = date('m');
2319     $currentDay = date('d');
2320     if ((int ) $config->fiscalYearStart['M'] > $currentMonth ||
2321       ((int ) $config->fiscalYearStart['M'] == $currentMonth &&
2322         (int ) $config->fiscalYearStart['d'] > $currentDay
2323       )
2324     ) {
2325       $year = date('Y') - 1;
2326     }
2327     else {
2328       $year = date('Y');
2329     }
2330     $year = array('Y' => $year);
2331     $yearDate = $config->fiscalYearStart;
2332     $yearDate = array_merge($year, $yearDate);
2333     $yearDate = CRM_Utils_Date::format($yearDate);
2334
2335     $monthDate = date('Ym') . '01';
2336
2337     $now = date('Ymd');
2338
2339     return array(
2340       'now' => $now,
2341       'yearDate' => $yearDate,
2342       'monthDate' => $monthDate,
2343     );
2344   }
2345
2346   /**
2347    * Load objects relations to contribution object.
2348    * Objects are stored in the $_relatedObjects property
2349    * In the first instance we are just moving functionality from BASEIpn -
2350    * @see http://issues.civicrm.org/jira/browse/CRM-9996
2351    *
2352    * Note that the unit test for the BaseIPN class tests this function
2353    *
2354    * @param array $input
2355    *   Input as delivered from Payment Processor.
2356    * @param array $ids
2357    *   Ids as Loaded by Payment Processor.
2358    * @param bool $loadAll
2359    *   Load all related objects - even where id not passed in? (allows API to call this).
2360    *
2361    * @return bool
2362    * @throws Exception
2363    */
2364   public function loadRelatedObjects(&$input, &$ids, $loadAll = FALSE) {
2365     if ($loadAll) {
2366       $ids = array_merge($this->getComponentDetails($this->id), $ids);
2367       if (empty($ids['contact']) && isset($this->contact_id)) {
2368         $ids['contact'] = $this->contact_id;
2369       }
2370     }
2371     if (empty($this->_component)) {
2372       if (!empty($ids['event'])) {
2373         $this->_component = 'event';
2374       }
2375       else {
2376         $this->_component = strtolower(CRM_Utils_Array::value('component', $input, 'contribute'));
2377       }
2378     }
2379
2380     // If the object is not fully populated then make sure it is - this is a more about legacy paths & cautious
2381     // refactoring than anything else, and has unit test coverage.
2382     if (empty($this->financial_type_id)) {
2383       $this->find(TRUE);
2384     }
2385
2386     $paymentProcessorID = CRM_Utils_Array::value('payment_processor_id', $input, CRM_Utils_Array::value(
2387       'paymentProcessor',
2388       $ids
2389     ));
2390
2391     if (!isset($input['payment_processor_id']) && !$paymentProcessorID && $this->contribution_page_id) {
2392       $paymentProcessorID = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_ContributionPage',
2393         $this->contribution_page_id,
2394         'payment_processor'
2395       );
2396       if ($paymentProcessorID) {
2397         $intentionalEnotice = $CRM16923AnUnreliableMethodHasBeenUserToDeterminePaymentProcessorFromContributionPage;
2398       }
2399     }
2400
2401     $ids['contributionType'] = $this->financial_type_id;
2402     $ids['financialType'] = $this->financial_type_id;
2403     if ($this->contribution_page_id) {
2404       $ids['contributionPage'] = $this->contribution_page_id;
2405     }
2406
2407     $this->loadRelatedEntitiesByID($ids);
2408
2409     if (!empty($ids['contributionRecur']) && !$paymentProcessorID) {
2410       $paymentProcessorID = $this->_relatedObjects['contributionRecur']->payment_processor_id;
2411     }
2412
2413     if (!empty($ids['pledge_payment'])) {
2414       foreach ($ids['pledge_payment'] as $key => $paymentID) {
2415         if (empty($paymentID)) {
2416           continue;
2417         }
2418         $payment = new CRM_Pledge_BAO_PledgePayment();
2419         $payment->id = $paymentID;
2420         if (!$payment->find(TRUE)) {
2421           throw new Exception("Could not find pledge payment record: " . $paymentID);
2422         }
2423         $this->_relatedObjects['pledge_payment'][] = $payment;
2424       }
2425     }
2426
2427     $ids = $this->loadRelatedMembershipObjects($ids);
2428
2429     if ($this->_component != 'contribute') {
2430       // we are in event mode
2431       // make sure event exists and is valid
2432       $event = new CRM_Event_BAO_Event();
2433       $event->id = $ids['event'];
2434       if ($ids['event'] &&
2435         !$event->find(TRUE)
2436       ) {
2437         throw new Exception("Could not find event: " . $ids['event']);
2438       }
2439
2440       $this->_relatedObjects['event'] = &$event;
2441
2442       $participant = new CRM_Event_BAO_Participant();
2443       $participant->id = $ids['participant'];
2444       if ($ids['participant'] &&
2445         !$participant->find(TRUE)
2446       ) {
2447         throw new Exception("Could not find participant: " . $ids['participant']);
2448       }
2449       $participant->register_date = CRM_Utils_Date::isoToMysql($participant->register_date);
2450
2451       $this->_relatedObjects['participant'] = &$participant;
2452
2453       // get the payment processor id from event - this is inaccurate see CRM-16923
2454       // in future we should look at throwing an exception here rather than an dubious guess.
2455       if (!$paymentProcessorID) {
2456         $paymentProcessorID = $this->_relatedObjects['event']->payment_processor;
2457         if ($paymentProcessorID) {
2458           $intentionalEnotice = $CRM16923AnUnreliableMethodHasBeenUserToDeterminePaymentProcessorFromEvent;
2459         }
2460       }
2461     }
2462
2463     if ($paymentProcessorID) {
2464       $paymentProcessor = CRM_Financial_BAO_PaymentProcessor::getPayment($paymentProcessorID,
2465         $this->is_test ? 'test' : 'live'
2466       );
2467       $ids['paymentProcessor'] = $paymentProcessorID;
2468       $this->_relatedObjects['paymentProcessor'] = $paymentProcessor;
2469     }
2470
2471     // Add contribution id to $ids. CRM-20401
2472     $ids['contribution'] = $this->id;
2473     return TRUE;
2474   }
2475
2476   /**
2477    * Create array of message information - ie. return html version, txt version, to field
2478    *
2479    * @param array $input
2480    *   Incoming information.
2481    *   - is_recur - should this be treated as recurring (not sure why you wouldn't
2482    *    just check presence of recur object but maintaining legacy approach
2483    *    to be careful)
2484    * @param array $ids
2485    *   IDs of related objects.
2486    * @param array $values
2487    *   Any values that may have already been compiled by calling process.
2488    *   This is augmented by values 'gathered' by gatherMessageValues
2489    * @param bool $returnMessageText
2490    *   Distinguishes between whether to send message or return.
2491    *   message text. We are working towards this function ALWAYS returning message text & calling
2492    *   function doing emails / pdfs with it
2493    *
2494    * @return array
2495    *   messages
2496    * @throws Exception
2497    */
2498   public function composeMessageArray(&$input, &$ids, &$values, $returnMessageText = TRUE) {
2499     $this->loadRelatedObjects($input, $ids);
2500
2501     if (empty($this->_component)) {
2502       $this->_component = CRM_Utils_Array::value('component', $input);
2503     }
2504
2505     //not really sure what params might be passed in but lets merge em into values
2506     $values = array_merge($this->_gatherMessageValues($input, $values, $ids), $values);
2507     $values['is_email_receipt'] = $this->isEmailReceipt($input, $values);
2508     if (!empty($input['receipt_date'])) {
2509       $values['receipt_date'] = $input['receipt_date'];
2510     }
2511
2512     $template = $this->_assignMessageVariablesToTemplate($values, $input, $returnMessageText);
2513     //what does recur 'mean here - to do with payment processor return functionality but
2514     // what is the importance
2515     if (!empty($this->contribution_recur_id) && !empty($this->_relatedObjects['paymentProcessor'])) {
2516       $paymentObject = Civi\Payment\System::singleton()->getByProcessor($this->_relatedObjects['paymentProcessor']);
2517
2518       $entityID = $entity = NULL;
2519       if (isset($ids['contribution'])) {
2520         $entity = 'contribution';
2521         $entityID = $ids['contribution'];
2522       }
2523       if (!empty($ids['membership'])) {
2524         //not sure whether is is possible for this not to be an array - load related contacts loads an array but this code was expecting a string
2525         // the addition of the casting is in case it could get here & be a string. Added in 4.6 - maybe remove later? This AuthorizeNetIPN & PaypalIPN tests hit this
2526         // line having loaded an array
2527         $ids['membership'] = (array) $ids['membership'];
2528         $entity = 'membership';
2529         $entityID = $ids['membership'][0];
2530       }
2531
2532       $template->assign('cancelSubscriptionUrl', $paymentObject->subscriptionURL($entityID, $entity, 'cancel'));
2533       $template->assign('updateSubscriptionBillingUrl', $paymentObject->subscriptionURL($entityID, $entity, 'billing'));
2534       $template->assign('updateSubscriptionUrl', $paymentObject->subscriptionURL($entityID, $entity, 'update'));
2535
2536       if ($this->_relatedObjects['paymentProcessor']['billing_mode'] & CRM_Core_Payment::BILLING_MODE_FORM) {
2537         //direct mode showing billing block, so use directIPN for temporary
2538         $template->assign('contributeMode', 'directIPN');
2539       }
2540     }
2541     // todo remove strtolower - check consistency
2542     if (strtolower($this->_component) == 'event') {
2543       $eventParams = array('id' => $this->_relatedObjects['participant']->event_id);
2544       $values['event'] = array();
2545
2546       CRM_Event_BAO_Event::retrieve($eventParams, $values['event']);
2547
2548       //get location details
2549       $locationParams = array('entity_id' => $this->_relatedObjects['participant']->event_id, 'entity_table' => 'civicrm_event');
2550       $values['location'] = CRM_Core_BAO_Location::getValues($locationParams);
2551
2552       $ufJoinParams = array(
2553         'entity_table' => 'civicrm_event',
2554         'entity_id' => $ids['event'],
2555         'module' => 'CiviEvent',
2556       );
2557
2558       list($custom_pre_id,
2559         $custom_post_ids
2560         ) = CRM_Core_BAO_UFJoin::getUFGroupIds($ufJoinParams);
2561
2562       $values['custom_pre_id'] = $custom_pre_id;
2563       $values['custom_post_id'] = $custom_post_ids;
2564       //for tasks 'Change Participant Status' and 'Update multiple Contributions' case
2565       //and cases involving status updation through ipn
2566       // whatever that means!
2567       // total_amount appears to be the preferred input param & it is unclear why we support amount here
2568       // perhaps we should throw an e-notice if amount is set & force total_amount?
2569       if (!empty($input['amount'])) {
2570         $values['totalAmount'] = $input['amount'];
2571       }
2572       // @todo set this in is_email_receipt, based on $this->_relatedObjects.
2573       if ($values['event']['is_email_confirm']) {
2574         $values['is_email_receipt'] = 1;
2575       }
2576
2577       if (!empty($ids['contribution'])) {
2578         $values['contributionId'] = $ids['contribution'];
2579       }
2580
2581       return CRM_Event_BAO_Event::sendMail($ids['contact'], $values,
2582         $this->_relatedObjects['participant']->id, $this->is_test, $returnMessageText
2583       );
2584     }
2585     else {
2586       $values['contribution_id'] = $this->id;
2587       if (!empty($ids['related_contact'])) {
2588         $values['related_contact'] = $ids['related_contact'];
2589         if (isset($ids['onbehalf_dupe_alert'])) {
2590           $values['onbehalf_dupe_alert'] = $ids['onbehalf_dupe_alert'];
2591         }
2592         $entityBlock = array(
2593           'contact_id' => $ids['contact'],
2594           'location_type_id' => CRM_Core_DAO::getFieldValue('CRM_Core_DAO_LocationType',
2595             'Home', 'id', 'name'
2596           ),
2597         );
2598         $address = CRM_Core_BAO_Address::getValues($entityBlock);
2599         $template->assign('onBehalfAddress', $address[$entityBlock['location_type_id']]['display']);
2600       }
2601       $isTest = FALSE;
2602       if ($this->is_test) {
2603         $isTest = TRUE;
2604       }
2605       if (!empty($this->_relatedObjects['membership'])) {
2606         foreach ($this->_relatedObjects['membership'] as $membership) {
2607           if ($membership->id) {
2608             $values['membership_id'] = $membership->id;
2609             $values['isMembership'] = TRUE;
2610             $values['membership_assign'] = TRUE;
2611
2612             // need to set the membership values here
2613             $template->assign('membership_name',
2614               CRM_Member_PseudoConstant::membershipType($membership->membership_type_id)
2615             );
2616             $template->assign('mem_start_date', $membership->start_date);
2617             $template->assign('mem_join_date', $membership->join_date);
2618             $template->assign('mem_end_date', $membership->end_date);
2619             $membership_status = CRM_Member_PseudoConstant::membershipStatus($membership->status_id, NULL, 'label');
2620             $template->assign('mem_status', $membership_status);
2621             if ($membership_status == 'Pending' && $membership->is_pay_later == 1) {
2622               $values['is_pay_later'] = 1;
2623             }
2624             // Pass amount to floatval as string '0.00' is considered a
2625             // valid amount and includes Fee section in the mail.
2626             if (isset($values['amount'])) {
2627               $values['amount'] = floatval($values['amount']);
2628             }
2629
2630             if (!empty($this->contribution_recur_id) && $paymentObject) {
2631               $url = $paymentObject->subscriptionURL($membership->id, 'membership', 'cancel');
2632               $template->assign('cancelSubscriptionUrl', $url);
2633               $url = $paymentObject->subscriptionURL($membership->id, 'membership', 'billing');
2634               $template->assign('updateSubscriptionBillingUrl', $url);
2635               $url = $paymentObject->subscriptionURL($entityID, $entity, 'update');
2636               $template->assign('updateSubscriptionUrl', $url);
2637             }
2638
2639             $result = CRM_Contribute_BAO_ContributionPage::sendMail($ids['contact'], $values, $isTest, $returnMessageText);
2640
2641             return $result;
2642             // otherwise if its about sending emails, continue sending without return, as we
2643             // don't want to exit the loop.
2644           }
2645         }
2646       }
2647       else {
2648         return CRM_Contribute_BAO_ContributionPage::sendMail($ids['contact'], $values, $isTest, $returnMessageText);
2649       }
2650     }
2651   }
2652
2653   /**
2654    * Gather values for contribution mail - this function has been created
2655    * as part of CRM-9996 refactoring as a step towards simplifying the composeMessage function
2656    * Values related to the contribution in question are gathered
2657    *
2658    * @param array $input
2659    *   Input into function (probably from payment processor).
2660    * @param array $values
2661    * @param array $ids
2662    *   The set of ids related to the input.
2663    *
2664    * @return array
2665    */
2666   public function _gatherMessageValues($input, &$values, $ids = array()) {
2667     // set display address of contributor
2668     if ($this->address_id) {
2669       $addressParams = array('id' => $this->address_id);
2670       $addressDetails = CRM_Core_BAO_Address::getValues($addressParams, FALSE, 'id');
2671       $addressDetails = array_values($addressDetails);
2672     }
2673     // Else we assign the billing address of the contribution contact.
2674     else {
2675       $addressParams = array('contact_id' => $this->contact_id, 'is_billing' => 1);
2676       $addressDetails = (array) CRM_Core_BAO_Address::getValues($addressParams);
2677       $addressDetails = array_values($addressDetails);
2678     }
2679
2680     if (!empty($addressDetails[0]['display'])) {
2681       $values['address'] = $addressDetails[0]['display'];
2682     }
2683
2684     if ($this->_component == 'contribute') {
2685       //get soft contributions
2686       $softContributions = CRM_Contribute_BAO_ContributionSoft::getSoftContribution($this->id, TRUE);
2687       if (!empty($softContributions)) {
2688         $values['softContributions'] = $softContributions['soft_credit'];
2689       }
2690       if (isset($this->contribution_page_id)) {
2691         // This is a call we want to use less, in favour of loading related objects.
2692         $values = $this->addContributionPageValuesToValuesHeavyHandedly($values);
2693         if ($this->contribution_page_id) {
2694           // This is precautionary as there are some legacy flows, but it should really be
2695           // loaded by now.
2696           if (!isset($this->_relatedObjects['contributionPage'])) {
2697             $this->loadRelatedEntitiesByID(array('contributionPage' => $this->contribution_page_id));
2698           }
2699           // CRM-8254 - override default currency if applicable
2700           $config = CRM_Core_Config::singleton();
2701           $config->defaultCurrency = CRM_Utils_Array::value(
2702             'currency',
2703             $values,
2704             $config->defaultCurrency
2705           );
2706         }
2707       }
2708       // no contribution page -probably back office
2709       else {
2710         // Handle re-print receipt for offline contributions (call from PDF.php - no contribution_page_id)
2711         $values['title'] = 'Contribution';
2712       }
2713       // set lineItem for contribution
2714       if ($this->id) {
2715         $lineItems = CRM_Price_BAO_LineItem::getLineItemsByContributionID($this->id);
2716         if (!empty($lineItems)) {
2717           $firstLineItem = reset($lineItems);
2718           $priceSet = array();
2719           if (CRM_Utils_Array::value('price_set_id', $firstLineItem)) {
2720             $priceSet = civicrm_api3('PriceSet', 'getsingle', array('id' => $firstLineItem['price_set_id'], 'return' => 'is_quick_config, id'));
2721             $values['priceSetID'] = $priceSet['id'];
2722           }
2723           foreach ($lineItems as &$eachItem) {
2724             if (isset($this->_relatedObjects['membership'])
2725              && is_array($this->_relatedObjects['membership'])
2726              && array_key_exists($eachItem['membership_type_id'], $this->_relatedObjects['membership'])) {
2727               $eachItem['join_date'] = CRM_Utils_Date::customFormat($this->_relatedObjects['membership'][$eachItem['membership_type_id']]->join_date);
2728               $eachItem['start_date'] = CRM_Utils_Date::customFormat($this->_relatedObjects['membership'][$eachItem['membership_type_id']]->start_date);
2729               $eachItem['end_date'] = CRM_Utils_Date::customFormat($this->_relatedObjects['membership'][$eachItem['membership_type_id']]->end_date);
2730             }
2731             // This is actually used in conjunction with is_quick_config in the template & we should deprecate it.
2732             // However, that does create upgrade pain so would be better to be phased in.
2733             $values['useForMember'] = empty($priceSet['is_quick_config']);
2734           }
2735           $values['lineItem'][0] = $lineItems;
2736         }
2737       }
2738
2739       $relatedContact = CRM_Contribute_BAO_Contribution::getOnbehalfIds(
2740         $this->id,
2741         $this->contact_id
2742       );
2743       // if this is onbehalf of contribution then set related contact
2744       if (!empty($relatedContact['individual_id'])) {
2745         $values['related_contact'] = $ids['related_contact'] = $relatedContact['individual_id'];
2746       }
2747     }
2748     else {
2749       // event
2750       $eventParams = array(
2751         'id' => $this->_relatedObjects['event']->id,
2752       );
2753       $values['event'] = array();
2754
2755       CRM_Event_BAO_Event::retrieve($eventParams, $values['event']);
2756       // add custom fields for event
2757       $eventGroupTree = CRM_Core_BAO_CustomGroup::getTree('Event', NULL, $this->_relatedObjects['event']->id);
2758
2759       $eventCustomGroup = array();
2760       foreach ($eventGroupTree as $key => $group) {
2761         if ($key === 'info') {
2762           continue;
2763         }
2764
2765         foreach ($group['fields'] as $k => $customField) {
2766           $groupLabel = $group['title'];
2767           if (!empty($customField['customValue'])) {
2768             foreach ($customField['customValue'] as $customFieldValues) {
2769               $eventCustomGroup[$groupLabel][$customField['label']] = CRM_Utils_Array::value('data', $customFieldValues);
2770             }
2771           }
2772         }
2773       }
2774       $values['event']['customGroup'] = $eventCustomGroup;
2775
2776       //get participant details
2777       $participantParams = array(
2778         'id' => $this->_relatedObjects['participant']->id,
2779       );
2780
2781       $values['participant'] = array();
2782
2783       CRM_Event_BAO_Participant::getValues($participantParams, $values['participant'], $participantIds);
2784       // add custom fields for event
2785       $participantGroupTree = CRM_Core_BAO_CustomGroup::getTree('Participant', NULL, $this->_relatedObjects['participant']->id);
2786       $participantCustomGroup = array();
2787       foreach ($participantGroupTree as $key => $group) {
2788         if ($key === 'info') {
2789           continue;
2790         }
2791
2792         foreach ($group['fields'] as $k => $customField) {
2793           $groupLabel = $group['title'];
2794           if (!empty($customField['customValue'])) {
2795             foreach ($customField['customValue'] as $customFieldValues) {
2796               $participantCustomGroup[$groupLabel][$customField['label']] = CRM_Utils_Array::value('data', $customFieldValues);
2797             }
2798           }
2799         }
2800       }
2801       $values['participant']['customGroup'] = $participantCustomGroup;
2802
2803       //get location details
2804       $locationParams = array(
2805         'entity_id' => $this->_relatedObjects['event']->id,
2806         'entity_table' => 'civicrm_event',
2807       );
2808       $values['location'] = CRM_Core_BAO_Location::getValues($locationParams);
2809
2810       $ufJoinParams = array(
2811         'entity_table' => 'civicrm_event',
2812         'entity_id' => $ids['event'],
2813         'module' => 'CiviEvent',
2814       );
2815
2816       list($custom_pre_id,
2817         $custom_post_ids
2818         ) = CRM_Core_BAO_UFJoin::getUFGroupIds($ufJoinParams);
2819
2820       $values['custom_pre_id'] = $custom_pre_id;
2821       $values['custom_post_id'] = $custom_post_ids;
2822
2823       // set lineItem for event contribution
2824       if ($this->id) {
2825         $participantIds = CRM_Event_BAO_Participant::getParticipantIds($this->id);
2826         if (!empty($participantIds)) {
2827           foreach ($participantIds as $pIDs) {
2828             $lineItem = CRM_Price_BAO_LineItem::getLineItems($pIDs);
2829             if (!CRM_Utils_System::isNull($lineItem)) {
2830               $values['lineItem'][] = $lineItem;
2831             }
2832           }
2833         }
2834       }
2835     }
2836
2837     $groupTree = CRM_Core_BAO_CustomGroup::getTree('Contribution', NULL, $this->id);
2838
2839     $customGroup = array();
2840     foreach ($groupTree as $key => $group) {
2841       if ($key === 'info') {
2842         continue;
2843       }
2844
2845       foreach ($group['fields'] as $k => $customField) {
2846         $groupLabel = $group['title'];
2847         if (!empty($customField['customValue'])) {
2848           foreach ($customField['customValue'] as $customFieldValues) {
2849             $customGroup[$groupLabel][$customField['label']] = CRM_Utils_Array::value('data', $customFieldValues);
2850           }
2851         }
2852       }
2853     }
2854     $values['customGroup'] = $customGroup;
2855
2856     $values['is_pay_later'] = $this->is_pay_later;
2857
2858     return $values;
2859   }
2860
2861   /**
2862    * Assign message variables to template but try to break the habit.
2863    *
2864    * In order to get away from leaky variables it is better to ensure variables are set in values and assign them
2865    * from the send function. Otherwise smarty variables can leak if this is called more than once - e.g. processing
2866    * multiple recurring payments for processors like IATS that use tokens.
2867    *
2868    * Apply variables for message to smarty template - this function is part of analysing what is in the huge
2869    * function & breaking it down into manageable chunks. Eventually it will be refactored into something else
2870    * Note we send directly from this function in some cases because it is only partly refactored.
2871    *
2872    * Don't call this function directly as the signature will change.
2873    *
2874    * @param $values
2875    * @param $input
2876    * @param bool $returnMessageText
2877    *
2878    * @return mixed
2879    */
2880   public function _assignMessageVariablesToTemplate(&$values, $input, $returnMessageText = TRUE) {
2881     // @todo - this should have a better separation of concerns - ie.
2882     // gatherMessageValues should build an array of values to be assigned to the template
2883     // and this function should assign them (assigning null if not set).
2884     // the way the pcpParams & honor Params section works is a baby-step towards this.
2885     $template = CRM_Core_Smarty::singleton();
2886     $template->assign('first_name', $this->_relatedObjects['contact']->first_name);
2887     $template->assign('last_name', $this->_relatedObjects['contact']->last_name);
2888     $template->assign('displayName', $this->_relatedObjects['contact']->display_name);
2889
2890     // For some unit tests contribution cannot contain paymentProcessor information
2891     $billingMode = empty($this->_relatedObjects['paymentProcessor']) ? CRM_Core_Payment::BILLING_MODE_NOTIFY : $this->_relatedObjects['paymentProcessor']['billing_mode'];
2892     $template->assign('contributeMode', CRM_Utils_Array::value($billingMode, CRM_Core_SelectValues::contributeMode()));
2893
2894     //assign honor information to receipt message
2895     $softRecord = CRM_Contribute_BAO_ContributionSoft::getSoftContribution($this->id);
2896
2897     $honorParams = ['soft_credit_type' => NULL, 'honor_block_is_active' => NULL];
2898     if (isset($softRecord['soft_credit'])) {
2899       //if id of contribution page is present
2900       if (!empty($values['id'])) {
2901         $values['honor'] = array(
2902           'honor_profile_values' => array(),
2903           'honor_profile_id' => CRM_Core_DAO::getFieldValue('CRM_Core_DAO_UFJoin', $values['id'], 'uf_group_id', 'entity_id'),
2904           'honor_id' => $softRecord['soft_credit'][1]['contact_id'],
2905         );
2906
2907         $honorParams['soft_credit_type'] = $softRecord['soft_credit'][1]['soft_credit_type_label'];
2908         $honorParams['honor_block_is_active'] = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_UFJoin', $values['id'], 'is_active', 'entity_id');
2909       }
2910       else {
2911         //offline contribution
2912         $softCreditTypes = $softCredits = array();
2913         foreach ($softRecord['soft_credit'] as $key => $softCredit) {
2914           $softCreditTypes[$key] = $softCredit['soft_credit_type_label'];
2915           $softCredits[$key] = array(
2916             'Name' => $softCredit['contact_name'],
2917             'Amount' => CRM_Utils_Money::format($softCredit['amount'], $softCredit['currency']),
2918           );
2919         }
2920         $template->assign('softCreditTypes', $softCreditTypes);
2921         $template->assign('softCredits', $softCredits);
2922       }
2923     }
2924
2925     $dao = new CRM_Contribute_DAO_ContributionProduct();
2926     $dao->contribution_id = $this->id;
2927     if ($dao->find(TRUE)) {
2928       $premiumId = $dao->product_id;
2929       $template->assign('option', $dao->product_option);
2930
2931       $productDAO = new CRM_Contribute_DAO_Product();
2932       $productDAO->id = $premiumId;
2933       $productDAO->find(TRUE);
2934       $template->assign('selectPremium', TRUE);
2935       $template->assign('product_name', $productDAO->name);
2936       $template->assign('price', $productDAO->price);
2937       $template->assign('sku', $productDAO->sku);
2938     }
2939     $template->assign('title', CRM_Utils_Array::value('title', $values));
2940     $values['amount'] = CRM_Utils_Array::value('total_amount', $input, (CRM_Utils_Array::value('amount', $input)), NULL);
2941     if (!$values['amount'] && isset($this->total_amount)) {
2942       $values['amount'] = $this->total_amount;
2943     }
2944
2945     $pcpParams = ['pcpBlock' => NULL, 'pcp_display_in_roll' => NULL, 'pcp_roll_nickname' => NULL, 'pcp_personal_note' => NULL, 'title' => NULL];
2946
2947     if (strtolower($this->_component) == 'contribute') {
2948       //PCP Info
2949       $softDAO = new CRM_Contribute_DAO_ContributionSoft();
2950       $softDAO->contribution_id = $this->id;
2951       if ($softDAO->find(TRUE)) {
2952         $pcpParams['pcpBlock'] = TRUE;
2953         $pcpParams['pcp_display_in_roll'] = $softDAO->pcp_display_in_roll;
2954         $pcpParams['pcp_roll_nickname'] = $softDAO->pcp_roll_nickname;
2955         $pcpParams['pcp_personal_note'] = $softDAO->pcp_personal_note;
2956
2957         //assign the pcp page title for email subject
2958         $pcpDAO = new CRM_PCP_DAO_PCP();
2959         $pcpDAO->id = $softDAO->pcp_id;
2960         if ($pcpDAO->find(TRUE)) {
2961           $pcpParams['title'] = $pcpDAO->title;
2962         }
2963       }
2964     }
2965     foreach (array_merge($honorParams, $pcpParams) as $templateKey => $templateValue) {
2966       $template->assign($templateKey, $templateValue);
2967     }
2968
2969     if ($this->financial_type_id) {
2970       $values['financial_type_id'] = $this->financial_type_id;
2971     }
2972
2973     $template->assign('trxn_id', $this->trxn_id);
2974     $template->assign('receive_date',
2975       CRM_Utils_Date::processDate($this->receive_date)
2976     );
2977     $values['receipt_date'] = (empty($this->receipt_date) ? NULL : $this->receipt_date);
2978     $template->assign('action', $this->is_test ? 1024 : 1);
2979     $template->assign('receipt_text',
2980       CRM_Utils_Array::value('receipt_text',
2981         $values
2982       )
2983     );
2984     $template->assign('is_monetary', 1);
2985     $template->assign('is_recur', !empty($this->contribution_recur_id));
2986     $template->assign('currency', $this->currency);
2987     $template->assign('address', CRM_Utils_Address::format($input));
2988     if (!empty($values['customGroup'])) {
2989       $template->assign('customGroup', $values['customGroup']);
2990     }
2991     if (!empty($values['softContributions'])) {
2992       $template->assign('softContributions', $values['softContributions']);
2993     }
2994     if ($this->_component == 'event') {
2995       $template->assign('title', $values['event']['title']);
2996       $participantRoles = CRM_Event_PseudoConstant::participantRole();
2997       $viewRoles = array();
2998       foreach (explode(CRM_Core_DAO::VALUE_SEPARATOR, $this->_relatedObjects['participant']->role_id) as $k => $v) {
2999         $viewRoles[] = $participantRoles[$v];
3000       }
3001       $values['event']['participant_role'] = implode(', ', $viewRoles);
3002       $template->assign('event', $values['event']);
3003       $template->assign('participant', $values['participant']);
3004       $template->assign('location', $values['location']);
3005       $template->assign('customPre', $values['custom_pre_id']);
3006       $template->assign('customPost', $values['custom_post_id']);
3007
3008       $isTest = FALSE;
3009       if ($this->_relatedObjects['participant']->is_test) {
3010         $isTest = TRUE;
3011       }
3012
3013       $values['params'] = array();
3014       //to get email of primary participant.
3015       $primaryEmail = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_Email', $this->_relatedObjects['participant']->contact_id, 'email', 'contact_id');
3016       $primaryAmount[] = array(
3017         'label' => $this->_relatedObjects['participant']->fee_level . ' - ' . $primaryEmail,
3018         'amount' => $this->_relatedObjects['participant']->fee_amount,
3019       );
3020       //build an array of cId/pId of participants
3021       $additionalIDs = CRM_Event_BAO_Event::buildCustomProfile($this->_relatedObjects['participant']->id, NULL, $this->_relatedObjects['contact']->id, $isTest, TRUE);
3022       unset($additionalIDs[$this->_relatedObjects['participant']->id]);
3023       //send receipt to additional participant if exists
3024       if (count($additionalIDs)) {
3025         $template->assign('isPrimary', 0);
3026         $template->assign('customProfile', NULL);
3027         //set additionalParticipant true
3028         $values['params']['additionalParticipant'] = TRUE;
3029         foreach ($additionalIDs as $pId => $cId) {
3030           $amount = array();
3031           //to change the status pending to completed
3032           $additional = new CRM_Event_DAO_Participant();
3033           $additional->id = $pId;
3034           $additional->contact_id = $cId;
3035           $additional->find(TRUE);
3036           $additional->register_date = $this->_relatedObjects['participant']->register_date;
3037           $additional->status_id = 1;
3038           $additionalParticipantInfo = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_Email', $additional->contact_id, 'email', 'contact_id');
3039           //if additional participant dont have email
3040           //use display name.
3041           if (!$additionalParticipantInfo) {
3042             $additionalParticipantInfo = CRM_Contact_BAO_Contact::displayName($additional->contact_id);
3043           }
3044           $amount[0] = array('label' => $additional->fee_level, 'amount' => $additional->fee_amount);
3045           $primaryAmount[] = array(
3046             'label' => $additional->fee_level . ' - ' . $additionalParticipantInfo,
3047             'amount' => $additional->fee_amount,
3048           );
3049           $additional->save();
3050           $additional->free();
3051           $template->assign('amount', $amount);
3052           CRM_Event_BAO_Event::sendMail($cId, $values, $pId, $isTest, $returnMessageText);
3053         }
3054       }
3055
3056       //build an array of custom profile and assigning it to template
3057       $customProfile = CRM_Event_BAO_Event::buildCustomProfile($this->_relatedObjects['participant']->id, $values, NULL, $isTest);
3058
3059       if (count($customProfile)) {
3060         $template->assign('customProfile', $customProfile);
3061       }
3062
3063       // for primary contact
3064       $values['params']['additionalParticipant'] = FALSE;
3065       $template->assign('isPrimary', 1);
3066       $template->assign('amount', $primaryAmount);
3067       $template->assign('register_date', CRM_Utils_Date::isoToMysql($this->_relatedObjects['participant']->register_date));
3068       if ($this->payment_instrument_id) {
3069         $paymentInstrument = CRM_Contribute_PseudoConstant::paymentInstrument();
3070         $template->assign('paidBy', $paymentInstrument[$this->payment_instrument_id]);
3071       }
3072       // carry paylater, since we did not created billing,
3073       // so need to pull email from primary location, CRM-4395
3074       $values['params']['is_pay_later'] = $this->_relatedObjects['participant']->is_pay_later;
3075     }
3076     return $template;
3077   }
3078
3079   /**
3080    * Check whether payment processor supports
3081    * cancellation of contribution subscription
3082    *
3083    * @param int $contributionId
3084    *   Contribution id.
3085    *
3086    * @param bool $isNotCancelled
3087    *
3088    * @return bool
3089    */
3090   public static function isCancelSubscriptionSupported($contributionId, $isNotCancelled = TRUE) {
3091     $cacheKeyString = "$contributionId";
3092     $cacheKeyString .= $isNotCancelled ? '_1' : '_0';
3093
3094     static $supportsCancel = array();
3095
3096     if (!array_key_exists($cacheKeyString, $supportsCancel)) {
3097       $supportsCancel[$cacheKeyString] = FALSE;
3098       $isCancelled = FALSE;
3099
3100       if ($isNotCancelled) {
3101         $isCancelled = self::isSubscriptionCancelled($contributionId);
3102       }
3103
3104       $paymentObject = CRM_Financial_BAO_PaymentProcessor::getProcessorForEntity($contributionId, 'contribute', 'obj');
3105       if (!empty($paymentObject)) {
3106         $supportsCancel[$cacheKeyString] = $paymentObject->supports('cancelRecurring') && !$isCancelled;
3107       }
3108     }
3109     return $supportsCancel[$cacheKeyString];
3110   }
3111
3112   /**
3113    * Check whether subscription is already cancelled.
3114    *
3115    * @param int $contributionId
3116    *   Contribution id.
3117    *
3118    * @return string
3119    *   contribution status
3120    */
3121   public static function isSubscriptionCancelled($contributionId) {
3122     $sql = "
3123        SELECT cr.contribution_status_id
3124          FROM civicrm_contribution_recur cr
3125     LEFT JOIN civicrm_contribution con ON ( cr.id = con.contribution_recur_id )
3126         WHERE con.id = %1 LIMIT 1";
3127     $params = array(1 => array($contributionId, 'Integer'));
3128     $statusId = CRM_Core_DAO::singleValueQuery($sql, $params);
3129     $status = CRM_Contribute_PseudoConstant::contributionStatus($statusId);
3130     if ($status == 'Cancelled') {
3131       return TRUE;
3132     }
3133     return FALSE;
3134   }
3135
3136   /**
3137    * Create all financial accounts entry.
3138    *
3139    * @param array $params
3140    *   Contribution object, line item array and params for trxn.
3141    *
3142    *
3143    * @param array $financialTrxnValues
3144    *
3145    * @return null|\CRM_Core_BAO_FinancialTrxn
3146    */
3147   public static function recordFinancialAccounts(&$params, $financialTrxnValues = NULL) {
3148     $skipRecords = $update = $return = $isRelatedId = FALSE;
3149
3150     $additionalParticipantId = array();
3151     $contributionStatuses = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');
3152     $contributionStatus = empty($params['contribution_status_id']) ? NULL : $contributionStatuses[$params['contribution_status_id']];
3153
3154     if (CRM_Utils_Array::value('contribution_mode', $params) == 'participant') {
3155       $entityId = $params['participant_id'];
3156       $entityTable = 'civicrm_participant';
3157       $additionalParticipantId = CRM_Event_BAO_Participant::getAdditionalParticipantIds($entityId);
3158     }
3159     elseif (!empty($params['membership_id'])) {
3160       //so far $params['membership_id'] should only be set coming in from membershipBAO::create so the situation where multiple memberships
3161       // are created off one contribution should be handled elsewhere
3162       $entityId = $params['membership_id'];
3163       $entityTable = 'civicrm_membership';
3164     }
3165     else {
3166       $entityId = $params['contribution']->id;
3167       $entityTable = 'civicrm_contribution';
3168     }
3169
3170     if (CRM_Utils_Array::value('contribution_mode', $params) == 'membership') {
3171       $isRelatedId = TRUE;
3172     }
3173
3174     $entityID[] = $entityId;
3175     if (!empty($additionalParticipantId)) {
3176       $entityID += $additionalParticipantId;
3177     }
3178     // prevContribution appears to mean - original contribution object- ie copy of contribution from before the update started that is being updated
3179     if (empty($params['prevContribution'])) {
3180       $entityID = NULL;
3181     }
3182     else {
3183       $update = TRUE;
3184     }
3185
3186     $statusId = $params['contribution']->contribution_status_id;
3187     // CRM-13964 partial payment
3188     if ($contributionStatus == 'Partially paid'
3189       && !empty($params['partial_payment_total']) && !empty($params['partial_amount_to_pay'])
3190     ) {
3191       $partialAmtPay = CRM_Utils_Rule::cleanMoney($params['partial_amount_to_pay']);
3192       $partialAmtTotal = CRM_Utils_Rule::cleanMoney($params['partial_payment_total']);
3193
3194       $fromFinancialAccountId = CRM_Financial_BAO_FinancialAccount::getFinancialAccountForFinancialTypeByRelationship($params['financial_type_id'], 'Accounts Receivable Account is');
3195       $statusId = CRM_Core_PseudoConstant::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Completed');
3196       $params['total_amount'] = $partialAmtPay;
3197
3198       $balanceTrxnInfo = CRM_Core_BAO_FinancialTrxn::getBalanceTrxnAmt($params['contribution']->id, $params['financial_type_id']);
3199       if (empty($balanceTrxnInfo['trxn_id'])) {
3200         // create new balance transaction record
3201         $toFinancialAccount = CRM_Financial_BAO_FinancialAccount::getFinancialAccountForFinancialTypeByRelationship($params['financial_type_id'], 'Accounts Receivable Account is');
3202
3203         $balanceTrxnParams['total_amount'] = $partialAmtTotal;
3204         $balanceTrxnParams['to_financial_account_id'] = $toFinancialAccount;
3205         $balanceTrxnParams['contribution_id'] = $params['contribution']->id;
3206         $balanceTrxnParams['trxn_date'] = !empty($params['contribution']->receive_date) ? $params['contribution']->receive_date : date('YmdHis');
3207         $balanceTrxnParams['fee_amount'] = CRM_Utils_Array::value('fee_amount', $params);
3208         $balanceTrxnParams['net_amount'] = CRM_Utils_Array::value('net_amount', $params);
3209         $balanceTrxnParams['currency'] = $params['contribution']->currency;
3210         $balanceTrxnParams['trxn_id'] = $params['contribution']->trxn_id;
3211         $balanceTrxnParams['status_id'] = $statusId;
3212         $balanceTrxnParams['payment_instrument_id'] = $params['contribution']->payment_instrument_id;
3213         $balanceTrxnParams['check_number'] = CRM_Utils_Array::value('check_number', $params);
3214         $balanceTrxnParams['pan_truncation'] = CRM_Utils_Array::value('pan_truncation', $params);
3215         $balanceTrxnParams['card_type_id'] = CRM_Utils_Array::value('card_type_id', $params);
3216         if (!empty($balanceTrxnParams['from_financial_account_id']) &&
3217           ($statusId == array_search('Completed', $contributionStatuses) || $statusId == array_search('Partially paid', $contributionStatuses))
3218         ) {
3219           $balanceTrxnParams['is_payment'] = 1;
3220         }
3221         if (!empty($params['payment_processor'])) {
3222           $balanceTrxnParams['payment_processor_id'] = $params['payment_processor'];
3223         }
3224         $financialTxn = CRM_Core_BAO_FinancialTrxn::create($balanceTrxnParams);
3225       }
3226     }
3227
3228     // build line item array if its not set in $params
3229     if (empty($params['line_item']) || $additionalParticipantId) {
3230       CRM_Price_BAO_LineItem::getLineItemArray($params, $entityID, str_replace('civicrm_', '', $entityTable), $isRelatedId);
3231     }
3232
3233     if ($contributionStatus != 'Failed' &&
3234       !($contributionStatus == 'Pending' && !$params['contribution']->is_pay_later)
3235     ) {
3236       $skipRecords = TRUE;
3237       $pendingStatus = array(
3238         'Pending',
3239         'In Progress',
3240       );
3241       if (in_array($contributionStatus, $pendingStatus)) {
3242         $params['to_financial_account_id'] = CRM_Financial_BAO_FinancialAccount::getFinancialAccountForFinancialTypeByRelationship(
3243           $params['financial_type_id'],
3244           'Accounts Receivable Account is'
3245         );
3246       }
3247       elseif (!empty($params['payment_processor'])) {
3248         $params['to_financial_account_id'] = CRM_Contribute_PseudoConstant::getRelationalFinancialAccount($params['payment_processor'], NULL, 'civicrm_payment_processor');
3249         $params['payment_instrument_id'] = civicrm_api3('PaymentProcessor', 'getvalue', array(
3250           'id' => $params['payment_processor'],
3251           'return' => 'payment_instrument_id',
3252         ));
3253       }
3254       elseif (!empty($params['payment_instrument_id'])) {
3255         $params['to_financial_account_id'] = CRM_Financial_BAO_FinancialTypeAccount::getInstrumentFinancialAccount($params['payment_instrument_id']);
3256       }
3257       else {
3258         $relationTypeId = key(CRM_Core_PseudoConstant::accountOptionValues('financial_account_type', NULL, " AND v.name LIKE 'Asset' "));
3259         $queryParams = array(1 => array($relationTypeId, 'Integer'));
3260         $params['to_financial_account_id'] = CRM_Core_DAO::singleValueQuery("SELECT id FROM civicrm_financial_account WHERE is_default = 1 AND financial_account_type_id = %1", $queryParams);
3261       }
3262
3263       $totalAmount = CRM_Utils_Array::value('total_amount', $params);
3264       if (!isset($totalAmount) && !empty($params['prevContribution'])) {
3265         $totalAmount = $params['total_amount'] = $params['prevContribution']->total_amount;
3266       }
3267       //build financial transaction params
3268       $trxnParams = array(
3269         'contribution_id' => $params['contribution']->id,
3270         'to_financial_account_id' => $params['to_financial_account_id'],
3271         'trxn_date' => !empty($params['contribution']->receive_date) ? $params['contribution']->receive_date : date('YmdHis'),
3272         'total_amount' => $totalAmount,
3273         'fee_amount' => CRM_Utils_Array::value('fee_amount', $params),
3274         'net_amount' => CRM_Utils_Array::value('net_amount', $params, $totalAmount),
3275         'currency' => $params['contribution']->currency,
3276         'trxn_id' => $params['contribution']->trxn_id,
3277         'status_id' => $statusId,
3278         'payment_instrument_id' => CRM_Utils_Array::value('payment_instrument_id', $params, $params['contribution']->payment_instrument_id),
3279         'check_number' => CRM_Utils_Array::value('check_number', $params),
3280         'pan_truncation' => CRM_Utils_Array::value('pan_truncation', $params),
3281         'card_type_id' => CRM_Utils_Array::value('card_type_id', $params),
3282       );
3283       if ($contributionStatus == 'Refunded' || $contributionStatus == 'Chargeback' || $contributionStatus == 'Cancelled') {
3284         $trxnParams['trxn_date'] = !empty($params['contribution']->cancel_date) ? $params['contribution']->cancel_date : date('YmdHis');
3285         if (isset($params['refund_trxn_id'])) {
3286           // CRM-17751 allow a separate trxn_id for the refund to be passed in via api & form.
3287           $trxnParams['trxn_id'] = $params['refund_trxn_id'];
3288         }
3289       }
3290       //CRM-16259, set is_payment flag for non pending status
3291       if (!in_array($contributionStatus, $pendingStatus)) {
3292         $trxnParams['is_payment'] = 1;
3293       }
3294       if (!empty($params['payment_processor'])) {
3295         $trxnParams['payment_processor_id'] = $params['payment_processor'];
3296       }
3297
3298       if (isset($fromFinancialAccountId)) {
3299         $trxnParams['from_financial_account_id'] = $fromFinancialAccountId;
3300       }
3301
3302       // consider external values passed for recording transaction entry
3303       if (!empty($financialTrxnValues)) {
3304         $trxnParams = array_merge($trxnParams, $financialTrxnValues);
3305       }
3306       if (empty($trxnParams['payment_processor_id'])) {
3307         unset($trxnParams['payment_processor_id']);
3308       }
3309
3310       $params['trxnParams'] = $trxnParams;
3311
3312       if (!empty($params['prevContribution'])) {
3313         $updated = FALSE;
3314         $params['trxnParams']['total_amount'] = $trxnParams['total_amount'] = $params['total_amount'] = $params['prevContribution']->total_amount;
3315         $params['trxnParams']['fee_amount'] = $params['prevContribution']->fee_amount;
3316         $params['trxnParams']['net_amount'] = $params['prevContribution']->net_amount;
3317         if (!isset($params['trxnParams']['trxn_id'])) {
3318           // Actually I have no idea why we are overwriting any values from the previous contribution.
3319           // (filling makes sense to me). However, only protecting this value as I really really know we
3320           // don't want this one overwritten.
3321           // CRM-17751.
3322           $params['trxnParams']['trxn_id'] = $params['prevContribution']->trxn_id;
3323         }
3324         $params['trxnParams']['status_id'] = $params['prevContribution']->contribution_status_id;
3325
3326         if (!(($params['prevContribution']->contribution_status_id == array_search('Pending', $contributionStatuses)
3327             || $params['prevContribution']->contribution_status_id == array_search('In Progress', $contributionStatuses))
3328           && $params['contribution']->contribution_status_id == array_search('Completed', $contributionStatuses))
3329         ) {
3330           $params['trxnParams']['payment_instrument_id'] = $params['prevContribution']->payment_instrument_id;
3331           $params['trxnParams']['check_number'] = $params['prevContribution']->check_number;
3332         }
3333
3334         //if financial type is changed
3335         if (!empty($params['financial_type_id']) &&
3336           $params['contribution']->financial_type_id != $params['prevContribution']->financial_type_id
3337         ) {
3338           $accountRelationship = 'Income Account is';
3339           if (!empty($params['revenue_recognition_date']) || $params['prevContribution']->revenue_recognition_date) {
3340             $accountRelationship = 'Deferred Revenue Account is';
3341           }
3342           $oldFinancialAccount = CRM_Financial_BAO_FinancialAccount::getFinancialAccountForFinancialTypeByRelationship($params['prevContribution']->financial_type_id, $accountRelationship);
3343           $newFinancialAccount = CRM_Financial_BAO_FinancialAccount::getFinancialAccountForFinancialTypeByRelationship($params['financial_type_id'], $accountRelationship);
3344           if ($oldFinancialAccount != $newFinancialAccount) {
3345             $params['total_amount'] = 0;
3346             if (in_array($params['contribution']->contribution_status_id, $pendingStatus)) {
3347               $params['trxnParams']['to_financial_account_id'] = CRM_Financial_BAO_FinancialAccount::getFinancialAccountForFinancialTypeByRelationship(
3348                 $params['prevContribution']->financial_type_id, $accountRelationship);
3349             }
3350             else {
3351               $lastFinancialTrxnId = CRM_Core_BAO_FinancialTrxn::getFinancialTrxnId($params['prevContribution']->id, 'DESC');
3352               if (!empty($lastFinancialTrxnId['financialTrxnId'])) {
3353                 $params['trxnParams']['to_financial_account_id'] = CRM_Core_DAO::getFieldValue('CRM_Financial_DAO_FinancialTrxn', $lastFinancialTrxnId['financialTrxnId'], 'to_financial_account_id');
3354               }
3355             }
3356             self::updateFinancialAccounts($params, 'changeFinancialType');
3357             /* $params['trxnParams']['to_financial_account_id'] = $trxnParams['to_financial_account_id']; */
3358             $params['financial_account_id'] = $newFinancialAccount;
3359             $params['total_amount'] = $params['trxnParams']['total_amount'] = $params['trxnParams']['net_amount'] = $trxnParams['total_amount'];
3360             self::updateFinancialAccounts($params);
3361             $params['trxnParams']['to_financial_account_id'] = $trxnParams['to_financial_account_id'];
3362             $updated = TRUE;
3363             $params['deferred_financial_account_id'] = $newFinancialAccount;
3364           }
3365         }
3366
3367         //Update contribution status
3368         $params['trxnParams']['status_id'] = $params['contribution']->contribution_status_id;
3369         if (!isset($params['refund_trxn_id'])) {
3370           // CRM-17751 This has previously been deliberately set. No explanation as to why one variant
3371           // gets preference over another so I am only 'protecting' a very specific tested flow
3372           // and letting natural justice take care of the rest.
3373           $params['trxnParams']['trxn_id'] = $params['contribution']->trxn_id;
3374         }
3375         if (!empty($params['contribution_status_id']) &&
3376           $params['prevContribution']->contribution_status_id != $params['contribution']->contribution_status_id
3377         ) {
3378           //Update Financial Records
3379           self::updateFinancialAccounts($params, 'changedStatus');
3380           $updated = TRUE;
3381         }
3382
3383         // change Payment Instrument for a Completed contribution
3384         // first handle special case when contribution is changed from Pending to Completed status when initial payment
3385         // instrument is null and now new payment instrument is added along with the payment
3386         if (!$params['contribution']->payment_instrument_id) {
3387           $params['contribution']->find(TRUE);
3388         }
3389         $params['trxnParams']['payment_instrument_id'] = $params['contribution']->payment_instrument_id;
3390         $params['trxnParams']['check_number'] = CRM_Utils_Array::value('check_number', $params);
3391
3392         if (self::isPaymentInstrumentChange($params, $pendingStatus)) {
3393           $updated = CRM_Core_BAO_FinancialTrxn::updateFinancialAccountsOnPaymentInstrumentChange($params);
3394         }
3395
3396         //if Change contribution amount
3397         $params['trxnParams']['fee_amount'] = CRM_Utils_Array::value('fee_amount', $params);
3398         $params['trxnParams']['net_amount'] = CRM_Utils_Array::value('net_amount', $params);
3399         $params['trxnParams']['total_amount'] = $trxnParams['total_amount'] = $params['total_amount'] = $totalAmount;
3400         $params['trxnParams']['trxn_id'] = $params['contribution']->trxn_id;
3401         if (isset($totalAmount) &&
3402           $totalAmount != $params['prevContribution']->total_amount
3403         ) {
3404           //Update Financial Records
3405           $params['trxnParams']['from_financial_account_id'] = NULL;
3406           self::updateFinancialAccounts($params, 'changedAmount');
3407           $updated = TRUE;
3408         }
3409
3410         if (!$updated) {
3411           // Looks like we might have a data correction update.
3412           // This would be a case where a transaction id has been entered but it is incorrect &
3413           // the person goes back in & fixes it, as opposed to a new transaction.
3414           // Currently the UI doesn't support multiple refunds against a single transaction & we are only supporting
3415           // the data fix scenario.
3416           // CRM-17751.
3417           if (isset($params['refund_trxn_id'])) {
3418             $refundIDs = CRM_Core_BAO_FinancialTrxn::getRefundTransactionIDs($params['id']);
3419             if (!empty($refundIDs['financialTrxnId']) && $refundIDs['trxn_id'] != $params['refund_trxn_id']) {
3420               civicrm_api3('FinancialTrxn', 'create', array('id' => $refundIDs['financialTrxnId'], 'trxn_id' => $params['refund_trxn_id']));
3421             }
3422           }
3423           $cardType = CRM_Utils_Array::value('card_type_id', $params);
3424           $panTruncation = CRM_Utils_Array::value('pan_truncation', $params);
3425           CRM_Core_BAO_FinancialTrxn::updateCreditCardDetails($params['contribution']->id, $panTruncation, $cardType);
3426         }
3427       }
3428
3429       if (!$update) {
3430         // records finanical trxn and entity financial trxn
3431         // also make it available as return value
3432         self::recordAlwaysAccountsReceivable($trxnParams, $params);
3433         $trxnParams['pan_truncation'] = CRM_Utils_Array::value('pan_truncation', $params);
3434         $trxnParams['card_type_id'] = CRM_Utils_Array::value('card_type_id', $params);
3435         $return = $financialTxn = CRM_Core_BAO_FinancialTrxn::create($trxnParams);
3436         $params['entity_id'] = $financialTxn->id;
3437         if (empty($params['partial_payment_total']) && empty($params['partial_amount_to_pay'])) {
3438           self::$_trxnIDs[] = $financialTxn->id;
3439         }
3440       }
3441     }
3442     // record line items and financial items
3443     if (empty($params['skipLineItem'])) {
3444       CRM_Price_BAO_LineItem::processPriceSet($entityId, CRM_Utils_Array::value('line_item', $params), $params['contribution'], $entityTable, $update);
3445     }
3446
3447     // create batch entry if batch_id is passed and
3448     // ensure no batch entry is been made on 'Pending' or 'Failed' contribution, CRM-16611
3449     if (!empty($params['batch_id']) && !empty($financialTxn)) {
3450       $entityParams = array(
3451         'batch_id' => $params['batch_id'],
3452         'entity_table' => 'civicrm_financial_trxn',
3453         'entity_id' => $financialTxn->id,
3454       );
3455       CRM_Batch_BAO_EntityBatch::create($entityParams);
3456     }
3457
3458     // when a fee is charged
3459     if (!empty($params['fee_amount']) && (empty($params['prevContribution']) || $params['contribution']->fee_amount != $params['prevContribution']->fee_amount) && $skipRecords) {
3460       CRM_Core_BAO_FinancialTrxn::recordFees($params);
3461     }
3462
3463     if (!empty($params['prevContribution']) && $entityTable == 'civicrm_participant'
3464       && $params['prevContribution']->contribution_status_id != $params['contribution']->contribution_status_id
3465     ) {
3466       $eventID = CRM_Core_DAO::getFieldValue('CRM_Event_DAO_Participant', $entityId, 'event_id');
3467       $feeLevel[] = str_replace('\ 1', '', $params['prevContribution']->amount_level);
3468       CRM_Event_BAO_Participant::createDiscountTrxn($eventID, $params, $feeLevel);
3469     }
3470     unset($params['line_item']);
3471     self::$_trxnIDs = NULL;
3472     return $return;
3473   }
3474
3475   /**
3476    * Update all financial accounts entry.
3477    *
3478    * @param array $params
3479    *   Contribution object, line item array and params for trxn.
3480    *
3481    * @todo stop passing $params by reference. It is unclear the purpose of doing this &
3482    * adds unpredictability.
3483    *
3484    * @param string $context
3485    *   Update scenarios.
3486    *
3487    */
3488   public static function updateFinancialAccounts(&$params, $context = NULL) {
3489     $trxnID = NULL;
3490     $inputParams = $params;
3491     $isARefund = FALSE;
3492     $currentContributionStatus = CRM_Core_PseudoConstant::getLabel('CRM_Contribute_BAO_Contribution', 'contribution_status_id', $params['contribution']->contribution_status_id);
3493     $previousContributionStatus = CRM_Contribute_PseudoConstant::contributionStatus($params['prevContribution']->contribution_status_id, 'name');
3494
3495     if (($previousContributionStatus == 'Pending'
3496         || $previousContributionStatus == 'In Progress')
3497       && $currentContributionStatus == 'Completed'
3498       && $context == 'changePaymentInstrument'
3499     ) {
3500       return;
3501     }
3502     if ((($previousContributionStatus == 'Partially paid'
3503       && $currentContributionStatus == 'Completed')
3504       || ($previousContributionStatus == 'Pending' && $params['prevContribution']->is_pay_later == TRUE
3505       && $currentContributionStatus == 'Partially paid'))
3506       && $context == 'changedStatus'
3507     ) {
3508       return;
3509     }
3510     if ($context == 'changedAmount' || $context == 'changeFinancialType') {
3511       // @todo we should stop passing $params by reference - splitting this out would be a step towards that.
3512       $params['trxnParams']['total_amount'] = $params['trxnParams']['net_amount'] = ($params['total_amount'] - $params['prevContribution']->total_amount);
3513     }
3514     if ($context == 'changedStatus') {
3515       if ($previousContributionStatus == 'Completed'
3516         && (self::isContributionStatusNegative($params['contribution']->contribution_status_id))
3517       ) {
3518         $isARefund = TRUE;
3519         // @todo we should stop passing $params by reference - splitting this out would be a step towards that.
3520         $params['trxnParams']['total_amount'] = -$params['total_amount'];
3521         if (empty($params['contribution']->creditnote_id) || $params['contribution']->creditnote_id == "null") {
3522           $creditNoteId = self::createCreditNoteId();
3523           CRM_Core_DAO::setFieldValue('CRM_Contribute_DAO_Contribution', $params['contribution']->id, 'creditnote_id', $creditNoteId);
3524         }
3525       }
3526       elseif (($previousContributionStatus == 'Pending'
3527           && $params['prevContribution']->is_pay_later) || $previousContributionStatus == 'In Progress'
3528       ) {
3529         $financialTypeID = CRM_Utils_Array::value('financial_type_id', $params) ? $params['financial_type_id'] : $params['prevContribution']->financial_type_id;
3530         $arAccountId = CRM_Contribute_PseudoConstant::getRelationalFinancialAccount($financialTypeID, 'Accounts Receivable Account is');
3531
3532         if ($currentContributionStatus == 'Cancelled') {
3533           // @todo we should stop passing $params by reference - splitting this out would be a step towards that.
3534           $params['trxnParams']['to_financial_account_id'] = $arAccountId;
3535           $params['trxnParams']['total_amount'] = -$params['total_amount'];
3536           if (is_null($params['contribution']->creditnote_id) || $params['contribution']->creditnote_id == "null") {
3537             $creditNoteId = self::createCreditNoteId();
3538             CRM_Core_DAO::setFieldValue('CRM_Contribute_DAO_Contribution', $params['contribution']->id, 'creditnote_id', $creditNoteId);
3539           }
3540         }
3541         else {
3542           // @todo we should stop passing $params by reference - splitting this out would be a step towards that.
3543           $params['trxnParams']['from_financial_account_id'] = $arAccountId;
3544         }
3545       }
3546     }
3547
3548     if ($context == 'changedStatus') {
3549       if (($previousContributionStatus == 'Pending'
3550           || $previousContributionStatus == 'In Progress')
3551         && ($currentContributionStatus == 'Completed')
3552       ) {
3553         if (empty($params['line_item'])) {
3554           //CRM-15296
3555           //@todo - check with Joe regarding this situation - payment processors create pending transactions with no line items
3556           // when creating recurring membership payment - there are 2 lines to comment out in contributonPageTest if fixed
3557           // & this can be removed
3558           return;
3559         }
3560         // @todo we should stop passing $params by reference - splitting this out would be a step towards that.
3561         // This is an update so original currency if none passed in.
3562         $params['trxnParams']['currency'] = CRM_Utils_Array::value('currency', $params, $params['prevContribution']->currency);
3563
3564         self::recordAlwaysAccountsReceivable($params['trxnParams'], $params);
3565         $trxn = CRM_Core_BAO_FinancialTrxn::create($params['trxnParams']);
3566         // @todo we should stop passing $params by reference - splitting this out would be a step towards that.
3567         $params['entity_id'] = self::$_trxnIDs[] = $trxn->id;
3568         $query = "UPDATE civicrm_financial_item SET status_id = %1 WHERE entity_id = %2 and entity_table = 'civicrm_line_item'";
3569         $sql = "SELECT id, amount FROM civicrm_financial_item WHERE entity_id = %1 and entity_table = 'civicrm_line_item'";
3570
3571         $entityParams = array(
3572           'entity_table' => 'civicrm_financial_item',
3573         );
3574         foreach ($params['line_item'] as $fieldId => $fields) {
3575           foreach ($fields as $fieldValueId => $lineItemDetails) {
3576             $fparams = array(
3577               1 => array(CRM_Core_PseudoConstant::getKey('CRM_Financial_BAO_FinancialItem', 'status_id', 'Paid'), 'Integer'),
3578               2 => array($lineItemDetails['id'], 'Integer'),
3579             );
3580             CRM_Core_DAO::executeQuery($query, $fparams);
3581             $fparams = array(
3582               1 => array($lineItemDetails['id'], 'Integer'),
3583             );
3584             $financialItem = CRM_Core_DAO::executeQuery($sql, $fparams);
3585             while ($financialItem->fetch()) {
3586               $entityParams['entity_id'] = $financialItem->id;
3587               $entityParams['amount'] = $financialItem->amount;
3588               foreach (self::$_trxnIDs as $tID) {
3589                 $entityParams['financial_trxn_id'] = $tID;
3590                 CRM_Financial_BAO_FinancialItem::createEntityTrxn($entityParams);
3591               }
3592             }
3593           }
3594         }
3595         return;
3596       }
3597     }
3598
3599     $trxn = CRM_Core_BAO_FinancialTrxn::create($params['trxnParams']);
3600     // @todo we should stop passing $params by reference - splitting this out would be a step towards that.
3601     $params['entity_id'] = $trxn->id;
3602     if ($context != 'changePaymentInstrument') {
3603       $itemParams['entity_table'] = 'civicrm_line_item';
3604       $trxnIds['id'] = $params['entity_id'];
3605       $previousLineItems = CRM_Price_BAO_LineItem::getLineItemsByContributionID($params['contribution']->id);
3606       foreach ($params['line_item'] as $fieldId => $fields) {
3607         foreach ($fields as $fieldValueId => $lineItemDetails) {
3608           $prevFinancialItem = CRM_Financial_BAO_FinancialItem::getPreviousFinancialItem($lineItemDetails['id']);
3609           $receiveDate = CRM_Utils_Date::isoToMysql($params['prevContribution']->receive_date);
3610           if ($params['contribution']->receive_date) {
3611             $receiveDate = CRM_Utils_Date::isoToMysql($params['contribution']->receive_date);
3612           }
3613
3614           $financialAccount = self::getFinancialAccountForStatusChangeTrxn($params, CRM_Utils_Array::value('financial_account_id', $prevFinancialItem));
3615
3616           $currency = $params['prevContribution']->currency;
3617           // @todo we should stop passing $params by reference - splitting this out would be a step towards that.
3618           if ($params['contribution']->currency) {
3619             $currency = $params['contribution']->currency;
3620           }
3621           $previousLineItemTotal = CRM_Utils_Array::value('line_total', CRM_Utils_Array::value($fieldValueId, $previousLineItems), 0);
3622           $itemParams = array(
3623             'transaction_date' => $receiveDate,
3624             'contact_id' => $params['prevContribution']->contact_id,
3625             'currency' => $currency,
3626             'amount' => self::getFinancialItemAmountFromParams($inputParams, $context, $lineItemDetails, $isARefund, $previousLineItemTotal),
3627             'description' => CRM_Utils_Array::value('description', $prevFinancialItem),
3628             'status_id' => $prevFinancialItem['status_id'],
3629             'financial_account_id' => $financialAccount,
3630             'entity_table' => 'civicrm_line_item',
3631             'entity_id' => $lineItemDetails['id'],
3632           );
3633           $financialItem = CRM_Financial_BAO_FinancialItem::create($itemParams, NULL, $trxnIds);
3634           // @todo we should stop passing $params by reference - splitting this out would be a step towards that.
3635           $params['line_item'][$fieldId][$fieldValueId]['deferred_line_total'] = $itemParams['amount'];
3636           $params['line_item'][$fieldId][$fieldValueId]['financial_item_id'] = $financialItem->id;
3637
3638           if (($lineItemDetails['tax_amount'] && $lineItemDetails['tax_amount'] !== 'null') || ($context == 'changeFinancialType')) {
3639             $invoiceSettings = Civi::settings()->get('contribution_invoice_settings');
3640             $taxTerm = CRM_Utils_Array::value('tax_term', $invoiceSettings);
3641             $taxAmount = (float) $lineItemDetails['tax_amount'];
3642             if ($context == 'changeFinancialType' && $lineItemDetails['tax_amount'] === 'null') {
3643               // reverse the Sale Tax amount if there is no tax rate associated with new Financial Type
3644               $taxAmount = CRM_Utils_Array::value('tax_amount', CRM_Utils_Array::value($fieldValueId, $previousLineItems), 0);
3645             }
3646             elseif ($previousLineItemTotal != $lineItemDetails['line_total']) {
3647               $taxAmount -= CRM_Utils_Array::value('tax_amount', CRM_Utils_Array::value($fieldValueId, $previousLineItems), 0);
3648             }
3649             $itemParams['amount'] = self::getMultiplier($params['contribution']->contribution_status_id, $context) * $taxAmount;
3650             $itemParams['description'] = $taxTerm;
3651             if ($lineItemDetails['financial_type_id']) {
3652               $itemParams['financial_account_id'] = CRM_Contribute_PseudoConstant::getRelationalFinancialAccount(
3653                 $lineItemDetails['financial_type_id'],
3654                 'Sales Tax Account is'
3655               );
3656             }
3657             CRM_Financial_BAO_FinancialItem::create($itemParams, NULL, $trxnIds);
3658           }
3659         }
3660       }
3661     }
3662     if ($context == 'changeFinancialType') {
3663       // @todo we should stop passing $params by reference - splitting this out would be a step towards that.
3664       $params['skipLineItem'] = FALSE;
3665       foreach ($params['line_item'] as &$lineItems) {
3666         foreach ($lineItems as &$line) {
3667           $line['financial_type_id'] = $params['financial_type_id'];
3668         }
3669       }
3670     }
3671
3672     CRM_Core_BAO_FinancialTrxn::createDeferredTrxn(CRM_Utils_Array::value('line_item', $params), $params['contribution'], TRUE, $context);
3673   }
3674
3675   /**
3676    * Is this contribution status a reversal.
3677    *
3678    * If so we would expect to record a negative value in the financial_trxn table.
3679    *
3680    * @param int $status_id
3681    *
3682    * @return bool
3683    */
3684   public static function isContributionStatusNegative($status_id) {
3685     $reversalStatuses = array('Cancelled', 'Chargeback', 'Refunded');
3686     return in_array(CRM_Contribute_PseudoConstant::contributionStatus($status_id, 'name'), $reversalStatuses);
3687   }
3688
3689   /**
3690    * Check status validation on update of a contribution.
3691    *
3692    * @param array $values
3693    *   Previous form values before submit.
3694    *
3695    * @param array $fields
3696    *   The input form values.
3697    *
3698    * @param array $errors
3699    *   List of errors.
3700    *
3701    * @return bool
3702    */
3703   public static function checkStatusValidation($values, &$fields, &$errors) {
3704     if (CRM_Utils_System::isNull($values) && !empty($fields['id'])) {
3705       $values['contribution_status_id'] = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_Contribution', $fields['id'], 'contribution_status_id');
3706       if ($values['contribution_status_id'] == $fields['contribution_status_id']) {
3707         return FALSE;
3708       }
3709     }
3710     $contributionStatuses = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');
3711     $checkStatus = array(
3712       'Cancelled' => array('Completed', 'Refunded'),
3713       'Completed' => array('Cancelled', 'Refunded', 'Chargeback'),
3714       'Pending' => array('Cancelled', 'Completed', 'Failed', 'Partially paid'),
3715       'In Progress' => array('Cancelled', 'Completed', 'Failed'),
3716       'Refunded' => array('Cancelled', 'Completed'),
3717       'Partially paid' => array('Completed'),
3718     );
3719
3720     if (!in_array($contributionStatuses[$fields['contribution_status_id']],
3721       CRM_Utils_Array::value($contributionStatuses[$values['contribution_status_id']], $checkStatus, array()))
3722     ) {
3723       $errors['contribution_status_id'] = ts("Cannot change contribution status from %1 to %2.", array(
3724         1 => $contributionStatuses[$values['contribution_status_id']],
3725         2 => $contributionStatuses[$fields['contribution_status_id']],
3726       ));
3727     }
3728   }
3729
3730   /**
3731    * Delete contribution of contact.
3732    *
3733    * CRM-12155
3734    *
3735    * @param int $contactId
3736    *   Contact id.
3737    *
3738    */
3739   public static function deleteContactContribution($contactId) {
3740     $contribution = new CRM_Contribute_DAO_Contribution();
3741     $contribution->contact_id = $contactId;
3742     $contribution->find();
3743     while ($contribution->fetch()) {
3744       self::deleteContribution($contribution->id);
3745     }
3746   }
3747
3748   /**
3749    * Get options for a given contribution field.
3750    * @see CRM_Core_DAO::buildOptions
3751    *
3752    * @param string $fieldName
3753    * @param string $context see CRM_Core_DAO::buildOptionsContext.
3754    * @param array $props  whatever is known about this dao object.
3755    *
3756    * @return array|bool
3757    */
3758   public static function buildOptions($fieldName, $context = NULL, $props = array()) {
3759     $className = __CLASS__;
3760     $params = array();
3761     if (isset($props['orderColumn'])) {
3762       $params['orderColumn'] = $props['orderColumn'];
3763     }
3764     switch ($fieldName) {
3765       // This field is not part of this object but the api supports it
3766       case 'payment_processor':
3767         $className = 'CRM_Contribute_BAO_ContributionPage';
3768         // Filter results by contribution page
3769         if (!empty($props['contribution_page_id'])) {
3770           $page = civicrm_api('contribution_page', 'getsingle', array(
3771             'version' => 3,
3772             'id' => ($props['contribution_page_id']),
3773           ));
3774           $types = (array) CRM_Utils_Array::value('payment_processor', $page, 0);
3775           $params['condition'] = 'id IN (' . implode(',', $types) . ')';
3776         }
3777         break;
3778
3779       // CRM-13981 This field was combined with soft_credits in 4.5 but the api still supports it
3780       case 'honor_type_id':
3781         $className = 'CRM_Contribute_BAO_ContributionSoft';
3782         $fieldName = 'soft_credit_type_id';
3783         $params['condition'] = "v.name IN ('in_honor_of','in_memory_of')";
3784         break;
3785     }
3786     return CRM_Core_PseudoConstant::get($className, $fieldName, $params, $context);
3787   }
3788
3789   /**
3790    * Validate financial type.
3791    *
3792    * CRM-13231
3793    *
3794    * @param int $financialTypeId
3795    *   Financial Type id.
3796    *
3797    * @param string $relationName
3798    *
3799    * @return array|bool
3800    */
3801   public static function validateFinancialType($financialTypeId, $relationName = 'Expense Account is') {
3802     $financialAccount = CRM_Contribute_PseudoConstant::getRelationalFinancialAccount($financialTypeId, $relationName);
3803
3804     if (!$financialAccount) {
3805       return CRM_Contribute_PseudoConstant::financialType($financialTypeId);
3806     }
3807     return FALSE;
3808   }
3809
3810
3811   /**
3812    * Function to record additional payment for partial and refund contributions.
3813    *
3814    * @param int $contributionId
3815    *   is the invoice contribution id (got created after processing participant payment).
3816    * @param array $trxnsData
3817    *   to take user provided input of transaction details.
3818    * @param string $paymentType
3819    *   'owed' for purpose of recording partial payments, 'refund' for purpose of recording refund payments.
3820    * @param int $participantId
3821    * @param bool $updateStatus
3822    *
3823    * @return null|object
3824    */
3825   public static function recordAdditionalPayment($contributionId, $trxnsData, $paymentType = 'owed', $participantId = NULL, $updateStatus = TRUE) {
3826
3827     if ($paymentType == 'owed') {
3828       $financialTrxn = CRM_Financial_BAO_Payment::recordPayment($contributionId, $trxnsData, $participantId);
3829     }
3830     elseif ($paymentType == 'refund') {
3831       $financialTrxn = CRM_Financial_BAO_Payment::recordRefundPayment($contributionId, $trxnsData, $updateStatus);
3832       if ($participantId) {
3833         // update participant status
3834         // @todo this doesn't make sense...
3835         $participantStatuses = CRM_Event_PseudoConstant::participantStatus();
3836         $ids = CRM_Event_BAO_Participant::getParticipantIds($contributionId);
3837         foreach ($ids as $val) {
3838           $participantUpdate['id'] = $val;
3839           $participantUpdate['status_id'] = array_search('Registered', $participantStatuses);
3840           CRM_Event_BAO_Participant::add($participantUpdate);
3841         }
3842       }
3843     }
3844
3845     if (!empty($financialTrxn)) {
3846       self::recordPaymentActivity($contributionId, $participantId, $financialTrxn);
3847       return $financialTrxn;
3848     }
3849
3850   }
3851
3852   /**
3853    * @param $entityObj
3854    * @param $trxnObj
3855    * @param $activityType
3856    * @param $component
3857    * @param int $contributionId
3858    *
3859    * @throws CRM_Core_Exception
3860    */
3861   public static function addActivityForPayment($entityObj, $trxnObj, $activityType, $component, $contributionId) {
3862     if ($component == 'event') {
3863       $title = CRM_Core_DAO::getFieldValue('CRM_Event_BAO_Event', $entityObj->event_id, 'title');
3864     }
3865     else {
3866       $title = ts('Contribution');
3867     }
3868     $paymentAmount = CRM_Utils_Money::format($trxnObj->total_amount, $trxnObj->currency);
3869     $subject = "{$paymentAmount} - Offline {$activityType} for {$title}";
3870     $date = CRM_Utils_Date::isoToMysql($trxnObj->trxn_date);
3871     $targetCid = $entityObj->contact_id;
3872     // source record id would be the contribution id
3873     $srcRecId = $contributionId;
3874
3875     // activity params
3876     $activityParams = array(
3877       'source_contact_id' => $targetCid,
3878       'source_record_id' => $srcRecId,
3879       'activity_type_id' => CRM_Core_PseudoConstant::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', $activityType),
3880       'subject' => $subject,
3881       'activity_date_time' => $date,
3882       'status_id' => CRM_Core_PseudoConstant::getKey('CRM_Activity_BAO_Activity', 'activity_status_id', 'Completed'),
3883       'skipRecentView' => TRUE,
3884     );
3885
3886     // create activity with target contacts
3887     $session = CRM_Core_Session::singleton();
3888     $id = $session->get('userID');
3889     if ($id) {
3890       $activityParams['source_contact_id'] = $id;
3891       $activityParams['target_contact_id'][] = $targetCid;
3892     }
3893     // @todo use api.
3894     CRM_Activity_BAO_Activity::create($activityParams);
3895   }
3896
3897   /**
3898    * Get list of payments displayed by Contribute_Page_PaymentInfo.
3899    *
3900    * @param int $id
3901    * @param $component
3902    * @param bool $getTrxnInfo
3903    * @param bool $usingLineTotal
3904    *
3905    * @return mixed
3906    */
3907   public static function getPaymentInfo($id, $component = 'contribution', $getTrxnInfo = FALSE, $usingLineTotal = FALSE) {
3908     // @todo deprecate passing in component - always call with contribution.
3909     if ($component == 'event') {
3910       $contributionId = CRM_Core_DAO::getFieldValue('CRM_Event_BAO_ParticipantPayment', $id, 'contribution_id', 'participant_id');
3911
3912       if (!$contributionId) {
3913         if ($primaryParticipantId = CRM_Core_DAO::getFieldValue('CRM_Event_BAO_Participant', $id, 'registered_by_id')) {
3914           $contributionId = CRM_Core_DAO::getFieldValue('CRM_Event_BAO_ParticipantPayment', $primaryParticipantId, 'contribution_id', 'participant_id');
3915           $id = $primaryParticipantId;
3916         }
3917         if (!$contributionId) {
3918           return;
3919         }
3920       }
3921     }
3922     elseif ($component == 'membership') {
3923       $contributionId = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipPayment', $id, 'contribution_id', 'membership_id');
3924     }
3925     else {
3926       $contributionId = $id;
3927     }
3928
3929     $total = CRM_Core_BAO_FinancialTrxn::getBalanceTrxnAmt($contributionId);
3930     $baseTrxnId = !empty($total['trxn_id']) ? $total['trxn_id'] : NULL;
3931     if (!$baseTrxnId) {
3932       $baseTrxnId = CRM_Core_BAO_FinancialTrxn::getFinancialTrxnId($contributionId);
3933       $baseTrxnId = $baseTrxnId['financialTrxnId'];
3934     }
3935     if (!CRM_Utils_Array::value('total_amount', $total) || $usingLineTotal) {
3936       $total = CRM_Price_BAO_LineItem::getLineTotal($contributionId);
3937     }
3938     else {
3939       $baseTrxnId = $total['trxn_id'];
3940       $total = $total['total_amount'];
3941     }
3942
3943     $paymentBalance = CRM_Contribute_BAO_Contribution::getContributionBalance($contributionId, $total);
3944
3945     $contribution = civicrm_api3('Contribution', 'getsingle', array('id' => $contributionId, 'return' => array('currency', 'is_pay_later', 'contribution_status_id', 'financial_type_id')));
3946
3947     $info['payLater'] = $contribution['is_pay_later'];
3948     $info['contribution_status'] = $contribution['contribution_status'];
3949     $info['currency'] = $contribution['currency'];
3950
3951     $financialTypeId = $contribution['financial_type_id'];
3952     $feeFinancialAccount = CRM_Contribute_PseudoConstant::getRelationalFinancialAccount($financialTypeId, 'Expense Account is');
3953
3954     if ($paymentBalance == 0 && $info['payLater']) {
3955       // @todo - review - this looks very unlikely to be correct.
3956       // the balance should be correct based on payment transactions not
3957       // assumptions.
3958       $paymentBalance = $total;
3959     }
3960
3961     $info['total'] = $total;
3962     $info['paid'] = $total - $paymentBalance;
3963     $info['balance'] = $paymentBalance;
3964     $info['id'] = $id;
3965     $info['component'] = $component;
3966     $rows = array();
3967     if ($getTrxnInfo && $baseTrxnId) {
3968       // Need to exclude fee trxn rows so filter out rows where TO FINANCIAL ACCOUNT is expense account
3969       $sql = "
3970         SELECT GROUP_CONCAT(fa.`name`) as financial_account,
3971           ft.total_amount,
3972           ft.payment_instrument_id,
3973           ft.trxn_date, ft.trxn_id, ft.status_id, ft.check_number, ft.currency, ft.pan_truncation, ft.card_type_id, ft.id
3974
3975         FROM civicrm_contribution con
3976           LEFT JOIN civicrm_entity_financial_trxn eft ON (eft.entity_id = con.id AND eft.entity_table = 'civicrm_contribution')
3977           INNER JOIN civicrm_financial_trxn ft ON ft.id = eft.financial_trxn_id
3978             AND ft.to_financial_account_id != %2
3979           LEFT JOIN civicrm_entity_financial_trxn ef ON (ef.financial_trxn_id = ft.id AND ef.entity_table = 'civicrm_financial_item')
3980           LEFT JOIN civicrm_financial_item fi ON fi.id = ef.entity_id
3981           LEFT JOIN civicrm_financial_account fa ON fa.id = fi.financial_account_id
3982
3983         WHERE con.id = %1 AND ft.is_payment = 1
3984         GROUP BY ft.id";
3985       $queryParams = array(
3986         1 => array($contributionId, 'Integer'),
3987         2 => array($feeFinancialAccount, 'Integer'),
3988       );
3989       $resultDAO = CRM_Core_DAO::executeQuery($sql, $queryParams);
3990       $statuses = CRM_Contribute_PseudoConstant::contributionStatus();
3991
3992       while ($resultDAO->fetch()) {
3993         $paidByLabel = CRM_Core_PseudoConstant::getLabel('CRM_Core_BAO_FinancialTrxn', 'payment_instrument_id', $resultDAO->payment_instrument_id);
3994         $paidByName = CRM_Core_PseudoConstant::getName('CRM_Core_BAO_FinancialTrxn', 'payment_instrument_id', $resultDAO->payment_instrument_id);
3995         if ($resultDAO->card_type_id) {
3996           $creditCardType = CRM_Core_PseudoConstant::getLabel('CRM_Core_BAO_FinancialTrxn', 'card_type_id', $resultDAO->card_type_id);
3997           $pantruncation = '';
3998           if ($resultDAO->pan_truncation) {
3999             $pantruncation = ": {$resultDAO->pan_truncation}";
4000           }
4001           $paidByLabel .= " ({$creditCardType}{$pantruncation})";
4002         }
4003
4004         // show payment edit link only for payments done via backoffice form
4005         $paymentEditLink = '';
4006         if (empty($resultDAO->payment_processor_id) && CRM_Core_Permission::check('edit contributions')) {
4007           $links = array(
4008             CRM_Core_Action::UPDATE => array(
4009               'name' => "<i class='crm-i fa-pencil'></i>",
4010               'url' => 'civicrm/payment/edit',
4011               'class' => 'medium-popup',
4012               'qs' => "reset=1&id=%%id%%&contribution_id=%%contribution_id%%",
4013               'title' => ts('Edit Payment'),
4014             ),
4015           );
4016           $paymentEditLink = CRM_Core_Action::formLink(
4017             $links,
4018             CRM_Core_Action::mask(array(CRM_Core_Permission::EDIT)),
4019             array(
4020               'id' => $resultDAO->id,
4021               'contribution_id' => $contributionId,
4022             )
4023           );
4024         }
4025
4026         $val = array(
4027           'id' => $resultDAO->id,
4028           'total_amount' => $resultDAO->total_amount,
4029           'financial_type' => $resultDAO->financial_account,
4030           'payment_instrument' => $paidByLabel,
4031           'receive_date' => $resultDAO->trxn_date,
4032           'trxn_id' => $resultDAO->trxn_id,
4033           'status' => $statuses[$resultDAO->status_id],
4034           'currency' => $resultDAO->currency,
4035           'action' => $paymentEditLink,
4036         );
4037         if ($paidByName == 'Check') {
4038           $val['check_number'] = $resultDAO->check_number;
4039         }
4040         $rows[] = $val;
4041       }
4042       $info['transaction'] = $rows;
4043     }
4044
4045     $info['payment_links'] = self::getContributionPaymentLinks($id, $paymentBalance, $info['contribution_status']);
4046     return $info;
4047   }
4048
4049   /**
4050    * Get the outstanding balance on a contribution.
4051    *
4052    * @param int $contributionId
4053    * @param float $contributionTotal
4054    *   Optional amount to override the saved amount paid (e.g if calculating what it WILL be).
4055    *
4056    * @return float
4057    */
4058   public static function getContributionBalance($contributionId, $contributionTotal = NULL) {
4059     if ($contributionTotal === NULL) {
4060       $contributionTotal = CRM_Price_BAO_LineItem::getLineTotal($contributionId);
4061     }
4062
4063     return CRM_Utils_Money::subtractCurrencies(
4064       $contributionTotal,
4065       CRM_Core_BAO_FinancialTrxn::getTotalPayments($contributionId, TRUE) ?: 0,
4066       CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_Contribution', $contributionId, 'currency')
4067     );
4068   }
4069
4070   /**
4071    * Get the tax amount (misnamed function).
4072    *
4073    * @param array $params
4074    * @param bool $isLineItem
4075    *
4076    * @return array
4077    */
4078   public static function checkTaxAmount($params, $isLineItem = FALSE) {
4079     $taxRates = CRM_Core_PseudoConstant::getTaxRates();
4080
4081     // This function should be only called after standardisation (removal of
4082     // thousand separator & using a decimal point for cents separator.
4083     // However, we don't know if that is always true :-(
4084     // There is a deprecation notice tho :-)
4085     $unknownIfMoneyIsClean = empty($params['skipCleanMoney']) && !$isLineItem;
4086     // Update contribution.
4087     if (!empty($params['id'])) {
4088       // CRM-19126 and CRM-19152 If neither total or financial_type_id are set on an update
4089       // there are no tax implications - early return.
4090       if (!isset($params['total_amount']) && !isset($params['financial_type_id'])) {
4091         return $params;
4092       }
4093       if (empty($params['prevContribution'])) {
4094         $params['prevContribution'] = self::getOriginalContribution($params['id']);
4095       }
4096
4097       foreach (array('total_amount', 'financial_type_id', 'fee_amount') as $field) {
4098         if (!isset($params[$field])) {
4099           if ($field == 'total_amount' && $params['prevContribution']->tax_amount) {
4100             // Tax amount gets added back on later....
4101             $params['total_amount'] = $params['prevContribution']->total_amount -
4102               $params['prevContribution']->tax_amount;
4103           }
4104           else {
4105             $params[$field] = $params['prevContribution']->$field;
4106             if ($params[$field] != $params['prevContribution']->$field) {
4107             }
4108           }
4109         }
4110       }
4111
4112       self::calculateMissingAmountParams($params, $params['id']);
4113       if (!array_key_exists($params['financial_type_id'], $taxRates)) {
4114         // Assign tax Amount on update of contribution
4115         if (!empty($params['prevContribution']->tax_amount)) {
4116           $params['tax_amount'] = 'null';
4117           CRM_Price_BAO_LineItem::getLineItemArray($params, array($params['id']));
4118           foreach ($params['line_item'] as $setID => $priceField) {
4119             foreach ($priceField as $priceFieldID => $priceFieldValue) {
4120               $params['line_item'][$setID][$priceFieldID]['tax_amount'] = $params['tax_amount'];
4121             }
4122           }
4123         }
4124       }
4125     }
4126
4127     // New Contribution and update of contribution with tax rate financial type
4128     if (isset($params['financial_type_id']) && array_key_exists($params['financial_type_id'], $taxRates) &&
4129       empty($params['skipLineItem']) && !$isLineItem
4130     ) {
4131       $taxRateParams = $taxRates[$params['financial_type_id']];
4132       $taxAmount = CRM_Contribute_BAO_Contribution_Utils::calculateTaxAmount(CRM_Utils_Array::value('total_amount', $params), $taxRateParams, $unknownIfMoneyIsClean);
4133       $params['tax_amount'] = round($taxAmount['tax_amount'], 2);
4134
4135       // Get Line Item on update of contribution
4136       if (isset($params['id'])) {
4137         CRM_Price_BAO_LineItem::getLineItemArray($params, array($params['id']));
4138       }
4139       else {
4140         CRM_Price_BAO_LineItem::getLineItemArray($params);
4141       }
4142       foreach ($params['line_item'] as $setID => $priceField) {
4143         foreach ($priceField as $priceFieldID => $priceFieldValue) {
4144           $params['line_item'][$setID][$priceFieldID]['tax_amount'] = $params['tax_amount'];
4145         }
4146       }
4147       $params['total_amount'] = CRM_Utils_Array::value('total_amount', $params) + $params['tax_amount'];
4148     }
4149     elseif (isset($params['api.line_item.create'])) {
4150       // Update total amount of contribution using lineItem
4151       $taxAmountArray = array();
4152       foreach ($params['api.line_item.create'] as $key => $value) {
4153         if (isset($value['financial_type_id']) && array_key_exists($value['financial_type_id'], $taxRates)) {
4154           $taxRate = $taxRates[$value['financial_type_id']];
4155           $taxAmount = CRM_Contribute_BAO_Contribution_Utils::calculateTaxAmount($value['line_total'], $taxRate);
4156           $taxAmountArray[] = round($taxAmount['tax_amount'], 2);
4157         }
4158       }
4159       $params['tax_amount'] = array_sum($taxAmountArray);
4160       $params['total_amount'] = $params['total_amount'] + $params['tax_amount'];
4161     }
4162     else {
4163       // update line item of contrbution
4164       if (isset($params['financial_type_id']) && array_key_exists($params['financial_type_id'], $taxRates)  && $isLineItem) {
4165         $taxRate = $taxRates[$params['financial_type_id']];
4166         $taxAmount = CRM_Contribute_BAO_Contribution_Utils::calculateTaxAmount($params['line_total'], $taxRate, $unknownIfMoneyIsClean);
4167         $params['tax_amount'] = round($taxAmount['tax_amount'], 2);
4168       }
4169     }
4170     return $params;
4171   }
4172
4173   /**
4174    * Check financial type validation on update of a contribution.
4175    *
4176    * @param Integer $financialTypeId
4177    *   Value of latest Financial Type.
4178    *
4179    * @param Integer $contributionId
4180    *   Contribution Id.
4181    *
4182    * @param array $errors
4183    *   List of errors.
4184    *
4185    * @return void
4186    */
4187   public static function checkFinancialTypeChange($financialTypeId, $contributionId, &$errors) {
4188     if (!empty($financialTypeId)) {
4189       $oldFinancialTypeId = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_Contribution', $contributionId, 'financial_type_id');
4190       if ($oldFinancialTypeId == $financialTypeId) {
4191         return;
4192       }
4193     }
4194     $sql = 'SELECT financial_type_id FROM civicrm_line_item WHERE contribution_id = %1 GROUP BY financial_type_id;';
4195     $params = array(
4196       '1' => array($contributionId, 'Integer'),
4197     );
4198     $result = CRM_Core_DAO::executeQuery($sql, $params);
4199     if ($result->N > 1) {
4200       $errors['financial_type_id'] = ts('One or more line items have a different financial type than the contribution. Editing the financial type is not yet supported in this situation.');
4201     }
4202   }
4203
4204   /**
4205    * Update related pledge payment payments.
4206    *
4207    * This function has been refactored out of the back office contribution form and may
4208    * still overlap with other functions.
4209    *
4210    * @param string $action
4211    * @param int $pledgePaymentID
4212    * @param int $contributionID
4213    * @param bool $adjustTotalAmount
4214    * @param float $total_amount
4215    * @param float $original_total_amount
4216    * @param int $contribution_status_id
4217    * @param int $original_contribution_status_id
4218    */
4219   public static function updateRelatedPledge(
4220     $action,
4221     $pledgePaymentID,
4222     $contributionID,
4223     $adjustTotalAmount,
4224     $total_amount,
4225     $original_total_amount,
4226     $contribution_status_id,
4227     $original_contribution_status_id
4228   ) {
4229     if (!$pledgePaymentID && $action & CRM_Core_Action::ADD && !$contributionID) {
4230       return;
4231     }
4232
4233     if ($pledgePaymentID) {
4234       //store contribution id in payment record.
4235       CRM_Core_DAO::setFieldValue('CRM_Pledge_DAO_PledgePayment', $pledgePaymentID, 'contribution_id', $contributionID);
4236     }
4237     else {
4238       $pledgePaymentID = CRM_Core_DAO::getFieldValue('CRM_Pledge_DAO_PledgePayment',
4239         $contributionID,
4240         'id',
4241         'contribution_id'
4242       );
4243     }
4244
4245     if (!$pledgePaymentID) {
4246       return;
4247     }
4248     $pledgeID = CRM_Core_DAO::getFieldValue('CRM_Pledge_DAO_PledgePayment',
4249       $contributionID,
4250       'pledge_id',
4251       'contribution_id'
4252     );
4253
4254     $updatePledgePaymentStatus = FALSE;
4255
4256     // If either the status or the amount has changed we update the pledge status.
4257     if ($action & CRM_Core_Action::ADD) {
4258       $updatePledgePaymentStatus = TRUE;
4259     }
4260     elseif ($action & CRM_Core_Action::UPDATE && (($original_contribution_status_id != $contribution_status_id) ||
4261         ($original_total_amount != $total_amount))
4262     ) {
4263       $updatePledgePaymentStatus = TRUE;
4264     }
4265
4266     if ($updatePledgePaymentStatus) {
4267       CRM_Pledge_BAO_PledgePayment::updatePledgePaymentStatus($pledgeID,
4268         array($pledgePaymentID),
4269         $contribution_status_id,
4270         NULL,
4271         $total_amount,
4272         $adjustTotalAmount
4273       );
4274     }
4275   }
4276
4277   /**
4278    * Compute the stats values
4279    *
4280    * @deprecated
4281    *
4282    * @param string $stat either 'mode' or 'median'
4283    * @param string $sql
4284    * @param string $alias of civicrm_contribution
4285    *
4286    * @return array|null
4287    */
4288   public static function computeStats($stat, $sql, $alias = NULL) {
4289     CRM_Core_Error::deprecatedFunctionWarning('computeStats is now deprecated');
4290     return [];
4291   }
4292
4293   /**
4294    * Is there only one line item attached to the contribution.
4295    *
4296    * @param int $id
4297    *   Contribution ID.
4298    *
4299    * @return bool
4300    * @throws \CiviCRM_API3_Exception
4301    */
4302   public static function isSingleLineItem($id) {
4303     $lineItemCount = civicrm_api3('LineItem', 'getcount', array('contribution_id' => $id));
4304     return ($lineItemCount == 1);
4305   }
4306
4307   /**
4308    * Complete an order.
4309    *
4310    * Do not call this directly - use the contribution.completetransaction api as this function is being refactored.
4311    *
4312    * Currently overloaded to complete a transaction & repeat a transaction - fix!
4313    *
4314    * Moving it out of the BaseIPN class is just the first step.
4315    *
4316    * @param array $input
4317    * @param array $ids
4318    * @param array $objects
4319    * @param CRM_Core_Transaction $transaction
4320    * @param int $recur
4321    * @param CRM_Contribute_BAO_Contribution $contribution
4322    *
4323    * @return array
4324    */
4325   public static function completeOrder(&$input, &$ids, $objects, $transaction, $recur, $contribution) {
4326     $primaryContributionID = isset($contribution->id) ? $contribution->id : $objects['first_contribution']->id;
4327     // The previous details are used when calculating line items so keep it before any code that 'does something'
4328     if (!empty($contribution->id)) {
4329       $input['prevContribution'] = CRM_Contribute_BAO_Contribution::getValues(array('id' => $contribution->id),
4330         CRM_Core_DAO::$_nullArray, CRM_Core_DAO::$_nullArray);
4331     }
4332     $inputContributionWhiteList = array(
4333       'fee_amount',
4334       'net_amount',
4335       'trxn_id',
4336       'check_number',
4337       'payment_instrument_id',
4338       'is_test',
4339       'campaign_id',
4340       'receive_date',
4341       'receipt_date',
4342       'contribution_status_id',
4343       'card_type_id',
4344       'pan_truncation',
4345     );
4346     if (self::isSingleLineItem($primaryContributionID)) {
4347       $inputContributionWhiteList[] = 'financial_type_id';
4348     }
4349
4350     $participant = CRM_Utils_Array::value('participant', $objects);
4351     $recurContrib = CRM_Utils_Array::value('contributionRecur', $objects);
4352     $recurringContributionID = (empty($recurContrib->id)) ? NULL : $recurContrib->id;
4353     $event = CRM_Utils_Array::value('event', $objects);
4354
4355     $paymentProcessorId = '';
4356     if (isset($objects['paymentProcessor'])) {
4357       if (is_array($objects['paymentProcessor'])) {
4358         $paymentProcessorId = $objects['paymentProcessor']['id'];
4359       }
4360       else {
4361         $paymentProcessorId = $objects['paymentProcessor']->id;
4362       }
4363     }
4364
4365     $completedContributionStatusID = CRM_Core_PseudoConstant::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Completed');
4366
4367     $contributionParams = array_merge(array(
4368       'contribution_status_id' => $completedContributionStatusID,
4369       'source' => self::getRecurringContributionDescription($contribution, $event),
4370     ), array_intersect_key($input, array_fill_keys($inputContributionWhiteList, 1)
4371     ));
4372
4373     // CRM-20678 Ensure that the currency is correct in subseqent transcations.
4374     if (empty($contributionParams['currency']) && isset($objects['first_contribution']->currency)) {
4375       $contributionParams['currency'] = $objects['first_contribution']->currency;
4376     }
4377
4378     $contributionParams['payment_processor'] = $input['payment_processor'] = $paymentProcessorId;
4379
4380     // If paymentProcessor is not set then the payment_instrument_id would not be correct.
4381     // not clear when or if this would occur if you encounter this please fix here & add a unit test.
4382     if (empty($contributionParams['payment_instrument_id']) && isset($contribution->_relatedObjects['paymentProcessor']['payment_instrument_id'])) {
4383       $contributionParams['payment_instrument_id'] = $contribution->_relatedObjects['paymentProcessor']['payment_instrument_id'];
4384     }
4385
4386     if ($recurringContributionID) {
4387       $contributionParams['contribution_recur_id'] = $recurringContributionID;
4388     }
4389     $changeDate = CRM_Utils_Array::value('trxn_date', $input, date('YmdHis'));
4390
4391     if (empty($contributionParams['receive_date']) && $changeDate) {
4392       $contributionParams['receive_date'] = $changeDate;
4393     }
4394
4395     self::repeatTransaction($contribution, $input, $contributionParams, $paymentProcessorId);
4396     $contributionParams['financial_type_id'] = $contribution->financial_type_id;
4397
4398     $values = array();
4399     if (isset($input['is_email_receipt'])) {
4400       $values['is_email_receipt'] = $input['is_email_receipt'];
4401     }
4402
4403     if ($input['component'] == 'contribute') {
4404       if ($contribution->contribution_page_id) {
4405         // Figure out what we gain from this.
4406         // Note that we may have overwritten the is_email_receipt input, fix that below.
4407         CRM_Contribute_BAO_ContributionPage::setValues($contribution->contribution_page_id, $values);
4408       }
4409       elseif ($recurContrib && $recurringContributionID) {
4410         $values['amount'] = $recurContrib->amount;
4411         $values['financial_type_id'] = $objects['contributionType']->id;
4412         $values['title'] = $source = ts('Offline Recurring Contribution');
4413       }
4414
4415       if (isset($input['is_email_receipt'])) {
4416         // CRM-19601 - we may have overwritten this above.
4417         $values['is_email_receipt'] = $input['is_email_receipt'];
4418       }
4419       elseif ($recurContrib && $recurringContributionID) {
4420         //CRM-13273 - is_email_receipt setting on recurring contribution should take precedence over contribution page setting
4421         // but CRM-16124 if $input['is_email_receipt'] is set then that should not be overridden.
4422         $values['is_email_receipt'] = $recurContrib->is_email_receipt;
4423       }
4424
4425       if ($contributionParams['contribution_status_id'] === $completedContributionStatusID) {
4426         self::updateMembershipBasedOnCompletionOfContribution(
4427           $contribution,
4428           $primaryContributionID,
4429           $changeDate
4430         );
4431       }
4432     }
4433     else {
4434       if (empty($input['IAmAHorribleNastyBeyondExcusableHackInTheCRMEventFORMTaskClassThatNeedsToBERemoved'])) {
4435         if ($event->is_email_confirm) {
4436           // @todo this should be set by the function that sends the mail after sending.
4437           $contributionParams['receipt_date'] = $changeDate;
4438         }
4439         $participantParams['id'] = $participant->id;
4440         $participantParams['status_id'] = 'Registered';
4441         civicrm_api3('Participant', 'create', $participantParams);
4442       }
4443     }
4444
4445     $contributionParams['id'] = $contribution->id;
4446
4447     // CRM-19309 - if you update the contribution here with financial_type_id it can/will mess with $lineItem
4448     // unsetting it here does NOT cause any other contribution test to fail!
4449     unset($contributionParams['financial_type_id']);
4450     $contributionResult = civicrm_api3('Contribution', 'create', $contributionParams);
4451
4452     // Add new soft credit against current $contribution.
4453     if (CRM_Utils_Array::value('contributionRecur', $objects) && $objects['contributionRecur']->id) {
4454       CRM_Contribute_BAO_ContributionRecur::addrecurSoftCredit($objects['contributionRecur']->id, $contribution->id);
4455     }
4456
4457     $contributionStatuses = CRM_Core_PseudoConstant::get('CRM_Contribute_DAO_Contribution', 'contribution_status_id', array(
4458       'labelColumn' => 'name',
4459       'flip' => 1,
4460     ));
4461     if (isset($input['prevContribution']) && (!$input['prevContribution']->is_pay_later && $input['prevContribution']->contribution_status_id == $contributionStatuses['Pending'])) {
4462       $input['payment_processor'] = $paymentProcessorId;
4463     }
4464
4465     if (!empty($contribution->_relatedObjects['participant'])) {
4466       $input['contribution_mode'] = 'participant';
4467       $input['participant_id'] = $contribution->_relatedObjects['participant']->id;
4468     }
4469     elseif (!empty($contribution->_relatedObjects['membership'])) {
4470       $input['contribution_mode'] = 'membership';
4471       $contribution->contribution_status_id = $contributionParams['contribution_status_id'];
4472       $contribution->trxn_id = CRM_Utils_Array::value('trxn_id', $input);
4473       $contribution->receive_date = CRM_Utils_Date::isoToMysql($contribution->receive_date);
4474     }
4475
4476     CRM_Core_Error::debug_log_message("Contribution record updated successfully");
4477     $transaction->commit();
4478
4479     CRM_Contribute_BAO_ContributionRecur::updateRecurLinkedPledge($contribution->id, $recurringContributionID,
4480       $contributionParams['contribution_status_id'], $input['amount']);
4481
4482     // create an activity record
4483     if ($input['component'] == 'contribute') {
4484       //CRM-4027
4485       $targetContactID = NULL;
4486       if (!empty($ids['related_contact'])) {
4487         $targetContactID = $contribution->contact_id;
4488         $contribution->contact_id = $ids['related_contact'];
4489       }
4490       CRM_Activity_BAO_Activity::addActivity($contribution, NULL, $targetContactID);
4491     }
4492
4493     // CRM-9132 legacy behaviour was that receipts were sent out in all instances. Still sending
4494     // when array_key 'is_email_receipt doesn't exist in case some instances where is needs setting haven't been set
4495     if (!array_key_exists('is_email_receipt', $values) ||
4496       $values['is_email_receipt'] == 1
4497     ) {
4498       civicrm_api3('Contribution', 'sendconfirmation', array(
4499         'id' => $contribution->id,
4500         'payment_processor_id' => $paymentProcessorId,
4501       ));
4502       CRM_Core_Error::debug_log_message("Receipt sent");
4503     }
4504
4505     CRM_Core_Error::debug_log_message("Success: Database updated");
4506     return $contributionResult;
4507   }
4508
4509   /**
4510    * Send receipt from contribution.
4511    *
4512    * Do not call this directly - it is being refactored. use contribution.sendmessage api call.
4513    *
4514    * Note that the compose message part has been moved to contribution
4515    * In general LoadObjects is called first to get the objects but the composeMessageArray function now calls it.
4516    *
4517    * @param array $input
4518    *   Incoming data from Payment processor.
4519    * @param array $ids
4520    *   Related object IDs.
4521    * @param int $contributionID
4522    * @param array $values
4523    *   Values related to objects that have already been loaded.
4524    * @param bool $returnMessageText
4525    *   Should text be returned instead of sent. This.
4526    *   is because the function is also used to generate pdfs
4527    *
4528    * @return array
4529    * @throws \CRM_Core_Exception
4530    * @throws \CiviCRM_API3_Exception
4531    */
4532   public static function sendMail(&$input, &$ids, $contributionID, &$values,
4533                                   $returnMessageText = FALSE) {
4534
4535     $contribution = new CRM_Contribute_BAO_Contribution();
4536     $contribution->id = $contributionID;
4537     if (!$contribution->find(TRUE)) {
4538       throw new CRM_Core_Exception('Contribution does not exist');
4539     }
4540     $contribution->loadRelatedObjects($input, $ids, TRUE);
4541     // set receipt from e-mail and name in value
4542     if (!$returnMessageText) {
4543       list($values['receipt_from_name'], $values['receipt_from_email']) = self::generateFromEmailAndName($input, $contribution);
4544     }
4545     $values['contribution_status'] = CRM_Core_PseudoConstant::getLabel('CRM_Contribute_BAO_Contribution', 'contribution_status_id', $contribution->contribution_status_id);
4546     $return = $contribution->composeMessageArray($input, $ids, $values, $returnMessageText);
4547     if ((!isset($input['receipt_update']) || $input['receipt_update']) && empty($contribution->receipt_date)) {
4548       civicrm_api3('Contribution', 'create', array('receipt_date' => 'now', 'id' => $contribution->id));
4549     }
4550     return $return;
4551   }
4552
4553   /**
4554    * Generate From email and from name in an array values
4555    * @param array $input
4556    * @param \CRM_Contribute_BAO_Contribution $contribution
4557    * @return array
4558    */
4559   public static function generateFromEmailAndName($input, $contribution) {
4560     // Use input value if supplied.
4561     if (!empty($input['receipt_from_email'])) {
4562       return array(CRM_Utils_array::value('receipt_from_name', $input, ''), $input['receipt_from_email']);
4563     }
4564     // if we are still empty see if we can use anything from a contribution page.
4565     $pageValues = array();
4566     if (!empty($contribution->contribution_page_id)) {
4567       $pageValues = civicrm_api3('ContributionPage', 'getsingle', array('id' => $contribution->contribution_page_id));
4568     }
4569     // if we are still empty see if we can use anything from a contribution page.
4570     if (!empty($pageValues['receipt_from_email'])) {
4571       return array($pageValues['receipt_from_name'], $pageValues['receipt_from_email']);
4572     }
4573     // If we are still empty fall back to the domain or logged in user information.
4574     return CRM_Core_BAO_Domain::getDefaultReceiptFrom();
4575   }
4576
4577   /**
4578    * Generate credit note id with next avaible number
4579    *
4580    * @return string
4581    *   Credit Note Id.
4582    */
4583   public static function createCreditNoteId() {
4584     $prefixValue = Civi::settings()->get('contribution_invoice_settings');
4585
4586     $creditNoteNum = CRM_Core_DAO::singleValueQuery("SELECT count(creditnote_id) as creditnote_number FROM civicrm_contribution WHERE creditnote_id IS NOT NULL");
4587     $creditNoteId = NULL;
4588
4589     do {
4590       $creditNoteNum++;
4591       $creditNoteId = CRM_Utils_Array::value('credit_notes_prefix', $prefixValue) . "" . $creditNoteNum;
4592       $result = civicrm_api3('Contribution', 'getcount', array(
4593         'sequential' => 1,
4594         'creditnote_id' => $creditNoteId,
4595       ));
4596     } while ($result > 0);
4597
4598     return $creditNoteId;
4599   }
4600
4601   /**
4602    * Load related memberships.
4603    *
4604    * Note that in theory it should be possible to retrieve these from the line_item table
4605    * with the membership_payment table being deprecated. Attempting to do this here causes tests to fail
4606    * as it seems the api is not correctly linking the line items when the contribution is created in the flow
4607    * where the contribution is created in the API, followed by the membership (using the api) followed by the membership
4608    * payment. The membership payment BAO does have code to address this but it doesn't appear to be working.
4609    *
4610    * I don't know if it never worked or broke as a result of https://issues.civicrm.org/jira/browse/CRM-14918.
4611    *
4612    * @param array $ids
4613    *
4614    * @return array $ids
4615    *
4616    * @throws Exception
4617    */
4618   public function loadRelatedMembershipObjects($ids = []) {
4619     $query = "
4620       SELECT membership_id
4621       FROM   civicrm_membership_payment
4622       WHERE  contribution_id = %1 ";
4623     $params = array(1 => array($this->id, 'Integer'));
4624     $ids['membership'] = (array) CRM_Utils_Array::value('membership', $ids, array());
4625
4626     $dao = CRM_Core_DAO::executeQuery($query, $params);
4627     while ($dao->fetch()) {
4628       if ($dao->membership_id && !in_array($dao->membership_id, $ids['membership'])) {
4629         $ids['membership'][$dao->membership_id] = $dao->membership_id;
4630       }
4631     }
4632
4633     if (array_key_exists('membership', $ids) && is_array($ids['membership'])) {
4634       foreach ($ids['membership'] as $id) {
4635         if (!empty($id)) {
4636           $membership = new CRM_Member_BAO_Membership();
4637           $membership->id = $id;
4638           if (!$membership->find(TRUE)) {
4639             throw new Exception("Could not find membership record: $id");
4640           }
4641           $membership->join_date = CRM_Utils_Date::isoToMysql($membership->join_date);
4642           $membership->start_date = CRM_Utils_Date::isoToMysql($membership->start_date);
4643           $membership->end_date = CRM_Utils_Date::isoToMysql($membership->end_date);
4644           $this->_relatedObjects['membership'][$membership->membership_type_id] = $membership;
4645           $membership->free();
4646         }
4647       }
4648     }
4649     return $ids;
4650   }
4651
4652   /**
4653    * This function is used to record partial payments for contribution
4654    *
4655    * @param array $contribution
4656    *
4657    * @param array $params
4658    *
4659    * @return CRM_Financial_DAO_FinancialTrxn
4660    */
4661   public static function recordPartialPayment($contribution, $params) {
4662     $contributionStatuses = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');
4663     $pendingStatus = array(
4664       array_search('Pending', $contributionStatuses),
4665       array_search('In Progress', $contributionStatuses),
4666     );
4667     $statusId = array_search('Completed', $contributionStatuses);
4668     if (in_array(CRM_Utils_Array::value('contribution_status_id', $contribution), $pendingStatus)) {
4669       $balanceTrxnParams['to_financial_account_id'] = CRM_Contribute_PseudoConstant::getRelationalFinancialAccount($contribution['financial_type_id'], 'Accounts Receivable Account is');
4670     }
4671     elseif (!empty($params['payment_processor'])) {
4672       $balanceTrxnParams['to_financial_account_id'] = CRM_Contribute_PseudoConstant::getRelationalFinancialAccount($contribution['payment_processor'], NULL, 'civicrm_payment_processor');
4673     }
4674     elseif (!empty($params['payment_instrument_id'])) {
4675       $balanceTrxnParams['to_financial_account_id'] = CRM_Financial_BAO_FinancialTypeAccount::getInstrumentFinancialAccount($contribution['payment_instrument_id']);
4676     }
4677     else {
4678       $relationTypeId = key(CRM_Core_PseudoConstant::accountOptionValues('financial_account_type', NULL, " AND v.name LIKE 'Asset' "));
4679       $queryParams = array(1 => array($relationTypeId, 'Integer'));
4680       $balanceTrxnParams['to_financial_account_id'] = CRM_Core_DAO::singleValueQuery("SELECT id FROM civicrm_financial_account WHERE is_default = 1 AND financial_account_type_id = %1", $queryParams);
4681     }
4682     $fromFinancialAccountId = CRM_Contribute_PseudoConstant::getRelationalFinancialAccount($contribution['financial_type_id'], 'Accounts Receivable Account is');
4683     $balanceTrxnParams['from_financial_account_id'] = $fromFinancialAccountId;
4684     $balanceTrxnParams['total_amount'] = $params['total_amount'];
4685     $balanceTrxnParams['contribution_id'] = $params['contribution_id'];
4686     $balanceTrxnParams['trxn_date'] = CRM_Utils_Array::value('trxn_date', $params, CRM_Utils_Array::value('contribution_receive_date', $params, date('YmdHis')));
4687     $balanceTrxnParams['fee_amount'] = CRM_Utils_Array::value('fee_amount', $params);
4688     $balanceTrxnParams['net_amount'] = CRM_Utils_Array::value('total_amount', $params);
4689     $balanceTrxnParams['currency'] = $contribution['currency'];
4690     $balanceTrxnParams['trxn_id'] = CRM_Utils_Array::value('contribution_trxn_id', $params, NULL);
4691     $balanceTrxnParams['status_id'] = $statusId;
4692     $balanceTrxnParams['payment_instrument_id'] = CRM_Utils_Array::value('payment_instrument_id', $params, $contribution['payment_instrument_id']);
4693     $balanceTrxnParams['check_number'] = CRM_Utils_Array::value('check_number', $params);
4694     if ($fromFinancialAccountId != NULL &&
4695       ($statusId == array_search('Completed', $contributionStatuses) || $statusId == array_search('Partially paid', $contributionStatuses))
4696     ) {
4697       $balanceTrxnParams['is_payment'] = 1;
4698     }
4699     if (!empty($params['payment_processor'])) {
4700       $balanceTrxnParams['payment_processor_id'] = $params['payment_processor'];
4701     }
4702     return CRM_Core_BAO_FinancialTrxn::create($balanceTrxnParams);
4703   }
4704
4705   /**
4706    * Get the description (source field) for the recurring contribution.
4707    *
4708    * @param CRM_Contribute_BAO_Contribution $contribution
4709    * @param CRM_Event_DAO_Event|null $event
4710    *
4711    * @return string
4712    * @throws \CiviCRM_API3_Exception
4713    */
4714   protected static function getRecurringContributionDescription($contribution, $event) {
4715     if (!empty($contribution->source)) {
4716       return $contribution->source;
4717     }
4718     elseif (!empty($contribution->contribution_page_id) && is_numeric($contribution->contribution_page_id)) {
4719       $contributionPageTitle = civicrm_api3('ContributionPage', 'getvalue', array(
4720         'id' => $contribution->contribution_page_id,
4721         'return' => 'title',
4722       ));
4723       return ts('Online Contribution') . ': ' . $contributionPageTitle;
4724     }
4725     elseif ($event) {
4726       return ts('Online Event Registration') . ': ' . $event->title;
4727     }
4728     elseif (!empty($contribution->contribution_recur_id)) {
4729       return 'recurring contribution';
4730     }
4731     return '';
4732   }
4733
4734   /**
4735    * Function to add payments for contribution
4736    * for Partially Paid status
4737    *
4738    * @param array $contributions
4739    * @param string $contributionStatusId
4740    *
4741    */
4742   public static function addPayments($contributions, $contributionStatusId = NULL) {
4743     // get financial trxn which is a payment
4744     $ftSql = "SELECT ft.id, ft.total_amount
4745       FROM civicrm_financial_trxn ft
4746       INNER JOIN civicrm_entity_financial_trxn eft ON eft.financial_trxn_id = ft.id AND eft.entity_table = 'civicrm_contribution'
4747       WHERE eft.entity_id = %1 AND ft.is_payment = 1 ORDER BY ft.id DESC LIMIT 1";
4748     $contributionStatus = CRM_Core_PseudoConstant::get('CRM_Contribute_DAO_Contribution', 'contribution_status_id', array(
4749       'labelColumn' => 'name',
4750     ));
4751     foreach ($contributions as $contribution) {
4752       if (!($contributionStatus[$contribution->contribution_status_id] == 'Partially paid'
4753         || CRM_Utils_Array::value($contributionStatusId, $contributionStatus) == 'Partially paid')
4754       ) {
4755         continue;
4756       }
4757       $ftDao = CRM_Core_DAO::executeQuery($ftSql, array(1 => array($contribution->id, 'Integer')));
4758       $ftDao->fetch();
4759
4760       // store financial item Proportionaly.
4761       $trxnParams = array(
4762         'total_amount' => $ftDao->total_amount,
4763         'contribution_id' => $contribution->id,
4764       );
4765       self::assignProportionalLineItems($trxnParams, $ftDao->id, $contribution->total_amount);
4766     }
4767   }
4768
4769   /**
4770    * Function use to store line item proportionaly in
4771    * in entity financial trxn table
4772    *
4773    * @param array $trxnParams
4774    *
4775    * @param Integer $trxnId
4776    *
4777    * @param float $contributionTotalAmount
4778    *
4779    */
4780   public static function assignProportionalLineItems($trxnParams, $trxnId, $contributionTotalAmount) {
4781     $lineItems = CRM_Price_BAO_LineItem::getLineItemsByContributionID($trxnParams['contribution_id']);
4782     if (!empty($lineItems)) {
4783       // get financial item
4784       list($ftIds, $taxItems) = self::getLastFinancialItemIds($trxnParams['contribution_id']);
4785       $entityParams = array(
4786         'contribution_total_amount' => $contributionTotalAmount,
4787         'trxn_total_amount' => $trxnParams['total_amount'],
4788         'trxn_id' => $trxnId,
4789       );
4790       self::createProportionalFinancialEntries($entityParams, $lineItems, $ftIds, $taxItems);
4791     }
4792   }
4793
4794   /**
4795    * Checks if line items total amounts
4796    * match the contribution total amount.
4797    *
4798    * @param array $params
4799    *  array of order params.
4800    *
4801    * @throws \API_Exception
4802    */
4803   public static function checkLineItems(&$params) {
4804     $totalAmount = CRM_Utils_Array::value('total_amount', $params);
4805     $lineItemAmount = 0;
4806
4807     foreach ($params['line_items'] as &$lineItems) {
4808       foreach ($lineItems['line_item'] as &$item) {
4809         if (empty($item['financial_type_id'])) {
4810           $item['financial_type_id'] = $params['financial_type_id'];
4811         }
4812         $lineItemAmount += $item['line_total'] + CRM_Utils_Array::value('tax_amount', $item, 0.00);
4813       }
4814     }
4815
4816     if (!isset($totalAmount)) {
4817       $params['total_amount'] = $lineItemAmount;
4818     }
4819     else {
4820       $currency = CRM_Utils_Array::value('currency', $params, '');
4821
4822       if (empty($currency)) {
4823         $currency = CRM_Core_Config::singleton()->defaultCurrency;
4824       }
4825
4826       if (!CRM_Utils_Money::equals($totalAmount, $lineItemAmount, $currency)) {
4827         throw new CRM_Contribute_Exception_CheckLineItemsException();
4828       }
4829     }
4830   }
4831
4832   /**
4833    * Get the financial account for the item associated with the new transaction.
4834    *
4835    * @param array $params
4836    * @param int $default
4837    *
4838    * @return int
4839    */
4840   public static function getFinancialAccountForStatusChangeTrxn($params, $default) {
4841
4842     if (!empty($params['financial_account_id'])) {
4843       return $params['financial_account_id'];
4844     }
4845
4846     $contributionStatus = CRM_Contribute_PseudoConstant::contributionStatus($params['contribution_status_id'], 'name');
4847     $preferredAccountsRelationships = array(
4848       'Refunded' => 'Credit/Contra Revenue Account is',
4849       'Chargeback' => 'Chargeback Account is',
4850     );
4851
4852     if (in_array($contributionStatus, array_keys($preferredAccountsRelationships))) {
4853       $financialTypeID = !empty($params['financial_type_id']) ? $params['financial_type_id'] : $params['prevContribution']->financial_type_id;
4854       return CRM_Financial_BAO_FinancialAccount::getFinancialAccountForFinancialTypeByRelationship(
4855         $financialTypeID,
4856         $preferredAccountsRelationships[$contributionStatus]
4857       );
4858     }
4859
4860     return $default;
4861   }
4862
4863   /**
4864    * ContributionPage values were being imposed onto values.
4865    *
4866    * I have made this explicit and removed the couple (is_recur, is_pay_later) we
4867    * REALLY didn't want superimposed. The rest are left there in their overkill out
4868    * of cautiousness.
4869    *
4870    * The rationale for making this explicit is that it was a case of carefully set values being
4871    * seemingly randonly overwritten without much care. In general I think array randomly setting
4872    * variables en mass is risky.
4873    *
4874    * @param array $values
4875    *
4876    * @return array
4877    */
4878   protected function addContributionPageValuesToValuesHeavyHandedly(&$values) {
4879     $contributionPageValues = array();
4880     CRM_Contribute_BAO_ContributionPage::setValues(
4881       $this->contribution_page_id,
4882       $contributionPageValues
4883     );
4884     $valuesToCopy = array(
4885       // These are the values that I believe to be useful.
4886       'id',
4887       'title',
4888       'pay_later_receipt',
4889       'pay_later_text',
4890       'receipt_from_email',
4891       'receipt_from_name',
4892       'receipt_text',
4893       'custom_pre_id',
4894       'custom_post_id',
4895       'honoree_profile_id',
4896       'onbehalf_profile_id',
4897       'honor_block_is_active',
4898       // Kinda might be - but would be on the contribution...
4899       'campaign_id',
4900       'currency',
4901       // Included for 'fear of regression' but can't justify any use for these....
4902       'intro_text',
4903       'payment_processor',
4904       'financial_type_id',
4905       'amount_block_is_active',
4906       'bcc_receipt',
4907       'cc_receipt',
4908       'created_date',
4909       'created_id',
4910       'default_amount_id',
4911       'end_date',
4912       'footer_text',
4913       'goal_amount',
4914       'initial_amount_help_text',
4915       'initial_amount_label',
4916       'intro_text',
4917       'is_allow_other_amount',
4918       'is_billing_required',
4919       'is_confirm_enabled',
4920       'is_credit_card_only',
4921       'is_monetary',
4922       'is_partial_payment',
4923       'is_recur_installments',
4924       'is_recur_interval',
4925       'is_share',
4926       'max_amount',
4927       'min_amount',
4928       'min_initial_amount',
4929       'recur_frequency_unit',
4930       'start_date',
4931       'thankyou_footer',
4932       'thankyou_text',
4933       'thankyou_title',
4934
4935     );
4936     foreach ($valuesToCopy as $valueToCopy) {
4937       if (isset($contributionPageValues[$valueToCopy])) {
4938         $values[$valueToCopy] = $contributionPageValues[$valueToCopy];
4939       }
4940     }
4941     return $values;
4942   }
4943
4944   /**
4945    * Get values of CiviContribute Settings
4946    * and check if its enabled or not.
4947    * Note: The CiviContribute settings are stored as single entry in civicrm_setting
4948    * in serialized form. Usually this should be stored as flat settings for each form fields
4949    * as per CiviCRM standards. Since this would take more effort to change the current behaviour of CiviContribute
4950    * settings we will live with an inconsistency because it's too hard to change for now.
4951    * https://github.com/civicrm/civicrm-core/pull/8562#issuecomment-227874245
4952    *
4953    *
4954    * @param string $name
4955    * @param bool $checkInvoicing
4956    * @return string
4957    *
4958    */
4959   public static function checkContributeSettings($name = NULL, $checkInvoicing = FALSE) {
4960     $contributeSettings = Civi::settings()->get('contribution_invoice_settings');
4961
4962     if ($checkInvoicing && !CRM_Utils_Array::value('invoicing', $contributeSettings)) {
4963       return NULL;
4964     }
4965
4966     if ($name) {
4967       return CRM_Utils_Array::value($name, $contributeSettings);
4968     }
4969     return $contributeSettings;
4970   }
4971
4972   /**
4973    * This function process contribution related objects.
4974    *
4975    * @param int $contributionId
4976    * @param int $statusId
4977    * @param int|null $previousStatusId
4978    *
4979    * @param string $receiveDate
4980    *
4981    * @return null|string
4982    */
4983   public static function transitionComponentWithReturnMessage($contributionId, $statusId, $previousStatusId = NULL, $receiveDate = NULL) {
4984     $statusMsg = NULL;
4985     if (!$contributionId || !$statusId) {
4986       return $statusMsg;
4987     }
4988
4989     $params = array(
4990       'contribution_id' => $contributionId,
4991       'contribution_status_id' => $statusId,
4992       'previous_contribution_status_id' => $previousStatusId,
4993       'receive_date' => $receiveDate,
4994     );
4995
4996     $updateResult = CRM_Contribute_BAO_Contribution::transitionComponents($params);
4997
4998     if (!is_array($updateResult) ||
4999       !($updatedComponents = CRM_Utils_Array::value('updatedComponents', $updateResult)) ||
5000       !is_array($updatedComponents) ||
5001       empty($updatedComponents)
5002     ) {
5003       return $statusMsg;
5004     }
5005
5006     // get the user display name.
5007     $sql = "
5008    SELECT  display_name as displayName
5009      FROM  civicrm_contact
5010 LEFT JOIN  civicrm_contribution on (civicrm_contribution.contact_id = civicrm_contact.id )
5011     WHERE  civicrm_contribution.id = {$contributionId}";
5012     $userDisplayName = CRM_Core_DAO::singleValueQuery($sql);
5013
5014     // get the status message for user.
5015     foreach ($updatedComponents as $componentName => $updatedStatusId) {
5016
5017       if ($componentName == 'CiviMember') {
5018         $updatedStatusName = CRM_Utils_Array::value($updatedStatusId,
5019           CRM_Member_PseudoConstant::membershipStatus()
5020         );
5021         if ($updatedStatusName == 'Cancelled') {
5022           $statusMsg .= "<br />" . ts("Membership for %1 has been Cancelled.", array(1 => $userDisplayName));
5023         }
5024         elseif ($updatedStatusName == 'Expired') {
5025           $statusMsg .= "<br />" . ts("Membership for %1 has been Expired.", array(1 => $userDisplayName));
5026         }
5027         else {
5028           $endDate = CRM_Utils_Array::value('membership_end_date', $updateResult);
5029           if ($endDate) {
5030             $statusMsg .= "<br />" . ts("Membership for %1 has been updated. The membership End Date is %2.",
5031                 array(
5032                   1 => $userDisplayName,
5033                   2 => $endDate,
5034                 )
5035               );
5036           }
5037         }
5038       }
5039
5040       if ($componentName == 'CiviEvent') {
5041         $updatedStatusName = CRM_Utils_Array::value($updatedStatusId,
5042           CRM_Event_PseudoConstant::participantStatus()
5043         );
5044         if ($updatedStatusName == 'Cancelled') {
5045           $statusMsg .= "<br />" . ts("Event Registration for %1 has been Cancelled.", array(1 => $userDisplayName));
5046         }
5047         elseif ($updatedStatusName == 'Registered') {
5048           $statusMsg .= "<br />" . ts("Event Registration for %1 has been updated.", array(1 => $userDisplayName));
5049         }
5050       }
5051
5052       if ($componentName == 'CiviPledge') {
5053         $updatedStatusName = CRM_Utils_Array::value($updatedStatusId,
5054           CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name')
5055         );
5056         if ($updatedStatusName == 'Cancelled') {
5057           $statusMsg .= "<br />" . ts("Pledge Payment for %1 has been Cancelled.", array(1 => $userDisplayName));
5058         }
5059         elseif ($updatedStatusName == 'Failed') {
5060           $statusMsg .= "<br />" . ts("Pledge Payment for %1 has been Failed.", array(1 => $userDisplayName));
5061         }
5062         elseif ($updatedStatusName == 'Completed') {
5063           $statusMsg .= "<br />" . ts("Pledge Payment for %1 has been updated.", array(1 => $userDisplayName));
5064         }
5065       }
5066     }
5067
5068     return $statusMsg;
5069   }
5070
5071   /**
5072    * Get the contribution as it is in the database before being updated.
5073    *
5074    * @param int $contributionID
5075    *
5076    * @return \CRM_Contribute_BAO_Contribution|null
5077    */
5078   private static function getOriginalContribution($contributionID) {
5079     return self::getValues(array('id' => $contributionID), CRM_Core_DAO::$_nullArray, CRM_Core_DAO::$_nullArray);
5080   }
5081
5082   /**
5083    * Get the amount for the financial item row.
5084    *
5085    * Helper function to start to break down recordFinancialTransactions for readability.
5086    *
5087    * The logic is more historical than .. logical. Paths other than the deprecated one are tested.
5088    *
5089    * Codewise, several somewhat disimmilar things have been squished into recordFinancialAccounts
5090    * for historical reasons. Going forwards we can hope to add tests & improve readibility
5091    * of that function
5092    *
5093    * @todo move recordFinancialAccounts & helper functions to their own class?
5094    *
5095    * @param array $params
5096    *   Params as passed to contribution.create
5097    *
5098    * @param string $context
5099    *   changeFinancialType| changedAmount
5100    * @param array $lineItemDetails
5101    *   Line items.
5102    * @param bool $isARefund
5103    *   Is this a refund / negative transaction.
5104    *
5105    * @return float
5106    */
5107   protected static function getFinancialItemAmountFromParams($params, $context, $lineItemDetails, $isARefund, $previousLineItemTotal) {
5108     if ($context == 'changedAmount') {
5109       $lineTotal = $lineItemDetails['line_total'];
5110       if ($lineTotal != $previousLineItemTotal) {
5111         $lineTotal -= $previousLineItemTotal;
5112       }
5113       return $lineTotal;
5114     }
5115     elseif ($context == 'changeFinancialType') {
5116       return -$lineItemDetails['line_total'];
5117     }
5118     elseif ($context == 'changedStatus') {
5119       $cancelledTaxAmount = 0;
5120       if ($isARefund) {
5121         $cancelledTaxAmount = CRM_Utils_Array::value('tax_amount', $lineItemDetails, '0.00');
5122       }
5123       return self::getMultiplier($params['contribution']->contribution_status_id, $context) * ((float) $lineItemDetails['line_total'] + (float) $cancelledTaxAmount);
5124     }
5125     elseif ($context === NULL) {
5126       // erm, yes because? but, hey, it's tested.
5127       return $lineItemDetails['line_total'];
5128     }
5129     elseif (empty($lineItemDetails['line_total'])) {
5130       // follow legacy code path
5131       Civi::log()
5132         ->warning('Deprecated bit of code, please log a ticket explaining how you got here!', array('civi.tag' => 'deprecated'));
5133       return $params['total_amount'];
5134     }
5135     else {
5136       return self::getMultiplier($params['contribution']->contribution_status_id, $context) * ((float) $lineItemDetails['line_total']);
5137     }
5138   }
5139
5140   /**
5141    * Get the multiplier for adjusting rows.
5142    *
5143    * If we are dealing with a refund or cancellation then it will be a negative
5144    * amount to reflect the negative transaction.
5145    *
5146    * If we are changing Financial Type it will be a negative amount to
5147    * adjust down the old type.
5148    *
5149    * @param int $contribution_status_id
5150    * @param string $context
5151    *
5152    * @return int
5153    */
5154   protected static function getMultiplier($contribution_status_id, $context) {
5155     if ($context == 'changeFinancialType' || self::isContributionStatusNegative($contribution_status_id)) {
5156       return -1;
5157     }
5158     return 1;
5159   }
5160
5161   /**
5162    * Does this transaction reflect a payment instrument change.
5163    *
5164    * @param array $params
5165    * @param array $pendingStatuses
5166    *
5167    * @return bool
5168    */
5169   protected static function isPaymentInstrumentChange(&$params, $pendingStatuses) {
5170     $contributionStatus = CRM_Core_PseudoConstant::getName('CRM_Contribute_BAO_Contribution', 'contribution_status_id', $params['contribution']->contribution_status_id);
5171
5172     if (array_key_exists('payment_instrument_id', $params)) {
5173       if (CRM_Utils_System::isNull($params['prevContribution']->payment_instrument_id) &&
5174         !CRM_Utils_System::isNull($params['payment_instrument_id'])
5175       ) {
5176         //check if status is changed from Pending to Completed
5177         // do not update payment instrument changes for Pending to Completed
5178         if (!($contributionStatus == 'Completed' &&
5179           in_array($params['prevContribution']->contribution_status_id, $pendingStatuses))
5180         ) {
5181           return TRUE;
5182         }
5183       }
5184       elseif ((!CRM_Utils_System::isNull($params['payment_instrument_id']) &&
5185           !CRM_Utils_System::isNull($params['prevContribution']->payment_instrument_id)) &&
5186         $params['payment_instrument_id'] != $params['prevContribution']->payment_instrument_id
5187       ) {
5188         return TRUE;
5189       }
5190       elseif (!CRM_Utils_System::isNull($params['contribution']->check_number) &&
5191         $params['contribution']->check_number != $params['prevContribution']->check_number
5192       ) {
5193         // another special case when check number is changed, create new financial records
5194         // create financial trxn with negative amount
5195         return TRUE;
5196       }
5197     }
5198     return FALSE;
5199   }
5200
5201   /**
5202    * Update the memberships associated with a contribution if it has been completed.
5203    *
5204    * Note that the way in which $memberships are loaded as objects is pretty messy & I think we could just
5205    * load them in this function. Code clean up would compensate for any minor performance implication.
5206    *
5207    * @param \CRM_Contribute_BAO_Contribution $contribution
5208    * @param int $primaryContributionID
5209    * @param string $changeDate
5210    *
5211    * @throws \CRM_Core_Exception
5212    * @throws \CiviCRM_API3_Exception
5213    */
5214   public static function updateMembershipBasedOnCompletionOfContribution($contribution, $primaryContributionID, $changeDate) {
5215     $contribution->loadRelatedMembershipObjects();
5216     if (empty($contribution->_relatedObjects['membership'])) {
5217       return;
5218     }
5219     $memberships = $contribution->_relatedObjects['membership'];
5220     foreach ($memberships as $membershipTypeIdKey => $membership) {
5221       if ($membership) {
5222         $membershipParams = array(
5223           'id' => $membership->id,
5224           'contact_id' => $membership->contact_id,
5225           'is_test' => $membership->is_test,
5226           'membership_type_id' => $membership->membership_type_id,
5227           'membership_activity_status' => 'Completed',
5228         );
5229
5230         $currentMembership = CRM_Member_BAO_Membership::getContactMembership($membershipParams['contact_id'],
5231           $membershipParams['membership_type_id'],
5232           $membershipParams['is_test'],
5233           $membershipParams['id']
5234         );
5235
5236         // CRM-8141 update the membership type with the value recorded in log when membership created/renewed
5237         // this picks up membership type changes during renewals
5238         // @todo this is almost certainly an obsolete sql call, the pre-change
5239         // membership is accessible via $this->_relatedObjects
5240         $sql = "
5241 SELECT    membership_type_id
5242 FROM      civicrm_membership_log
5243 WHERE     membership_id={$membershipParams['id']}
5244 ORDER BY  id DESC
5245 LIMIT 1;";
5246         $dao = CRM_Core_DAO::executeQuery($sql);
5247         if ($dao->fetch()) {
5248           if (!empty($dao->membership_type_id)) {
5249             $membershipParams['membership_type_id'] = $dao->membership_type_id;
5250           }
5251         }
5252         $dao->free();
5253
5254         $membershipParams['num_terms'] = $contribution->getNumTermsByContributionAndMembershipType(
5255           $membershipParams['membership_type_id'],
5256           $primaryContributionID
5257         );
5258         // @todo remove all this stuff in favour of letting the api call further down handle in
5259         // (it is a duplication of what the api does).
5260         $dates = array_fill_keys(array(
5261           'join_date',
5262           'start_date',
5263           'end_date',
5264         ), NULL);
5265         if ($currentMembership) {
5266           /*
5267            * Fixed FOR CRM-4433
5268            * In BAO/Membership.php(renewMembership function), we skip the extend membership date and status
5269            * when Contribution mode is notify and membership is for renewal )
5270            */
5271           CRM_Member_BAO_Membership::fixMembershipStatusBeforeRenew($currentMembership, $changeDate);
5272
5273           // @todo - we should pass membership_type_id instead of null here but not
5274           // adding as not sure of testing
5275           $dates = CRM_Member_BAO_MembershipType::getRenewalDatesForMembershipType($membershipParams['id'],
5276             $changeDate, NULL, $membershipParams['num_terms']
5277           );
5278           $dates['join_date'] = $currentMembership['join_date'];
5279         }
5280
5281         //get the status for membership.
5282         $calcStatus = CRM_Member_BAO_MembershipStatus::getMembershipStatusByDate($dates['start_date'],
5283           $dates['end_date'],
5284           $dates['join_date'],
5285           'today',
5286           TRUE,
5287           $membershipParams['membership_type_id'],
5288           $membershipParams
5289         );
5290
5291         unset($dates['end_date']);
5292         $membershipParams['status_id'] = CRM_Utils_Array::value('id', $calcStatus, 'New');
5293         //we might be renewing membership,
5294         //so make status override false.
5295         $membershipParams['is_override'] = FALSE;
5296         $membershipParams['status_override_end_date'] = 'null';
5297
5298         //CRM-17723 - reset static $relatedContactIds array()
5299         // @todo move it to Civi Statics.
5300         $var = TRUE;
5301         CRM_Member_BAO_Membership::createRelatedMemberships($var, $var, TRUE);
5302         civicrm_api3('Membership', 'create', $membershipParams);
5303       }
5304     }
5305   }
5306
5307   /**
5308    * Get payment links as they relate to a contribution.
5309    *
5310    * If a payment can be made then include a payment link & if a refund is appropriate
5311    * then a refund link.
5312    *
5313    * @param int $id
5314    * @param float $balance
5315    * @param string $contributionStatus
5316    *
5317    * @return array $actionLinks Links array containing:
5318    *   -url
5319    *   -title
5320    */
5321   protected static function getContributionPaymentLinks($id, $balance, $contributionStatus) {
5322     if ($contributionStatus === 'Failed' || !CRM_Core_Permission::check('edit contributions')) {
5323       // In general the balance is the best way to determine if a payment can be added or not,
5324       // but not for Failed contributions, where we don't accept additional payments at the moment.
5325       // (in some cases the contribution is 'Pending' and only the payment is failed. In those we
5326       // do accept more payments agains them.
5327       return array();
5328     }
5329     $actionLinks = array();
5330     if ((int) $balance > 0) {
5331       if (CRM_Core_Config::isEnabledBackOfficeCreditCardPayments()) {
5332         $actionLinks[] = array(
5333           'url' => CRM_Utils_System::url('civicrm/payment', array(
5334             'action' => 'add',
5335             'reset' => 1,
5336             'id' => $id,
5337             'mode' => 'live',
5338           )),
5339           'title' => ts('Submit Credit Card payment'),
5340         );
5341       }
5342       $actionLinks[] = array(
5343         'url' => CRM_Utils_System::url('civicrm/payment', array(
5344           'action' => 'add',
5345           'reset' => 1,
5346           'id' => $id,
5347         )),
5348         'title' => ts('Record Payment'),
5349       );
5350     }
5351     elseif ((int) $balance < 0) {
5352       $actionLinks[] = array(
5353         'url' => CRM_Utils_System::url('civicrm/payment', array(
5354           'action' => 'add',
5355           'reset' => 1,
5356           'id' => $id,
5357         )),
5358         'title' => ts('Record Refund'),
5359       );
5360     }
5361     return $actionLinks;
5362   }
5363
5364   /**
5365    * Get a query to determine the amount donated by the contact/s in the current financial year.
5366    *
5367    * @param array $contactIDs
5368    *
5369    * @return string
5370    */
5371   public static function getAnnualQuery($contactIDs) {
5372     $contactIDs = implode(',', $contactIDs);
5373     $config = CRM_Core_Config::singleton();
5374     $currentMonth = date('m');
5375     $currentDay = date('d');
5376     if (
5377       (int) $config->fiscalYearStart['M'] > $currentMonth ||
5378       (
5379         (int) $config->fiscalYearStart['M'] == $currentMonth &&
5380         (int) $config->fiscalYearStart['d'] > $currentDay
5381       )
5382     ) {
5383       $year = date('Y') - 1;
5384     }
5385     else {
5386       $year = date('Y');
5387     }
5388     $nextYear = $year + 1;
5389
5390     if ($config->fiscalYearStart) {
5391       $newFiscalYearStart = $config->fiscalYearStart;
5392       if ($newFiscalYearStart['M'] < 10) {
5393         // This is just a clumsy way of adding padding.
5394         // @todo next round look for a nicer way.
5395         $newFiscalYearStart['M'] = '0' . $newFiscalYearStart['M'];
5396       }
5397       if ($newFiscalYearStart['d'] < 10) {
5398         // This is just a clumsy way of adding padding.
5399         // @todo next round look for a nicer way.
5400         $newFiscalYearStart['d'] = '0' . $newFiscalYearStart['d'];
5401       }
5402       $config->fiscalYearStart = $newFiscalYearStart;
5403       $monthDay = $config->fiscalYearStart['M'] . $config->fiscalYearStart['d'];
5404     }
5405     else {
5406       // First of January.
5407       $monthDay = '0101';
5408     }
5409     $startDate = "$year$monthDay";
5410     $endDate = "$nextYear$monthDay";
5411
5412     $whereClauses = [
5413       'contact_id' => 'IN (' . $contactIDs . ')',
5414       'is_test' => ' = 0',
5415       'receive_date' => ['>=' . $startDate, '<  ' . $endDate],
5416     ];
5417     $havingClause = 'contribution_status_id = ' . (int) CRM_Core_PseudoConstant::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Completed');
5418     CRM_Financial_BAO_FinancialType::addACLClausesToWhereClauses($whereClauses);
5419
5420     $clauses = [];
5421     foreach ($whereClauses as $key => $clause) {
5422       $clauses[] = 'b.' . $key . " "  . implode(' AND b.' . $key, (array) $clause);
5423     }
5424     $whereClauseString = implode(' AND ', $clauses);
5425
5426     // See https://github.com/civicrm/civicrm-core/pull/13512 for discussion of how
5427     // this group by + having on contribution_status_id improves performance
5428     $query = "
5429       SELECT COUNT(*) as count,
5430              SUM(total_amount) as amount,
5431              AVG(total_amount) as average,
5432              currency
5433       FROM civicrm_contribution b
5434       WHERE " . $whereClauseString . "
5435       GROUP BY currency, contribution_status_id
5436       HAVING $havingClause
5437       ";
5438     return $query;
5439   }
5440
5441   /**
5442    * Assign Test Value.
5443    *
5444    * @param string $fieldName
5445    * @param array $fieldDef
5446    * @param int $counter
5447    */
5448   protected function assignTestValue($fieldName, &$fieldDef, $counter) {
5449     if ($fieldName == 'tax_amount') {
5450       $this->{$fieldName} = "0.00";
5451     }
5452     elseif ($fieldName == 'net_amount') {
5453       $this->{$fieldName} = "2.00";
5454     }
5455     elseif ($fieldName == 'total_amount') {
5456       $this->{$fieldName} = "3.00";
5457     }
5458     elseif ($fieldName == 'fee_amount') {
5459       $this->{$fieldName} = "1.00";
5460     }
5461     else {
5462       parent::assignTestValues($fieldName, $fieldDef, $counter);
5463     }
5464   }
5465
5466   /**
5467    * Check if contribution has participant/membership payment.
5468    *
5469    * @param int $contributionId
5470    *   Contribution ID
5471    *
5472    * @return bool
5473    */
5474   public static function allowUpdateRevenueRecognitionDate($contributionId) {
5475     // get line item for contribution
5476     $lineItems = CRM_Price_BAO_LineItem::getLineItemsByContributionID($contributionId);
5477     // check if line item is for membership or participant
5478     foreach ($lineItems as $items) {
5479       if ($items['entity_table'] == 'civicrm_participant') {
5480         $flag = FALSE;
5481         break;
5482       }
5483       elseif ($items['entity_table'] == 'civicrm_membership') {
5484         $flag = FALSE;
5485       }
5486       else {
5487         $flag = TRUE;
5488         break;
5489       }
5490     }
5491     return $flag;
5492   }
5493
5494   /**
5495    * Create Accounts Receivable financial trxn entry for Completed Contribution.
5496    *
5497    * @param array $trxnParams
5498    *   Financial trxn params
5499    * @param array $contributionParams
5500    *   Contribution Params
5501    *
5502    * @return null
5503    */
5504   public static function recordAlwaysAccountsReceivable(&$trxnParams, $contributionParams) {
5505     if (!self::checkContributeSettings('always_post_to_accounts_receivable')) {
5506       return NULL;
5507     }
5508     $statusId = $contributionParams['contribution']->contribution_status_id;
5509     $contributionStatuses = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');
5510     $contributionStatus = empty($statusId) ? NULL : $contributionStatuses[$statusId];
5511     $previousContributionStatus = empty($contributionParams['prevContribution']) ? NULL : $contributionStatuses[$contributionParams['prevContribution']->contribution_status_id];
5512     // Return if contribution status is not completed.
5513     if (!($contributionStatus == 'Completed' && (empty($previousContributionStatus)
5514       || (!empty($previousContributionStatus) && $previousContributionStatus == 'Pending'
5515         && $contributionParams['prevContribution']->is_pay_later == 0
5516       )))
5517     ) {
5518       return NULL;
5519     }
5520
5521     $params = $trxnParams;
5522     $financialTypeID = CRM_Utils_Array::value('financial_type_id', $contributionParams) ? $contributionParams['financial_type_id'] : $contributionParams['prevContribution']->financial_type_id;
5523     $arAccountId = CRM_Contribute_PseudoConstant::getRelationalFinancialAccount($financialTypeID, 'Accounts Receivable Account is');
5524     $params['to_financial_account_id'] = $arAccountId;
5525     $params['status_id'] = array_search('Pending', $contributionStatuses);
5526     $params['is_payment'] = FALSE;
5527     $trxn = CRM_Core_BAO_FinancialTrxn::create($params);
5528     self::$_trxnIDs[] = $trxn->id;
5529     $trxnParams['from_financial_account_id'] = $params['to_financial_account_id'];
5530   }
5531
5532   /**
5533    * Calculate financial item amount when contribution is updated.
5534    *
5535    * @param array $params
5536    *   contribution params
5537    * @param array $amountParams
5538    *
5539    * @param string $context
5540    *
5541    * @return float
5542    */
5543   public static function calculateFinancialItemAmount($params, $amountParams, $context) {
5544     if (!empty($params['is_quick_config'])) {
5545       $amount = $amountParams['item_amount'];
5546       if (!$amount) {
5547         $amount = $params['total_amount'];
5548         if ($context === NULL) {
5549           $amount -= CRM_Utils_Array::value('tax_amount', $params, 0);
5550         }
5551       }
5552     }
5553     else {
5554       $amount = $amountParams['line_total'];
5555       if ($context == 'changedAmount') {
5556         $amount -= $amountParams['previous_line_total'];
5557       }
5558       $amount *= $amountParams['diff'];
5559     }
5560     return $amount;
5561   }
5562
5563   /**
5564    * Retrieve Sales Tax Financial Accounts.
5565    *
5566    *
5567    * @return array
5568    *
5569    */
5570   public static function getSalesTaxFinancialAccounts() {
5571     $query = "SELECT cfa.id FROM civicrm_entity_financial_account ce
5572  INNER JOIN civicrm_financial_account cfa ON ce.financial_account_id = cfa.id
5573  WHERE `entity_table` = 'civicrm_financial_type' AND cfa.is_tax = 1 AND ce.account_relationship = %1 GROUP BY cfa.id";
5574     $accountRel = key(CRM_Core_PseudoConstant::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Sales Tax Account is' "));
5575     $queryParams = array(1 => array($accountRel, 'Integer'));
5576     $dao = CRM_Core_DAO::executeQuery($query, $queryParams);
5577     $financialAccount = array();
5578     while ($dao->fetch()) {
5579       $financialAccount[$dao->id] = $dao->id;
5580     }
5581     return $financialAccount;
5582   }
5583
5584   /**
5585    * Create tax entry in civicrm_entity_financial_trxn table.
5586    *
5587    * @param array $entityParams
5588    *
5589    * @param array $eftParams
5590    *
5591    */
5592   public static function createProportionalEntry($entityParams, $eftParams) {
5593     $paid = 0;
5594     if ($entityParams['contribution_total_amount'] != 0) {
5595       $paid = $entityParams['line_item_amount'] * ($entityParams['trxn_total_amount'] / $entityParams['contribution_total_amount']);
5596     }
5597     // Record Entity Financial Trxn; CRM-20145
5598     $eftParams['amount'] = CRM_Contribute_BAO_Contribution_Utils::formatAmount($paid);
5599     civicrm_api3('EntityFinancialTrxn', 'create', $eftParams);
5600   }
5601
5602   /**
5603    * Create array of last financial item id's.
5604    *
5605    * @param int $contributionId
5606    *
5607    * @return array
5608    */
5609   public static function getLastFinancialItemIds($contributionId) {
5610     $sql = "SELECT fi.id, li.price_field_value_id, li.tax_amount, fi.financial_account_id
5611       FROM civicrm_financial_item fi
5612       INNER JOIN civicrm_line_item li ON li.id = fi.entity_id and fi.entity_table = 'civicrm_line_item'
5613       WHERE li.contribution_id = %1";
5614     $dao = CRM_Core_DAO::executeQuery($sql, array(1 => array($contributionId, 'Integer')));
5615     $ftIds = $taxItems = array();
5616     $salesTaxFinancialAccount = self::getSalesTaxFinancialAccounts();
5617     while ($dao->fetch()) {
5618       /* if sales tax item*/
5619       if (in_array($dao->financial_account_id, $salesTaxFinancialAccount)) {
5620         $taxItems[$dao->price_field_value_id] = array(
5621           'financial_item_id' => $dao->id,
5622           'amount' => $dao->tax_amount,
5623         );
5624       }
5625       else {
5626         $ftIds[$dao->price_field_value_id] = $dao->id;
5627       }
5628     }
5629     return array($ftIds, $taxItems);
5630   }
5631
5632   /**
5633    * Create proportional entries in civicrm_entity_financial_trxn.
5634    *
5635    * @param array $entityParams
5636    *
5637    * @param array $lineItems
5638    *
5639    * @param array $ftIds
5640    *
5641    * @param array $taxItems
5642    *
5643    */
5644   public static function createProportionalFinancialEntries($entityParams, $lineItems, $ftIds, $taxItems) {
5645     $eftParams = array(
5646       'entity_table' => 'civicrm_financial_item',
5647       'financial_trxn_id' => $entityParams['trxn_id'],
5648     );
5649     foreach ($lineItems as $key => $value) {
5650       if ($value['qty'] == 0) {
5651         continue;
5652       }
5653       $eftParams['entity_id'] = $ftIds[$value['price_field_value_id']];
5654       $entityParams['line_item_amount'] = $value['line_total'];
5655       self::createProportionalEntry($entityParams, $eftParams);
5656       if (array_key_exists($value['price_field_value_id'], $taxItems)) {
5657         $entityParams['line_item_amount'] = $taxItems[$value['price_field_value_id']]['amount'];
5658         $eftParams['entity_id'] = $taxItems[$value['price_field_value_id']]['financial_item_id'];
5659         self::createProportionalEntry($entityParams, $eftParams);
5660       }
5661     }
5662   }
5663
5664   /**
5665    * Load entities related to the contribution into $this->_relatedObjects.
5666    *
5667    * @param array $ids
5668    *
5669    * @throws \CRM_Core_Exception
5670    */
5671   protected function loadRelatedEntitiesByID($ids) {
5672     $entities = array(
5673       'contact' => 'CRM_Contact_BAO_Contact',
5674       'contributionRecur' => 'CRM_Contribute_BAO_ContributionRecur',
5675       'contributionType' => 'CRM_Financial_BAO_FinancialType',
5676       'financialType' => 'CRM_Financial_BAO_FinancialType',
5677       'contributionPage' => 'CRM_Contribute_BAO_ContributionPage',
5678     );
5679     foreach ($entities as $entity => $bao) {
5680       if (!empty($ids[$entity])) {
5681         $this->_relatedObjects[$entity] = new $bao();
5682         $this->_relatedObjects[$entity]->id = $ids[$entity];
5683         if (!$this->_relatedObjects[$entity]->find(TRUE)) {
5684           throw new CRM_Core_Exception($entity . ' could not be loaded');
5685         }
5686       }
5687     }
5688   }
5689
5690   /**
5691    * Should an email receipt be sent for this contribution when complete.
5692    *
5693    * @param array $input
5694    *
5695    * @return mixed
5696    */
5697   protected function isEmailReceipt($input) {
5698     if (isset($input['is_email_receipt'])) {
5699       return $input['is_email_receipt'];
5700     }
5701     if (!empty($this->_relatedObjects['contribution_page_id'])) {
5702       return $this->_relatedObjects['contribution_page_id']->is_email_receipt;
5703     }
5704     return TRUE;
5705   }
5706
5707   /**
5708    * Function to replace contribution tokens.
5709    *
5710    * @param array $contributionIds
5711    *
5712    * @param string $subject
5713    *
5714    * @param array $subjectToken
5715    *
5716    * @param string $text
5717    *
5718    * @param string $html
5719    *
5720    * @param array $messageToken
5721    *
5722    * @param bool $escapeSmarty
5723    *
5724    * @return array
5725    */
5726   public static function replaceContributionTokens(
5727     $contributionIds,
5728     $subject,
5729     $subjectToken,
5730     $text,
5731     $html,
5732     $messageToken,
5733     $escapeSmarty
5734   ) {
5735     if (empty($contributionIds)) {
5736       return array();
5737     }
5738     $contributionDetails = array();
5739     foreach ($contributionIds as $id) {
5740       $result = civicrm_api3('Contribution', 'get', array('id' => $id));
5741       $contributionDetails[$result['values'][$result['id']]['contact_id']]['subject'] = CRM_Utils_Token::replaceContributionTokens($subject, $result, FALSE, $subjectToken, FALSE, $escapeSmarty);
5742       $contributionDetails[$result['values'][$result['id']]['contact_id']]['text'] = CRM_Utils_Token::replaceContributionTokens($text, $result, FALSE, $messageToken, FALSE, $escapeSmarty);
5743       $contributionDetails[$result['values'][$result['id']]['contact_id']]['html'] = CRM_Utils_Token::replaceContributionTokens($html, $result, FALSE, $messageToken, FALSE, $escapeSmarty);
5744     }
5745     return $contributionDetails;
5746   }
5747
5748   /**
5749    * Get invoice_number for contribution.
5750    *
5751    * @param int $contributionID
5752    *
5753    * @return string
5754    */
5755   public static function getInvoiceNumber($contributionID) {
5756     if ($invoicePrefix = self::checkContributeSettings('invoice_prefix', TRUE)) {
5757       return $invoicePrefix . $contributionID;
5758     }
5759
5760     return NULL;
5761   }
5762
5763 }