CRM/Price/BAO/LineItem.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
  34 /**
  35  * Business objects for Line Items generated by monetary transactions
  36  */
  37 class CRM_Price_BAO_LineItem extends CRM_Price_DAO_LineItem {
  38
  39   /**
  40    * Creates a new entry in the database.
  41    *
  42    * @param array $params
  43    *   (reference) an assoc array of name/value pairs.
  44    *
  45    * @return \CRM_Price_DAO_LineItem
  46    *
  47    * @throws \CiviCRM_API3_Exception
  48    * @throws \Exception
  49    */
  50   public static function create(&$params) {
  51     $id = CRM_Utils_Array::value('id', $params);
  52     if ($id) {
  53       CRM_Utils_Hook::pre('edit', 'LineItem', $id, $params);
  54       $op = CRM_Core_Action::UPDATE;
  55     }
  56     else {
  57       CRM_Utils_Hook::pre('create', 'LineItem', $params['entity_id'], $params);
  58       $op = CRM_Core_Action::ADD;
  59     }
  60
  61     // unset entity table and entity id in $params
  62     // we never update the entity table and entity id during update mode
  63     if ($id) {
  64       $entity_id = CRM_Utils_Array::value('entity_id', $params);
  65       $entity_table = CRM_Utils_Array::value('entity_table', $params);
  66       unset($params['entity_id'], $params['entity_table']);
  67     }
  68     else {
  69       if (!isset($params['unit_price'])) {
  70         $params['unit_price'] = 0;
  71       }
  72     }
  73     if (CRM_Financial_BAO_FinancialType::isACLFinancialTypeStatus() && !empty($params['check_permissions'])) {
  74       if (empty($params['financial_type_id'])) {
  75         throw new Exception('Mandatory key(s) missing from params array: financial_type_id');
  76       }
  77       CRM_Financial_BAO_FinancialType::getAvailableFinancialTypes($types, $op);
  78       if (!in_array($params['financial_type_id'], array_keys($types))) {
  79         throw new Exception('You do not have permission to create this line item');
  80       }
  81     }
  82
  83     $lineItemBAO = new CRM_Price_BAO_LineItem();
  84     $lineItemBAO->copyValues($params);
  85
  86     $return = $lineItemBAO->save();
  87     if ($lineItemBAO->entity_table == 'civicrm_membership' && $lineItemBAO->contribution_id && $lineItemBAO->entity_id) {
  88       $membershipPaymentParams = [
  89         'membership_id' => $lineItemBAO->entity_id,
  90         'contribution_id' => $lineItemBAO->contribution_id,
  91       ];
  92       if (!civicrm_api3('MembershipPayment', 'getcount', $membershipPaymentParams)) {
  93         civicrm_api3('MembershipPayment', 'create', $membershipPaymentParams);
  94       }
  95     }
  96
  97     if ($id) {
  98       // CRM-21281: Restore entity reference in case the post hook needs it
  99       $lineItemBAO->entity_id = $entity_id;
 100       $lineItemBAO->entity_table = $entity_table;
 101       CRM_Utils_Hook::post('edit', 'LineItem', $id, $lineItemBAO);
 102     }
 103     else {
 104       CRM_Utils_Hook::post('create', 'LineItem', $lineItemBAO->id, $lineItemBAO);
 105     }
 106
 107     return $return;
 108   }
 109
 110   /**
 111    * Retrieve DB object based on input parameters.
 112    *
 113    * It also stores all the retrieved values in the default array.
 114    *
 115    * @param array $params
 116    *   (reference ) an assoc array of name/value pairs.
 117    * @param array $defaults
 118    *   (reference ) an assoc array to hold the flattened values.
 119    *
 120    * @return CRM_Price_BAO_LineItem
 121    */
 122   public static function retrieve(&$params = [], &$defaults = []) {
 123     $lineItem = new CRM_Price_BAO_LineItem();
 124     $lineItem->copyValues($params);
 125     if ($lineItem->find(TRUE)) {
 126       CRM_Core_DAO::storeValues($lineItem, $defaults);
 127       return $lineItem;
 128     }
 129     return NULL;
 130   }
 131
 132   /**
 133    * Modifies $params array for filtering financial types.
 134    *
 135    * @param array $params
 136    *   (reference ) an assoc array of name/value pairs.
 137    *
 138    */
 139   public static function getAPILineItemParams(&$params) {
 140     CRM_Financial_BAO_FinancialType::getAvailableFinancialTypes($types);
 141     if ($types && empty($params['financial_type_id'])) {
 142       $params['financial_type_id'] = ['IN' => array_keys($types)];
 143     }
 144     elseif ($types) {
 145       if (is_array($params['financial_type_id'])) {
 146         $invalidFts = array_diff($params['financial_type_id'], array_keys($types));
 147       }
 148       elseif (!in_array($params['financial_type_id'], array_keys($types))) {
 149         $invalidFts = $params['financial_type_id'];
 150       }
 151       if ($invalidFts) {
 152         $params['financial_type_id'] = ['NOT IN' => $invalidFts];
 153       }
 154     }
 155     else {
 156       $params['financial_type_id'] = 0;
 157     }
 158   }
 159
 160   /**
 161    * @param int $contributionId
 162    *
 163    * @return null|string
 164    */
 165   public static function getLineTotal($contributionId) {
 166     $sqlLineItemTotal = "SELECT SUM(li.line_total + COALESCE(li.tax_amount,0))
 167 FROM civicrm_line_item li
 168 WHERE li.contribution_id = %1";
 169     $params = [1 => [$contributionId, 'Integer']];
 170     $lineItemTotal = CRM_Core_DAO::singleValueQuery($sqlLineItemTotal, $params);
 171     return $lineItemTotal;
 172   }
 173
 174   /**
 175    * Wrapper for line item retrieval when contribution ID is known.
 176    * @param int $contributionID
 177    *
 178    * @return array
 179    */
 180   public static function getLineItemsByContributionID($contributionID) {
 181     return self::getLineItems($contributionID, 'contribution', NULL, TRUE, TRUE);
 182   }
 183
 184   /**
 185    * Given a participant id/contribution id,
 186    * return contribution/fee line items
 187    *
 188    * @param int $entityId
 189    *   participant/contribution id.
 190    * @param string $entity
 191    *   participant/contribution.
 192    *
 193    * @param bool $isQuick
 194    * @param bool $isQtyZero
 195    * @param bool $relatedEntity
 196    *
 197    * @param bool $invoice
 198    * @return array
 199    *   Array of line items
 200    */
 201   public static function getLineItems($entityId, $entity = 'participant', $isQuick = FALSE, $isQtyZero = TRUE, $relatedEntity = FALSE, $invoice = FALSE) {
 202     $whereClause = $fromClause = NULL;
 203     $selectClause = "
 204       SELECT    li.id,
 205       li.label,
 206       li.contribution_id,
 207       li.qty,
 208       li.unit_price,
 209       li.line_total,
 210       li.entity_table,
 211       li.entity_id,
 212       pf.label as field_title,
 213       pf.html_type,
 214       pf.price_set_id,
 215       pfv.membership_type_id,
 216       pfv.membership_num_terms,
 217       li.price_field_id,
 218       li.participant_count,
 219       li.price_field_value_id,
 220       li.financial_type_id,
 221       li.tax_amount,
 222       pfv.description";
 223
 224     $condition = "li.entity_id = %2.id AND li.entity_table = 'civicrm_%2'";
 225     if ($relatedEntity) {
 226       $condition = "li.contribution_id = %2.id ";
 227     }
 228
 229     $fromClause = "
 230       FROM      civicrm_%2 as %2
 231       LEFT JOIN civicrm_line_item li ON ({$condition})
 232       LEFT JOIN civicrm_price_field_value pfv ON ( pfv.id = li.price_field_value_id )
 233       LEFT JOIN civicrm_price_field pf ON (pf.id = li.price_field_id )";
 234     $whereClause = "
 235       WHERE     %2.id = %1";
 236
 237     // CRM-16250 get additional participant's fee selection details only for invoice PDF (if any)
 238     if ($entity == 'participant' && $invoice) {
 239       $additionalParticipantIDs = CRM_Event_BAO_Participant::getAdditionalParticipantIds($entityId);
 240       if (!empty($additionalParticipantIDs)) {
 241         $whereClause = "WHERE %2.id IN (%1, " . implode(', ', $additionalParticipantIDs) . ")";
 242       }
 243     }
 244
 245     $orderByClause = " ORDER BY pf.weight, pfv.weight";
 246
 247     if ($isQuick) {
 248       $fromClause .= " LEFT JOIN civicrm_price_set cps on cps.id = pf.price_set_id ";
 249       $whereClause .= " and cps.is_quick_config = 0";
 250     }
 251
 252     if (!$isQtyZero) {
 253       $whereClause .= " and li.qty != 0";
 254     }
 255
 256     $lineItems = [];
 257
 258     if (!$entityId || !$entity || !$fromClause) {
 259       return $lineItems;
 260     }
 261
 262     $params = [
 263       1 => [$entityId, 'Integer'],
 264       2 => [$entity, 'Text'],
 265     ];
 266
 267     $getTaxDetails = FALSE;
 268     $invoiceSettings = Civi::settings()->get('contribution_invoice_settings');
 269     $invoicing = CRM_Utils_Array::value('invoicing', $invoiceSettings);
 270
 271     $dao = CRM_Core_DAO::executeQuery("$selectClause $fromClause $whereClause $orderByClause", $params);
 272     while ($dao->fetch()) {
 273       if (!$dao->id) {
 274         continue;
 275       }
 276       $lineItems[$dao->id] = [
 277         'qty' => (float) $dao->qty,
 278         'label' => $dao->label,
 279         'unit_price' => $dao->unit_price,
 280         'line_total' => $dao->line_total,
 281         'price_field_id' => $dao->price_field_id,
 282         'participant_count' => $dao->participant_count,
 283         'price_field_value_id' => $dao->price_field_value_id,
 284         'field_title' => $dao->field_title,
 285         'html_type' => $dao->html_type,
 286         'description' => $dao->description,
 287         'entity_id' => $dao->entity_id,
 288         'entity_table' => $dao->entity_table,
 289         'contribution_id' => $dao->contribution_id,
 290         'financial_type_id' => $dao->financial_type_id,
 291         'financial_type' => CRM_Core_PseudoConstant::getLabel('CRM_Contribute_BAO_Contribution', 'financial_type_id', $dao->financial_type_id),
 292         'membership_type_id' => $dao->membership_type_id,
 293         'membership_num_terms' => $dao->membership_num_terms,
 294         'tax_amount' => $dao->tax_amount,
 295         'price_set_id' => $dao->price_set_id,
 296       ];
 297       $taxRates = CRM_Core_PseudoConstant::getTaxRates();
 298       if (isset($lineItems[$dao->id]['financial_type_id']) && array_key_exists($lineItems[$dao->id]['financial_type_id'], $taxRates)) {
 299         // Cast to float so trailing zero decimals are removed for display.
 300         $lineItems[$dao->id]['tax_rate'] = (float) $taxRates[$lineItems[$dao->id]['financial_type_id']];
 301       }
 302       else {
 303         // There is no Tax Rate associated with this Financial Type
 304         $lineItems[$dao->id]['tax_rate'] = FALSE;
 305       }
 306       $lineItems[$dao->id]['subTotal'] = $lineItems[$dao->id]['qty'] * $lineItems[$dao->id]['unit_price'];
 307       if ($lineItems[$dao->id]['tax_amount'] != '') {
 308         $getTaxDetails = TRUE;
 309       }
 310     }
 311     if ($invoicing) {
 312       // @todo - this is an inappropriate place to be doing form level assignments.
 313       $taxTerm = CRM_Utils_Array::value('tax_term', $invoiceSettings);
 314       $smarty = CRM_Core_Smarty::singleton();
 315       $smarty->assign('taxTerm', $taxTerm);
 316       $smarty->assign('getTaxDetails', $getTaxDetails);
 317     }
 318     return $lineItems;
 319   }
 320
 321   /**
 322    * This method will create the lineItem array required for
 323    * processAmount method
 324    *
 325    * @param int $fid
 326    *   Price set field id.
 327    * @param array $params
 328    *   Reference to form values.
 329    * @param array $fields
 330    *   Array of fields belonging to the price set used for particular event
 331    * @param array $values
 332    *   Reference to the values array(.
 333    *   this is
 334    *                          lineItem array)
 335    * @param string $amount_override
 336    *   Amount override must be in format 1000.00 - ie no thousand separator & if
 337    *   a decimal point is used it should be a decimal
 338    *
 339    * @todo - this parameter is only used for partial payments. It's unclear why a partial
 340    *  payment would change the line item price.
 341    */
 342   public static function format($fid, $params, $fields, &$values, $amount_override = NULL) {
 343     if (empty($params["price_{$fid}"])) {
 344       return;
 345     }
 346
 347     //lets first check in fun parameter,
 348     //since user might modified w/ hooks.
 349     $options = [];
 350     if (array_key_exists('options', $fields)) {
 351       $options = $fields['options'];
 352     }
 353     else {
 354       CRM_Price_BAO_PriceFieldValue::getValues($fid, $options, 'weight', TRUE);
 355     }
 356     $fieldTitle = CRM_Utils_Array::value('label', $fields);
 357     if (!$fieldTitle) {
 358       $fieldTitle = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceField', $fid, 'label');
 359     }
 360
 361     foreach ($params["price_{$fid}"] as $oid => $qty) {
 362       $price = $amount_override === NULL ? $options[$oid]['amount'] : $amount_override;
 363
 364       $participantsPerField = CRM_Utils_Array::value('count', $options[$oid], 0);
 365
 366       $values[$oid] = [
 367         'price_field_id' => $fid,
 368         'price_field_value_id' => $oid,
 369         'label' => CRM_Utils_Array::value('label', $options[$oid]),
 370         'field_title' => $fieldTitle,
 371         'description' => CRM_Utils_Array::value('description', $options[$oid]),
 372         'qty' => $qty,
 373         'unit_price' => $price,
 374         'line_total' => $qty * $price,
 375         'participant_count' => $qty * $participantsPerField,
 376         'max_value' => CRM_Utils_Array::value('max_value', $options[$oid]),
 377         'membership_type_id' => CRM_Utils_Array::value('membership_type_id', $options[$oid]),
 378         'membership_num_terms' => CRM_Utils_Array::value('membership_num_terms', $options[$oid]),
 379         'auto_renew' => CRM_Utils_Array::value('auto_renew', $options[$oid]),
 380         'html_type' => $fields['html_type'],
 381         'financial_type_id' => CRM_Utils_Array::value('financial_type_id', $options[$oid]),
 382         'tax_amount' => CRM_Utils_Array::value('tax_amount', $options[$oid]),
 383         'non_deductible_amount' => CRM_Utils_Array::value('non_deductible_amount', $options[$oid]),
 384       ];
 385
 386       if ($values[$oid]['membership_type_id'] && empty($values[$oid]['auto_renew'])) {
 387         $values[$oid]['auto_renew'] = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipType', $values[$oid]['membership_type_id'], 'auto_renew');
 388       }
 389     }
 390   }
 391
 392   /**
 393    * Delete line items for given entity.
 394    *
 395    * @param int $entityId
 396    * @param int $entityTable
 397    *
 398    * @return bool
 399    */
 400   public static function deleteLineItems($entityId, $entityTable) {
 401     if (!$entityId || !$entityTable) {
 402       return FALSE;
 403     }
 404
 405     if ($entityId && !is_array($entityId)) {
 406       $entityId = [$entityId];
 407     }
 408
 409     $query = "DELETE FROM civicrm_line_item where entity_id IN ('" . implode("','", $entityId) . "') AND entity_table = '$entityTable'";
 410     $dao = CRM_Core_DAO::executeQuery($query);
 411     return TRUE;
 412   }
 413
 414   /**
 415    * Process price set and line items.
 416    *
 417    * @param int $entityId
 418    * @param array $lineItem
 419    *   Line item array.
 420    * @param object $contributionDetails
 421    * @param string $entityTable
 422    *   Entity table.
 423    *
 424    * @param bool $update
 425    *
 426    * @return void
 427    */
 428   public static function processPriceSet($entityId, $lineItem, $contributionDetails = NULL, $entityTable = 'civicrm_contribution', $update = FALSE) {
 429     if (!$entityId || !is_array($lineItem)
 430       || CRM_Utils_System::isNull($lineItem)
 431     ) {
 432       return;
 433     }
 434
 435     foreach ($lineItem as $priceSetId => &$values) {
 436       if (!$priceSetId) {
 437         continue;
 438       }
 439
 440       foreach ($values as &$line) {
 441         if (empty($line['entity_table'])) {
 442           $line['entity_table'] = $entityTable;
 443         }
 444         if (empty($line['entity_id'])) {
 445           $line['entity_id'] = $entityId;
 446         }
 447         if (!empty($line['membership_type_id'])) {
 448           $line['entity_table'] = 'civicrm_membership';
 449         }
 450         if (!empty($contributionDetails->id)) {
 451           $line['contribution_id'] = $contributionDetails->id;
 452           if ($line['entity_table'] == 'civicrm_contribution') {
 453             $line['entity_id'] = $contributionDetails->id;
 454           }
 455           // CRM-19094: entity_table is set to civicrm_membership then ensure
 456           // the entityId is set to membership ID not contribution by default
 457           elseif ($line['entity_table'] == 'civicrm_membership' && !empty($line['entity_id']) && $line['entity_id'] == $contributionDetails->id) {
 458             $membershipId = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipPayment', $contributionDetails->id, 'membership_id', 'contribution_id');
 459             if ($membershipId && (int) $membershipId !== (int) $line['entity_id']) {
 460               $line['entity_id'] = $membershipId;
 461               Civi::log()->warning('Per https://lab.civicrm.org/dev/core/issues/15 this data fix should not be required. Please log a ticket at https://lab.civicrm.org/dev/core with steps to get this.', ['civi.tag' => 'deprecated']);
 462             }
 463           }
 464         }
 465
 466         // if financial type is not set and if price field value is NOT NULL
 467         // get financial type id of price field value
 468         if (!empty($line['price_field_value_id']) && empty($line['financial_type_id'])) {
 469           $line['financial_type_id'] = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceFieldValue', $line['price_field_value_id'], 'financial_type_id');
 470         }
 471         $lineItems = CRM_Price_BAO_LineItem::create($line);
 472         if (!$update && $contributionDetails) {
 473           $financialItem = CRM_Financial_BAO_FinancialItem::add($lineItems, $contributionDetails);
 474           $line['financial_item_id'] = $financialItem->id;
 475           if (!empty($line['tax_amount'])) {
 476             CRM_Financial_BAO_FinancialItem::add($lineItems, $contributionDetails, TRUE);
 477           }
 478         }
 479       }
 480     }
 481     if (!$update && $contributionDetails) {
 482       CRM_Core_BAO_FinancialTrxn::createDeferredTrxn($lineItem, $contributionDetails);
 483     }
 484   }
 485
 486   /**
 487    * @param int $entityId
 488    * @param string $entityTable
 489    * @param $amount
 490    * @param array $otherParams
 491    */
 492   public static function syncLineItems($entityId, $entityTable = 'civicrm_contribution', $amount, $otherParams = NULL) {
 493     if (!$entityId || CRM_Utils_System::isNull($amount)) {
 494       return;
 495     }
 496
 497     $from = " civicrm_line_item li
 498       LEFT JOIN   civicrm_price_field pf ON pf.id = li.price_field_id
 499       LEFT JOIN   civicrm_price_set ps ON ps.id = pf.price_set_id ";
 500
 501     $set = " li.unit_price = %3,
 502       li.line_total = %3 ";
 503
 504     $where = " li.entity_id = %1 AND
 505       li.entity_table = %2 ";
 506
 507     $params = [
 508       1 => [$entityId, 'Integer'],
 509       2 => [$entityTable, 'String'],
 510       3 => [$amount, 'Float'],
 511     ];
 512
 513     if ($entityTable == 'civicrm_contribution') {
 514       $entityName = 'default_contribution_amount';
 515       $where .= " AND ps.name = %4 ";
 516       $params[4] = [$entityName, 'String'];
 517     }
 518     elseif ($entityTable == 'civicrm_participant') {
 519       $from .= "
 520         LEFT JOIN civicrm_price_set_entity cpse ON cpse.price_set_id = ps.id
 521         LEFT JOIN civicrm_price_field_value cpfv ON cpfv.price_field_id = pf.id and cpfv.label = %4 ";
 522       $set .= " ,li.label = %4,
 523         li.price_field_value_id = cpfv.id ";
 524       $where .= " AND cpse.entity_table = 'civicrm_event' AND cpse.entity_id = %5 ";
 525       $amount = empty($amount) ? 0 : $amount;
 526       $params += [
 527         4 => [$otherParams['fee_label'], 'String'],
 528         5 => [$otherParams['event_id'], 'String'],
 529       ];
 530     }
 531
 532     $query = "
 533       UPDATE $from
 534       SET    $set
 535       WHERE  $where
 536       ";
 537
 538     CRM_Core_DAO::executeQuery($query, $params);
 539   }
 540
 541   /**
 542    * Build line items array.
 543    *
 544    * @param array $params
 545    *   Form values.
 546    *
 547    * @param string $entityId
 548    *   Entity id.
 549    *
 550    * @param string $entityTable
 551    *   Entity Table.
 552    *
 553    * @param bool $isRelatedID
 554    */
 555   public static function getLineItemArray(&$params, $entityId = NULL, $entityTable = 'contribution', $isRelatedID = FALSE) {
 556     if (!$entityId) {
 557       $priceSetDetails = CRM_Price_BAO_PriceSet::getDefaultPriceSet($entityTable);
 558       $totalAmount = CRM_Utils_Array::value('partial_payment_total', $params, CRM_Utils_Array::value('total_amount', $params));
 559       $financialType = CRM_Utils_Array::value('financial_type_id', $params);
 560       foreach ($priceSetDetails as $values) {
 561         if ($entityTable == 'membership') {
 562           if ($isRelatedID != $values['membership_type_id']) {
 563             continue;
 564           }
 565           if (!$totalAmount) {
 566             $totalAmount = $values['amount'];
 567           }
 568           $financialType = $values['financial_type_id'];
 569         }
 570         $params['line_item'][$values['setID']][$values['priceFieldID']] = [
 571           'price_field_id' => $values['priceFieldID'],
 572           'price_field_value_id' => $values['priceFieldValueID'],
 573           'label' => $values['label'],
 574           'qty' => 1,
 575           'unit_price' => $totalAmount,
 576           'line_total' => $totalAmount,
 577           'financial_type_id' => $financialType,
 578           'membership_type_id' => $values['membership_type_id'],
 579         ];
 580         break;
 581       }
 582     }
 583     else {
 584       $setID = NULL;
 585       $totalEntityId = count($entityId);
 586       if ($entityTable == 'contribution') {
 587         $isRelatedID = TRUE;
 588       }
 589       foreach ($entityId as $id) {
 590         $lineItems = CRM_Price_BAO_LineItem::getLineItems($id, $entityTable, FALSE, TRUE, $isRelatedID);
 591         foreach ($lineItems as $key => $values) {
 592           if (!$setID && $values['price_field_id']) {
 593             $setID = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceField', $values['price_field_id'], 'price_set_id');
 594             $params['is_quick_config'] = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceSet', $setID, 'is_quick_config');
 595           }
 596           if (!empty($params['is_quick_config']) && array_key_exists('total_amount', $params)
 597             && $totalEntityId == 1
 598           ) {
 599             $values['line_total'] = $values['unit_price'] = $params['total_amount'];
 600           }
 601           $values['id'] = $key;
 602           $params['line_item'][$setID][$key] = $values;
 603         }
 604       }
 605     }
 606   }
 607
 608   /**
 609    * Build the line items for the submitted price field.
 610    *
 611    * This is when first building them - not an update where an entityId is already present
 612    * as this is intended as a subfunction of that. Ideally getLineItemArray would call this
 613    * (resolving to the same format regardless of what type of price set is being used first).
 614    *
 615    * @param array $priceParams
 616    *   These are per the way the form processes them - ie
 617    *   ['price_1' => 1, 'price_2' => 8]
 618    *   This would mean price field id 1, option 1 (or 1 unit if using is_enter_qty).
 619    * @param float|NULL $overrideAmount
 620    *   Optional override of the amount.
 621    *
 622    * @param int|null $financialTypeID
 623    *   Financial type ID is the type should be overridden.
 624    *
 625    * @return array
 626    *   Line items formatted for processing. These will look like
 627    *   [4] => ['price_field_id' => 4, 'price_field_value_id' => x, 'label....qty...unit_price...line_total...financial_type_id]
 628    *   [5] => ['price_field_id' => 5, 'price_field_value_id' => x, 'label....qty...unit_price...line_total...financial_type_id]
 629    *
 630    */
 631   public static function buildLineItemsForSubmittedPriceField($priceParams, $overrideAmount = NULL, $financialTypeID = NULL) {
 632     $lineItems = [];
 633     foreach ($priceParams as $key => $value) {
 634       $priceField = self::getPriceFieldMetaData($key);
 635
 636       if ($priceField['html_type'] === 'Text') {
 637         $valueSpec = reset($priceField['values']);
 638       }
 639       else {
 640         $valueSpec = $priceField['values'][$value];
 641       }
 642       $qty = $priceField['is_enter_qty'] ? $value : 1;
 643       $lineItems[$priceField['id']] = [
 644         'price_field_id' => $priceField['id'],
 645         'price_field_value_id' => $valueSpec['id'],
 646         'label' => $valueSpec['label'],
 647         'qty' => $qty,
 648         'unit_price' => $overrideAmount ?: $valueSpec['amount'],
 649         'line_total' => $qty * ($overrideAmount ?: $valueSpec['amount']),
 650         'financial_type_id' => $financialTypeID ?: $valueSpec['financial_type_id'],
 651         'membership_type_id' => $valueSpec['membership_type_id'],
 652         'price_set_id' => $priceField['price_set_id'],
 653       ];
 654     }
 655     return $lineItems;
 656   }
 657
 658   /**
 659    * Function to update related contribution of a entity and
 660    *  add/update/cancel financial records
 661    *
 662    * @param array $params
 663    * @param int $entityID
 664    * @param int $entity
 665    * @param int $contributionId
 666    * @param $feeBlock
 667    * @param array $lineItems
 668    *
 669    */
 670   public static function changeFeeSelections(
 671     $params,
 672     $entityID,
 673     $entity,
 674     $contributionId,
 675     $feeBlock,
 676     $lineItems
 677   ) {
 678     $entityTable = "civicrm_" . $entity;
 679     CRM_Price_BAO_PriceSet::processAmount($feeBlock,
 680       $params, $lineItems
 681     );
 682     // initialize empty Lineitem instance to call protected helper functions
 683     $lineItemObj = new CRM_Price_BAO_LineItem();
 684
 685     // fetch submitted LineItems from input params and feeBlock information
 686     $submittedLineItems = $lineItemObj->getSubmittedLineItems($params, $feeBlock);
 687
 688     $requiredChanges = $lineItemObj->getLineItemsToAlter($submittedLineItems, $entityID, $entity);
 689
 690     // get financial information that need to be recorded on basis on submitted price field value IDs
 691     if (!empty($requiredChanges['line_items_to_cancel']) || !empty($requiredChanges['line_items_to_update'])) {
 692       // @todo - this IF is to get this through PR merge but I suspect that it should not
 693       // be necessary & is masking something else.
 694       $financialItemsArray = $lineItemObj->getAdjustedFinancialItemsToRecord(
 695         $entityID,
 696         $entityTable,
 697         $contributionId,
 698         array_keys($requiredChanges['line_items_to_cancel']),
 699         $requiredChanges['line_items_to_update']
 700       );
 701     }
 702
 703     // update line item with changed line total and other information
 704     $totalParticipant = $participantCount = 0;
 705     $amountLevel = [];
 706     if (!empty($requiredChanges['line_items_to_update'])) {
 707       foreach ($requiredChanges['line_items_to_update'] as $priceFieldValueID => $value) {
 708         $amountLevel[] = $value['label'] . ' - ' . (float) $value['qty'];
 709         if ($entity == 'participant' && isset($value['participant_count'])) {
 710           $totalParticipant += $value['participant_count'];
 711         }
 712       }
 713     }
 714
 715     foreach (array_merge($requiredChanges['line_items_to_resurrect'], $requiredChanges['line_items_to_cancel'], $requiredChanges['line_items_to_update']) as $lineItemToAlter) {
 716       // Must use BAO rather than api because a bad line it in the api which we want to avoid.
 717       CRM_Price_BAO_LineItem::create($lineItemToAlter);
 718     }
 719
 720     $lineItemObj->addLineItemOnChangeFeeSelection($requiredChanges['line_items_to_add'], $entityID, $entityTable, $contributionId);
 721
 722     $count = 0;
 723     if ($entity == 'participant') {
 724       $count = count(CRM_Event_BAO_Participant::getParticipantIds($contributionId));
 725     }
 726     else {
 727       $count = CRM_Utils_Array::value('count', civicrm_api3('MembershipPayment', 'getcount', ['contribution_id' => $contributionId]));
 728     }
 729     if ($count > 1) {
 730       $updatedAmount = CRM_Price_BAO_LineItem::getLineTotal($contributionId);
 731     }
 732     else {
 733       $updatedAmount = CRM_Utils_Array::value('amount', $params, CRM_Utils_Array::value('total_amount', $params));
 734     }
 735     if (strlen($params['tax_amount']) != 0) {
 736       $taxAmount = $params['tax_amount'];
 737     }
 738     else {
 739       $taxAmount = "NULL";
 740     }
 741     $displayParticipantCount = '';
 742     if ($totalParticipant > 0) {
 743       $displayParticipantCount = ' Participant Count -' . $totalParticipant;
 744     }
 745     $updateAmountLevel = NULL;
 746     if (!empty($amountLevel)) {
 747       $updateAmountLevel = CRM_Core_DAO::VALUE_SEPARATOR . implode(CRM_Core_DAO::VALUE_SEPARATOR, $amountLevel) . $displayParticipantCount . CRM_Core_DAO::VALUE_SEPARATOR;
 748     }
 749     $trxn = $lineItemObj->_recordAdjustedAmt($updatedAmount, $contributionId, $taxAmount, $updateAmountLevel);
 750     $contributionStatus = CRM_Core_PseudoConstant::getName('CRM_Contribute_DAO_Contribution', 'contribution_status_id', CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_Contribution', $contributionId, 'contribution_status_id'));
 751
 752     if (!empty($financialItemsArray)) {
 753       foreach ($financialItemsArray as $updateFinancialItemInfoValues) {
 754         $newFinancialItem = CRM_Financial_BAO_FinancialItem::create($updateFinancialItemInfoValues);
 755         // record reverse transaction only if Contribution is Completed because for pending refund or
 756         //   partially paid we are already recording the surplus owed or refund amount
 757         if (!empty($updateFinancialItemInfoValues['financialTrxn']) && ($contributionStatus == 'Completed')) {
 758           $updateFinancialItemInfoValues = array_merge($updateFinancialItemInfoValues['financialTrxn'], [
 759             'entity_id' => $newFinancialItem->id,
 760             'entity_table' => 'civicrm_financial_item',
 761           ]);
 762           $reverseTrxn = CRM_Core_BAO_FinancialTrxn::create($updateFinancialItemInfoValues);
 763           // record reverse entity financial trxn linked to membership's related contribution
 764           civicrm_api3('EntityFinancialTrxn', 'create', [
 765             'entity_table' => "civicrm_contribution",
 766             'entity_id' => $contributionId,
 767             'financial_trxn_id' => $reverseTrxn->id,
 768             'amount' => $reverseTrxn->total_amount,
 769           ]);
 770           unset($updateFinancialItemInfoValues['financialTrxn']);
 771         }
 772         elseif (!empty($updateFinancialItemInfoValues['link-financial-trxn']) && $newFinancialItem->amount != 0) {
 773           civicrm_api3('EntityFinancialTrxn', 'create', [
 774             'entity_id' => $newFinancialItem->id,
 775             'entity_table' => 'civicrm_financial_item',
 776             'financial_trxn_id' => $trxn->id,
 777             'amount' => $newFinancialItem->amount,
 778           ]);
 779           unset($updateFinancialItemInfoValues['link-financial-trxn']);
 780         }
 781       }
 782     }
 783
 784     // @todo - it may be that trxn_id is always empty - flush out scenarios. Add tests.
 785     $trxnId = !empty($trxn->id) ? ['id' => $trxn->id] : [];
 786     $lineItemObj->addFinancialItemsOnLineItemsChange(array_merge($requiredChanges['line_items_to_add'], $requiredChanges['line_items_to_resurrect']), $entityID, $entityTable, $contributionId, $trxnId);
 787
 788     // update participant fee_amount column
 789     $lineItemObj->updateEntityRecordOnChangeFeeSelection($params, $entityID, $entity);
 790   }
 791
 792   /**
 793    * Function to retrieve financial items that need to be recorded as result of changed fee
 794    *
 795    * @param int $entityID
 796    * @param string $entityTable
 797    * @param int $contributionID
 798    * @param array $priceFieldValueIDsToCancel
 799    * @param array $lineItemsToUpdate
 800    *
 801    * @return array
 802    *   List of formatted reverse Financial Items to be recorded
 803    */
 804   protected function getAdjustedFinancialItemsToRecord($entityID, $entityTable, $contributionID, $priceFieldValueIDsToCancel, $lineItemsToUpdate) {
 805     $previousLineItems = CRM_Price_BAO_LineItem::getLineItems($entityID, str_replace('civicrm_', '', $entityTable));
 806
 807     $financialItemsArray = [];
 808     $financialItemResult = $this->getNonCancelledFinancialItems($entityID, $entityTable);
 809     foreach ($financialItemResult as $updateFinancialItemInfoValues) {
 810       $updateFinancialItemInfoValues['transaction_date'] = date('YmdHis');
 811
 812       // the below params are not needed as we are creating new financial item
 813       $previousFinancialItemID = $updateFinancialItemInfoValues['id'];
 814       $totalFinancialAmount = $this->checkFinancialItemTotalAmountByLineItemID($updateFinancialItemInfoValues['entity_id']);
 815       unset($updateFinancialItemInfoValues['id']);
 816       unset($updateFinancialItemInfoValues['created_date']);
 817
 818       // if not submitted and difference is not 0 make it negative
 819       if ((empty($lineItemsToUpdate) || (in_array($updateFinancialItemInfoValues['price_field_value_id'], $priceFieldValueIDsToCancel) &&
 820           $totalFinancialAmount == $updateFinancialItemInfoValues['amount'])
 821         ) && $updateFinancialItemInfoValues['amount'] > 0
 822       ) {
 823         // INSERT negative financial_items
 824         $updateFinancialItemInfoValues['amount'] = -$updateFinancialItemInfoValues['amount'];
 825         // reverse the related financial trxn too
 826         $updateFinancialItemInfoValues['financialTrxn'] = $this->getRelatedCancelFinancialTrxn($previousFinancialItemID);
 827         if ($previousLineItems[$updateFinancialItemInfoValues['entity_id']]['tax_amount']) {
 828           $updateFinancialItemInfoValues['tax']['amount'] = -($previousLineItems[$updateFinancialItemInfoValues['entity_id']]['tax_amount']);
 829           $updateFinancialItemInfoValues['tax']['description'] = $this->getSalesTaxTerm();
 830         }
 831         // INSERT negative financial_items for tax amount
 832         $financialItemsArray[$updateFinancialItemInfoValues['entity_id']] = $updateFinancialItemInfoValues;
 833       }
 834       // INSERT a financial item to record surplus/lesser amount when a text price fee is changed
 835       elseif (
 836         !empty($lineItemsToUpdate)
 837         && isset($lineItemsToUpdate[$updateFinancialItemInfoValues['price_field_value_id']])
 838         && $lineItemsToUpdate[$updateFinancialItemInfoValues['price_field_value_id']]['html_type'] == 'Text'
 839         && $updateFinancialItemInfoValues['amount'] > 0
 840       ) {
 841         $amountChangeOnTextLineItem = $lineItemsToUpdate[$updateFinancialItemInfoValues['price_field_value_id']]['line_total'] - $totalFinancialAmount;
 842         if ($amountChangeOnTextLineItem !== (float) 0) {
 843           // calculate the amount difference, considered as financial item amount
 844           $updateFinancialItemInfoValues['amount'] = $amountChangeOnTextLineItem;
 845           // add a flag, later used to link financial trxn and this new financial item
 846           $updateFinancialItemInfoValues['link-financial-trxn'] = TRUE;
 847           if ($previousLineItems[$updateFinancialItemInfoValues['entity_id']]['tax_amount']) {
 848             $updateFinancialItemInfoValues['tax']['amount'] = $lineItemsToUpdate[$updateFinancialItemInfoValues['entity_id']]['tax_amount'] - $previousLineItems[$updateFinancialItemInfoValues['entity_id']]['tax_amount'];
 849             $updateFinancialItemInfoValues['tax']['description'] = $this->getSalesTaxTerm();
 850           }
 851           $financialItemsArray[$updateFinancialItemInfoValues['entity_id']] = $updateFinancialItemInfoValues;
 852         }
 853       }
 854     }
 855
 856     return $financialItemsArray;
 857   }
 858
 859   /**
 860    * Helper function to return sum of financial item's amount related to a line-item
 861    * @param array $lineItemID
 862    *
 863    * @return float $financialItem
 864    */
 865   protected function checkFinancialItemTotalAmountByLineItemID($lineItemID) {
 866     return CRM_Core_DAO::singleValueQuery("
 867       SELECT SUM(amount)
 868       FROM civicrm_financial_item
 869       WHERE entity_table = 'civicrm_line_item' AND entity_id = {$lineItemID}
 870     ");
 871   }
 872
 873   /**
 874    * Helper function to retrieve submitted line items from form values $inputParams and used $feeBlock
 875    *
 876    * @param array $inputParams
 877    * @param array $feeBlock
 878    *
 879    * @return array
 880    *   List of submitted line items
 881    */
 882   protected function getSubmittedLineItems($inputParams, $feeBlock) {
 883     $submittedLineItems = [];
 884     foreach ($feeBlock as $id => $values) {
 885       CRM_Price_BAO_LineItem::format($id, $inputParams, $values, $submittedLineItems);
 886     }
 887
 888     return $submittedLineItems;
 889   }
 890
 891   /**
 892    *  Helper function to retrieve line items that need to be altered.
 893    *
 894    * We iterate through the previous line items for the given entity to determine
 895    * what alterations to line items need to be made to reflect the new line items.
 896    *
 897    * There are 4 possible changes required - per the keys in the return array.
 898    *
 899    * @param array $submittedLineItems
 900    * @param int $entityID
 901    * @param string $entity
 902    *
 903    * @return array
 904    *   Array of line items to alter with the following keys
 905    *   - line_items_to_add. If the line items required are new radio options that
 906    *     have not previously been set then we should add line items for them
 907    *   - line_items_to_update. If we have already been an active option and a change has
 908    *     happened then it should be in this array.
 909    *   - line_items_to_cancel. Line items currently selected but not selected in the new selection.
 910    *     These need to be zero'd out.
 911    *   - line_items_to_resurrect. Line items previously selected and then deselected. These need to be
 912    *     re-enabled rather than a new one added.
 913    */
 914   protected function getLineItemsToAlter($submittedLineItems, $entityID, $entity) {
 915     $previousLineItems = CRM_Price_BAO_LineItem::getLineItems($entityID, $entity);
 916
 917     $lineItemsToAdd = $submittedLineItems;
 918     $lineItemsToUpdate = [];
 919     $submittedPriceFieldValueIDs = array_keys($submittedLineItems);
 920     $lineItemsToCancel = $lineItemsToResurrect = [];
 921
 922     foreach ($previousLineItems as $id => $previousLineItem) {
 923       if (in_array($previousLineItem['price_field_value_id'], $submittedPriceFieldValueIDs)) {
 924         $submittedLineItem = $submittedLineItems[$previousLineItem['price_field_value_id']];
 925         if (CRM_Utils_Array::value('html_type', $lineItemsToAdd[$previousLineItem['price_field_value_id']]) == 'Text') {
 926           // If a 'Text' price field was updated by changing qty value, then we are not adding new line-item but updating the existing one,
 927           //  because unlike other kind of price-field, it's related price-field-value-id isn't changed and thats why we need to make an
 928           //  exception here by adding financial item for updated line-item and will reverse any previous financial item entries.
 929           $lineItemsToUpdate[$previousLineItem['price_field_value_id']] = array_merge($submittedLineItem, ['id' => $id]);
 930           unset($lineItemsToAdd[$previousLineItem['price_field_value_id']]);
 931         }
 932         else {
 933           $submittedLineItem = $submittedLineItems[$previousLineItem['price_field_value_id']];
 934           // for updating the line items i.e. use-case - once deselect-option selecting again
 935           if (($previousLineItem['line_total'] != $submittedLineItem['line_total'])
 936             || (
 937               // This would be a $0 line item - but why it should be catered to
 938               // other than when the above condition is unclear.
 939               $submittedLineItem['line_total'] == 0 && $submittedLineItem['qty'] == 1
 940             )
 941             || (
 942               $previousLineItem['qty'] != $submittedLineItem['qty']
 943             )
 944           ) {
 945             $lineItemsToUpdate[$previousLineItem['price_field_value_id']] = $submittedLineItem;
 946             $lineItemsToUpdate[$previousLineItem['price_field_value_id']]['id'] = $id;
 947             // Format is actually '0.00'
 948             if ($previousLineItem['line_total'] == 0) {
 949               $lineItemsToAdd[$previousLineItem['price_field_value_id']]['id'] = $id;
 950               $lineItemsToResurrect[] = $lineItemsToAdd[$previousLineItem['price_field_value_id']];
 951             }
 952           }
 953           // If there was previously a submitted line item for the same option value then there is
 954           // either no change or a qty adjustment. In either case we are not doing an add + reversal.
 955           unset($lineItemsToAdd[$previousLineItem['price_field_value_id']]);
 956           unset($lineItemsToCancel[$previousLineItem['price_field_value_id']]);
 957         }
 958       }
 959       else {
 960         if (!$this->isCancelled($previousLineItem)) {
 961           $cancelParams = ['qty' => 0, 'line_total' => 0, 'tax_amount' => 0, 'participant_count' => 0, 'non_deductible_amount' => 0, 'id' => $id];
 962           $lineItemsToCancel[$previousLineItem['price_field_value_id']] = array_merge($previousLineItem, $cancelParams);
 963
 964         }
 965       }
 966     }
 967
 968     return [
 969       'line_items_to_add' => $lineItemsToAdd,
 970       'line_items_to_update' => $lineItemsToUpdate,
 971       'line_items_to_cancel' => $lineItemsToCancel,
 972       'line_items_to_resurrect' => $lineItemsToResurrect,
 973     ];
 974   }
 975
 976   /**
 977    * Check if a line item has already been cancelled.
 978    *
 979    * @param array $lineItem
 980    *
 981    * @return bool
 982    */
 983   protected function isCancelled($lineItem) {
 984     if ($lineItem['qty'] == 0 && $lineItem['line_total'] == 0) {
 985       return TRUE;
 986     }
 987   }
 988
 989   /**
 990    * Add line Items as result of fee change.
 991    *
 992    * @param array $lineItemsToAdd
 993    * @param int $entityID
 994    * @param string $entityTable
 995    * @param int $contributionID
 996    */
 997   protected function addLineItemOnChangeFeeSelection(
 998     $lineItemsToAdd,
 999     $entityID,
1000     $entityTable,
1001     $contributionID
1002   ) {
1003     // if there is no line item to add, do not proceed
1004     if (empty($lineItemsToAdd)) {
1005       return;
1006     }
1007
1008     $changedFinancialTypeID = NULL;
1009     $updatedContribution = new CRM_Contribute_BAO_Contribution();
1010     $updatedContribution->id = (int) $contributionID;
1011     // insert financial items
1012     foreach ($lineItemsToAdd as $priceFieldValueID => $lineParams) {
1013       $lineParams = array_merge($lineParams, [
1014         'entity_table' => $entityTable,
1015         'entity_id' => $entityID,
1016         'contribution_id' => $contributionID,
1017       ]);
1018       if (!array_key_exists('skip', $lineParams)) {
1019         self::create($lineParams);
1020       }
1021     }
1022
1023     if ($changedFinancialTypeID) {
1024       $updatedContribution->financial_type_id = $changedFinancialTypeID;
1025       $updatedContribution->save();
1026     }
1027   }
1028
1029   /**
1030    * Add financial transactions when an array of line items is changed.
1031    *
1032    * @param array $lineItemsToAdd
1033    * @param int $entityID
1034    * @param string $entityTable
1035    * @param int $contributionID
1036    * @param bool $isCreateAdditionalFinancialTrxn
1037    *   Is there a change to the total balance requiring additional transactions to be created.
1038    */
1039   protected function addFinancialItemsOnLineItemsChange($lineItemsToAdd, $entityID, $entityTable, $contributionID, $isCreateAdditionalFinancialTrxn) {
1040     $updatedContribution = new CRM_Contribute_BAO_Contribution();
1041     $updatedContribution->id = $contributionID;
1042     $updatedContribution->find(TRUE);
1043
1044     foreach ($lineItemsToAdd as $priceFieldValueID => $lineParams) {
1045       $lineParams = array_merge($lineParams, [
1046         'entity_table' => $entityTable,
1047         'entity_id' => $entityID,
1048         'contribution_id' => $contributionID,
1049       ]);
1050       $this->addFinancialItemsOnLineItemChange($isCreateAdditionalFinancialTrxn, $lineParams, $updatedContribution);
1051     }
1052   }
1053
1054   /**
1055    * Helper function to update entity record on change fee selection
1056    *
1057    * @param array $inputParams
1058    * @param int $entityID
1059    * @param string $entity
1060    *
1061    */
1062   protected function updateEntityRecordOnChangeFeeSelection($inputParams, $entityID, $entity) {
1063     $entityTable = "civicrm_{$entity}";
1064
1065     if ($entity == 'participant') {
1066       $partUpdateFeeAmt = ['id' => $entityID];
1067       $getUpdatedLineItems = "SELECT *
1068         FROM civicrm_line_item
1069         WHERE (entity_table = '{$entityTable}' AND entity_id = {$entityID} AND qty > 0)";
1070       $getUpdatedLineItemsDAO = CRM_Core_DAO::executeQuery($getUpdatedLineItems);
1071       $line = [];
1072       while ($getUpdatedLineItemsDAO->fetch()) {
1073         $line[$getUpdatedLineItemsDAO->price_field_value_id] = $getUpdatedLineItemsDAO->label . ' - ' . (float) $getUpdatedLineItemsDAO->qty;
1074       }
1075
1076       $partUpdateFeeAmt['fee_level'] = implode(', ', $line);
1077       $partUpdateFeeAmt['fee_amount'] = $inputParams['amount'];
1078       CRM_Event_BAO_Participant::add($partUpdateFeeAmt);
1079
1080       //activity creation
1081       CRM_Event_BAO_Participant::addActivityForSelection($entityID, 'Change Registration');
1082     }
1083   }
1084
1085   /**
1086    * Get the metadata for a price field.
1087    *
1088    * @param string|int $key
1089    *   Price field id. Either as an integer or as 'price_4' where 4 is the id
1090    *
1091    * @return array
1092    *   Metadata for the price field with a values key for option values.
1093    */
1094   protected static function getPriceFieldMetaData($key) {
1095     $priceFieldID = str_replace('price_', '', $key);
1096     if (!isset(Civi::$statics[__CLASS__]['price_fields'][$priceFieldID])) {
1097       $values = civicrm_api3('PriceFieldValue', 'get', [
1098         'price_field_id' => $priceFieldID,
1099         'return' => [
1100           'id',
1101           'amount',
1102           'financial_type_id',
1103           'membership_type_id',
1104           'label',
1105           'price_field_id',
1106           'price_field_id.price_set_id',
1107           'price_field_id.html_type',
1108           'is_enter_qty',
1109         ],
1110       ]);
1111       $firstValue = reset($values['values']);
1112       $values = $values['values'];
1113       foreach ($values as $index => $value) {
1114         // Let's be nice to calling functions & ensure membership_type_id is set
1115         // so they don't have to handle notices on it. Handle one place not many.
1116         if (!isset($value['membership_type_id'])) {
1117           $values[$index]['membership_type_id'] = NULL;
1118         }
1119       }
1120
1121       Civi::$statics[__CLASS__]['price_fields'][$priceFieldID] = [
1122         'price_set_id' => $firstValue['price_field_id.price_set_id'],
1123         'id' => $firstValue['price_field_id'],
1124         'html_type' => $firstValue['price_field_id.html_type'],
1125         'is_enter_qty' => !empty($firstValue['is_enter_qty']),
1126         'values' => $values,
1127       ];
1128     }
1129     return Civi::$statics[__CLASS__]['price_fields'][$priceFieldID];
1130   }
1131
1132   /**
1133    * Helper function to retrieve financial trxn parameters to reverse
1134    *  for given financial item identified by $financialItemID
1135    *
1136    * @param int $financialItemID
1137    *
1138    * @return array $financialTrxn
1139    *
1140    */
1141   protected function _getRelatedCancelFinancialTrxn($financialItemID) {
1142     try {
1143       $financialTrxn = civicrm_api3('EntityFinancialTrxn', 'getsingle', [
1144         'entity_table' => 'civicrm_financial_item',
1145         'entity_id' => $financialItemID,
1146         'options' => [
1147           'sort' => 'id DESC',
1148           'limit' => 1,
1149         ],
1150         'api.FinancialTrxn.getsingle' => [
1151           'id' => "\$value.financial_trxn_id",
1152         ],
1153       ]);
1154     }
1155     catch (CiviCRM_API3_Exception $e) {
1156       return [];
1157     }
1158
1159     $financialTrxn = array_merge($financialTrxn['api.FinancialTrxn.getsingle'], [
1160       'trxn_date' => date('YmdHis'),
1161       'total_amount' => -$financialTrxn['api.FinancialTrxn.getsingle']['total_amount'],
1162       'net_amount' => -$financialTrxn['api.FinancialTrxn.getsingle']['net_amount'],
1163       'entity_table' => 'civicrm_financial_item',
1164       'entity_id' => $financialItemID,
1165     ]);
1166     unset($financialTrxn['id']);
1167
1168     return $financialTrxn;
1169   }
1170
1171   /**
1172    * Record adjusted amount.
1173    *
1174    * @param int $updatedAmount
1175    * @param int $contributionId
1176    * @param int $taxAmount
1177    * @param bool $updateAmountLevel
1178    *
1179    * @return bool|\CRM_Core_BAO_FinancialTrxn
1180    */
1181   protected function _recordAdjustedAmt($updatedAmount, $contributionId, $taxAmount = NULL, $updateAmountLevel = NULL) {
1182     $paidAmount = CRM_Core_BAO_FinancialTrxn::getTotalPayments($contributionId);
1183     $balanceAmt = $updatedAmount - $paidAmount;
1184
1185     $contributionStatuses = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');
1186     $partiallyPaidStatusId = array_search('Partially paid', $contributionStatuses);
1187     $pendingRefundStatusId = array_search('Pending refund', $contributionStatuses);
1188     $completedStatusId = array_search('Completed', $contributionStatuses);
1189
1190     $updatedContributionDAO = new CRM_Contribute_BAO_Contribution();
1191     $adjustedTrxn = $skip = FALSE;
1192     if ($balanceAmt) {
1193       if ($balanceAmt > 0 && $paidAmount != 0) {
1194         $contributionStatusVal = $partiallyPaidStatusId;
1195       }
1196       elseif ($balanceAmt < 0 && $paidAmount != 0) {
1197         $contributionStatusVal = $pendingRefundStatusId;
1198       }
1199       elseif ($paidAmount == 0) {
1200         //skip updating the contribution status if no payment is made
1201         $skip = TRUE;
1202         $updatedContributionDAO->cancel_date = 'null';
1203         $updatedContributionDAO->cancel_reason = NULL;
1204       }
1205       // update contribution status and total amount without trigger financial code
1206       // as this is handled in current BAO function used for change selection
1207       $updatedContributionDAO->id = $contributionId;
1208       if (!$skip) {
1209         $updatedContributionDAO->contribution_status_id = $contributionStatusVal;
1210       }
1211       $updatedContributionDAO->total_amount = $updatedContributionDAO->net_amount = $updatedAmount;
1212       $updatedContributionDAO->fee_amount = 0;
1213       $updatedContributionDAO->tax_amount = $taxAmount;
1214       if (!empty($updateAmountLevel)) {
1215         $updatedContributionDAO->amount_level = $updateAmountLevel;
1216       }
1217       $updatedContributionDAO->save();
1218       // adjusted amount financial_trxn creation
1219       $updatedContribution = CRM_Contribute_BAO_Contribution::getValues(
1220         ['id' => $contributionId]
1221       );
1222       $toFinancialAccount = CRM_Contribute_PseudoConstant::getRelationalFinancialAccount($updatedContribution->financial_type_id, 'Accounts Receivable Account is');
1223       $adjustedTrxnValues = [
1224         'from_financial_account_id' => NULL,
1225         'to_financial_account_id' => $toFinancialAccount,
1226         'total_amount' => $balanceAmt,
1227         'net_amount' => $balanceAmt,
1228         'status_id' => $completedStatusId,
1229         'payment_instrument_id' => $updatedContribution->payment_instrument_id,
1230         'contribution_id' => $updatedContribution->id,
1231         'trxn_date' => date('YmdHis'),
1232         'currency' => $updatedContribution->currency,
1233       ];
1234       $adjustedTrxn = CRM_Core_BAO_FinancialTrxn::create($adjustedTrxnValues);
1235     }
1236     // CRM-17151: Update the contribution status to completed if balance is zero,
1237     //  because due to sucessive fee change will leave the related contribution status incorrect
1238     else {
1239       CRM_Core_DAO::setFieldValue('CRM_Contribute_DAO_Contribution', $contributionId, 'contribution_status_id', $completedStatusId);
1240     }
1241
1242     return $adjustedTrxn;
1243   }
1244
1245   /**
1246    * Add financial items to reflect line item change.
1247    *
1248    * @param bool $isCreateAdditionalFinancialTrxn
1249    * @param array $lineParams
1250    * @param \CRM_Contribute_BAO_Contribution $updatedContribution
1251    */
1252   protected function addFinancialItemsOnLineItemChange($isCreateAdditionalFinancialTrxn, $lineParams, $updatedContribution) {
1253     $tempFinancialTrxnID = NULL;
1254     // don't add financial item for cancelled line item
1255     if ($lineParams['qty'] == 0) {
1256       return;
1257     }
1258     elseif ($isCreateAdditionalFinancialTrxn) {
1259       // This routine & the return below is super uncomfortable.
1260       // I have refactored to here but don't understand how this would be hit
1261       // and it is how it would be a good thing, given the odd return below which
1262       // does not seem consistent with what is going on.
1263       // I'm tempted to add an e-deprecated into it to confirm my suspicion it only exists to
1264       // cause mental anguish.
1265       // original comment : add financial item if ONLY financial type is changed
1266       if ($lineParams['financial_type_id'] != $updatedContribution->financial_type_id) {
1267         $changedFinancialTypeID = (int) $lineParams['financial_type_id'];
1268         $adjustedTrxnValues = [
1269           'from_financial_account_id' => NULL,
1270           'to_financial_account_id' => CRM_Financial_BAO_FinancialTypeAccount::getInstrumentFinancialAccount($updatedContribution->payment_instrument_id),
1271           'total_amount' => $lineParams['line_total'],
1272           'net_amount' => $lineParams['line_total'],
1273           'status_id' => $updatedContribution->contribution_status_id,
1274           'payment_instrument_id' => $updatedContribution->payment_instrument_id,
1275           'contribution_id' => $updatedContribution->id,
1276           'is_payment' => TRUE,
1277           // since balance is 0, which means contribution is completed
1278           'trxn_date' => date('YmdHis'),
1279           'currency' => $updatedContribution->currency,
1280         ];
1281         $adjustedTrxn = CRM_Core_BAO_FinancialTrxn::create($adjustedTrxnValues);
1282         $tempFinancialTrxnID = ['id' => $adjustedTrxn->id];
1283       }
1284     }
1285     $lineObj = CRM_Price_BAO_LineItem::retrieve($lineParams);
1286     // insert financial items
1287     // ensure entity_financial_trxn table has a linking of it.
1288     CRM_Financial_BAO_FinancialItem::add($lineObj, $updatedContribution, NULL, $tempFinancialTrxnID);
1289     if (isset($lineObj->tax_amount)) {
1290       CRM_Financial_BAO_FinancialItem::add($lineObj, $updatedContribution, TRUE, $tempFinancialTrxnID);
1291     }
1292   }
1293
1294   /**
1295    * Get Financial items, culling out any that have already been reversed.
1296    *
1297    * @param int $entityID
1298    * @param string $entityTable
1299    *
1300    * @return array
1301    *   Array of financial items that have not be reversed.
1302    */
1303   protected function getNonCancelledFinancialItems($entityID, $entityTable) {
1304     // gathering necessary info to record negative (deselected) financial_item
1305     $updateFinancialItem = "
1306   SELECT fi.*, price_field_value_id, financial_type_id, tax_amount
1307     FROM civicrm_financial_item fi LEFT JOIN civicrm_line_item li ON (li.id = fi.entity_id AND fi.entity_table = 'civicrm_line_item')
1308   WHERE (li.entity_table = '{$entityTable}' AND li.entity_id = {$entityID})
1309   GROUP BY li.entity_table, li.entity_id, price_field_value_id, fi.id
1310     ";
1311     $updateFinancialItemInfoDAO = CRM_Core_DAO::executeQuery($updateFinancialItem);
1312
1313     $financialItemResult = $updateFinancialItemInfoDAO->fetchAll();
1314     $items = [];
1315     foreach ($financialItemResult as $index => $financialItem) {
1316       $items[$financialItem['price_field_value_id']][$index] = $financialItem['amount'];
1317
1318       if (!empty($items[$financialItem['price_field_value_id']])) {
1319         foreach ($items[$financialItem['price_field_value_id']] as $existingItemID => $existingAmount) {
1320           if ($financialItem['amount'] + $existingAmount == 0) {
1321             // Filter both rows as they cancel each other out.
1322             unset($financialItemResult[$index]);
1323             unset($financialItemResult[$existingItemID]);
1324             unset($items['price_field_value_id'][$existingItemID]);
1325             unset($items[$financialItem['price_field_value_id']][$index]);
1326           }
1327         }
1328
1329       }
1330
1331     }
1332     return $financialItemResult;
1333   }
1334
1335   /**
1336    * Get the string used to describe the sales tax (eg. VAT, GST).
1337    *
1338    * @return string
1339    */
1340   protected function getSalesTaxTerm() {
1341     return CRM_Contribute_BAO_Contribution::checkContributeSettings('tax_term');
1342   }
1343
1344 }