1168 lines
46 KiB
PHP
1168 lines
46 KiB
PHP
|
<?php
|
||
|
|
/*
|
||
|
|
+--------------------------------------------------------------------+
|
||
|
|
| CiviCRM version 4.7 |
|
||
|
|
+--------------------------------------------------------------------+
|
||
|
|
| Copyright CiviCRM LLC (c) 2004-2017 |
|
||
|
|
+--------------------------------------------------------------------+
|
||
|
|
| This file is a part of CiviCRM. |
|
||
|
|
| |
|
||
|
|
| CiviCRM is free software; you can copy, modify, and distribute it |
|
||
|
|
| under the terms of the GNU Affero General Public License |
|
||
|
|
| Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
|
||
|
|
| |
|
||
|
|
| CiviCRM is distributed in the hope that it will be useful, but |
|
||
|
|
| WITHOUT ANY WARRANTY; without even the implied warranty of |
|
||
|
|
| MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
|
||
|
|
| See the GNU Affero General Public License for more details. |
|
||
|
|
| |
|
||
|
|
| You should have received a copy of the GNU Affero General Public |
|
||
|
|
| License and the CiviCRM Licensing Exception along |
|
||
|
|
| with this program; if not, contact CiviCRM LLC |
|
||
|
|
| at info[AT]civicrm[DOT]org. If you have questions about the |
|
||
|
|
| GNU Affero General Public License or the licensing of CiviCRM, |
|
||
|
|
| see the CiviCRM license FAQ at http://civicrm.org/licensing |
|
||
|
|
+--------------------------------------------------------------------+
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
*
|
||
|
|
* @package CRM
|
||
|
|
* @copyright CiviCRM LLC (c) 2004-2017
|
||
|
|
* $Id$
|
||
|
|
*
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
*
|
||
|
|
* @package CRM
|
||
|
|
* @author Marshal Newrock <marshal@idealso.com>
|
||
|
|
* $Id$
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Business objects for Line Items generated by monetary transactions
|
||
|
|
*/
|
||
|
|
class CRM_Price_BAO_LineItem extends CRM_Price_DAO_LineItem {
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Creates a new entry in the database.
|
||
|
|
*
|
||
|
|
* @param array $params
|
||
|
|
* (reference) an assoc array of name/value pairs.
|
||
|
|
*
|
||
|
|
* @return \CRM_Price_DAO_LineItem
|
||
|
|
*
|
||
|
|
* @throws \CiviCRM_API3_Exception
|
||
|
|
* @throws \Exception
|
||
|
|
*/
|
||
|
|
public static function create(&$params) {
|
||
|
|
$id = CRM_Utils_Array::value('id', $params);
|
||
|
|
if ($id) {
|
||
|
|
CRM_Utils_Hook::pre('edit', 'LineItem', $id, $params);
|
||
|
|
$op = CRM_Core_Action::UPDATE;
|
||
|
|
}
|
||
|
|
else {
|
||
|
|
CRM_Utils_Hook::pre('create', 'LineItem', $params['entity_id'], $params);
|
||
|
|
$op = CRM_Core_Action::ADD;
|
||
|
|
}
|
||
|
|
|
||
|
|
// unset entity table and entity id in $params
|
||
|
|
// we never update the entity table and entity id during update mode
|
||
|
|
if ($id) {
|
||
|
|
$entity_id = CRM_Utils_Array::value('entity_id', $params);
|
||
|
|
$entity_table = CRM_Utils_Array::value('entity_table', $params);
|
||
|
|
unset($params['entity_id'], $params['entity_table']);
|
||
|
|
}
|
||
|
|
else {
|
||
|
|
if (!isset($params['unit_price'])) {
|
||
|
|
$params['unit_price'] = 0;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
if (CRM_Financial_BAO_FinancialType::isACLFinancialTypeStatus() && CRM_Utils_Array::value('check_permissions', $params)) {
|
||
|
|
if (empty($params['financial_type_id'])) {
|
||
|
|
throw new Exception('Mandatory key(s) missing from params array: financial_type_id');
|
||
|
|
}
|
||
|
|
CRM_Financial_BAO_FinancialType::getAvailableFinancialTypes($types, $op);
|
||
|
|
if (!in_array($params['financial_type_id'], array_keys($types))) {
|
||
|
|
throw new Exception('You do not have permission to create this line item');
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
$lineItemBAO = new CRM_Price_BAO_LineItem();
|
||
|
|
$lineItemBAO->copyValues($params);
|
||
|
|
|
||
|
|
$return = $lineItemBAO->save();
|
||
|
|
if ($lineItemBAO->entity_table == 'civicrm_membership' && $lineItemBAO->contribution_id && $lineItemBAO->entity_id) {
|
||
|
|
$membershipPaymentParams = array(
|
||
|
|
'membership_id' => $lineItemBAO->entity_id,
|
||
|
|
'contribution_id' => $lineItemBAO->contribution_id,
|
||
|
|
);
|
||
|
|
if (!civicrm_api3('MembershipPayment', 'getcount', $membershipPaymentParams)) {
|
||
|
|
civicrm_api3('MembershipPayment', 'create', $membershipPaymentParams);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
if ($id) {
|
||
|
|
// CRM-21281: Restore entity reference in case the post hook needs it
|
||
|
|
$lineItemBAO->entity_id = $entity_id;
|
||
|
|
$lineItemBAO->entity_table = $entity_table;
|
||
|
|
CRM_Utils_Hook::post('edit', 'LineItem', $id, $lineItemBAO);
|
||
|
|
}
|
||
|
|
else {
|
||
|
|
CRM_Utils_Hook::post('create', 'LineItem', $lineItemBAO->id, $lineItemBAO);
|
||
|
|
}
|
||
|
|
|
||
|
|
return $return;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Retrieve DB object based on input parameters.
|
||
|
|
*
|
||
|
|
* It also stores all the retrieved values in the default array.
|
||
|
|
*
|
||
|
|
* @param array $params
|
||
|
|
* (reference ) an assoc array of name/value pairs.
|
||
|
|
* @param array $defaults
|
||
|
|
* (reference ) an assoc array to hold the flattened values.
|
||
|
|
*
|
||
|
|
* @return CRM_Price_BAO_LineItem
|
||
|
|
*/
|
||
|
|
public static function retrieve(&$params, &$defaults) {
|
||
|
|
$lineItem = new CRM_Price_BAO_LineItem();
|
||
|
|
$lineItem->copyValues($params);
|
||
|
|
if ($lineItem->find(TRUE)) {
|
||
|
|
CRM_Core_DAO::storeValues($lineItem, $defaults);
|
||
|
|
return $lineItem;
|
||
|
|
}
|
||
|
|
return NULL;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Modifies $params array for filtering financial types.
|
||
|
|
*
|
||
|
|
* @param array $params
|
||
|
|
* (reference ) an assoc array of name/value pairs.
|
||
|
|
*
|
||
|
|
*/
|
||
|
|
public static function getAPILineItemParams(&$params) {
|
||
|
|
CRM_Financial_BAO_FinancialType::getAvailableFinancialTypes($types);
|
||
|
|
if ($types && empty($params['financial_type_id'])) {
|
||
|
|
$params['financial_type_id'] = array('IN' => array_keys($types));
|
||
|
|
}
|
||
|
|
elseif ($types) {
|
||
|
|
if (is_array($params['financial_type_id'])) {
|
||
|
|
$invalidFts = array_diff($params['financial_type_id'], array_keys($types));
|
||
|
|
}
|
||
|
|
elseif (!in_array($params['financial_type_id'], array_keys($types))) {
|
||
|
|
$invalidFts = $params['financial_type_id'];
|
||
|
|
}
|
||
|
|
if ($invalidFts) {
|
||
|
|
$params['financial_type_id'] = array('NOT IN' => $invalidFts);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
else {
|
||
|
|
$params['financial_type_id'] = 0;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @param int $contributionId
|
||
|
|
*
|
||
|
|
* @return null|string
|
||
|
|
*/
|
||
|
|
public static function getLineTotal($contributionId) {
|
||
|
|
$sqlLineItemTotal = "SELECT SUM(li.line_total + COALESCE(li.tax_amount,0))
|
||
|
|
FROM civicrm_line_item li
|
||
|
|
WHERE li.contribution_id = %1";
|
||
|
|
$params = array(1 => array($contributionId, 'Integer'));
|
||
|
|
$lineItemTotal = CRM_Core_DAO::singleValueQuery($sqlLineItemTotal, $params);
|
||
|
|
return $lineItemTotal;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Wrapper for line item retrieval when contribution ID is known.
|
||
|
|
* @param int $contributionID
|
||
|
|
*
|
||
|
|
* @return array
|
||
|
|
*/
|
||
|
|
public static function getLineItemsByContributionID($contributionID) {
|
||
|
|
return self::getLineItems($contributionID, 'contribution', NULL, TRUE, TRUE, " WHERE contribution_id = " . (int) $contributionID);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Given a participant id/contribution id,
|
||
|
|
* return contribution/fee line items
|
||
|
|
*
|
||
|
|
* @param int $entityId
|
||
|
|
* participant/contribution id.
|
||
|
|
* @param string $entity
|
||
|
|
* participant/contribution.
|
||
|
|
*
|
||
|
|
* @param bool $isQuick
|
||
|
|
* @param bool $isQtyZero
|
||
|
|
* @param bool $relatedEntity
|
||
|
|
*
|
||
|
|
* @param bool $invoice
|
||
|
|
* @return array
|
||
|
|
* Array of line items
|
||
|
|
*/
|
||
|
|
public static function getLineItems($entityId, $entity = 'participant', $isQuick = FALSE, $isQtyZero = TRUE, $relatedEntity = FALSE, $invoice = FALSE) {
|
||
|
|
$whereClause = $fromClause = NULL;
|
||
|
|
$selectClause = "
|
||
|
|
SELECT li.id,
|
||
|
|
li.label,
|
||
|
|
li.contribution_id,
|
||
|
|
li.qty,
|
||
|
|
li.unit_price,
|
||
|
|
li.line_total,
|
||
|
|
li.entity_table,
|
||
|
|
li.entity_id,
|
||
|
|
pf.label as field_title,
|
||
|
|
pf.html_type,
|
||
|
|
pf.price_set_id,
|
||
|
|
pfv.membership_type_id,
|
||
|
|
pfv.membership_num_terms,
|
||
|
|
li.price_field_id,
|
||
|
|
li.participant_count,
|
||
|
|
li.price_field_value_id,
|
||
|
|
li.financial_type_id,
|
||
|
|
li.tax_amount,
|
||
|
|
pfv.description";
|
||
|
|
|
||
|
|
$condition = "li.entity_id = %2.id AND li.entity_table = 'civicrm_%2'";
|
||
|
|
if ($relatedEntity) {
|
||
|
|
$condition = "li.contribution_id = %2.id ";
|
||
|
|
}
|
||
|
|
|
||
|
|
$fromClause = "
|
||
|
|
FROM civicrm_%2 as %2
|
||
|
|
LEFT JOIN civicrm_line_item li ON ({$condition})
|
||
|
|
LEFT JOIN civicrm_price_field_value pfv ON ( pfv.id = li.price_field_value_id )
|
||
|
|
LEFT JOIN civicrm_price_field pf ON (pf.id = li.price_field_id )";
|
||
|
|
$whereClause = "
|
||
|
|
WHERE %2.id = %1";
|
||
|
|
|
||
|
|
// CRM-16250 get additional participant's fee selection details only for invoice PDF (if any)
|
||
|
|
if ($entity == 'participant' && $invoice) {
|
||
|
|
$additionalParticipantIDs = CRM_Event_BAO_Participant::getAdditionalParticipantIds($entityId);
|
||
|
|
if (!empty($additionalParticipantIDs)) {
|
||
|
|
$whereClause = "WHERE %2.id IN (%1, " . implode(', ', $additionalParticipantIDs) . ")";
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
$orderByClause = " ORDER BY pf.weight, pfv.weight";
|
||
|
|
|
||
|
|
if ($isQuick) {
|
||
|
|
$fromClause .= " LEFT JOIN civicrm_price_set cps on cps.id = pf.price_set_id ";
|
||
|
|
$whereClause .= " and cps.is_quick_config = 0";
|
||
|
|
}
|
||
|
|
|
||
|
|
if (!$isQtyZero) {
|
||
|
|
$whereClause .= " and li.qty != 0";
|
||
|
|
}
|
||
|
|
|
||
|
|
$lineItems = array();
|
||
|
|
|
||
|
|
if (!$entityId || !$entity || !$fromClause) {
|
||
|
|
return $lineItems;
|
||
|
|
}
|
||
|
|
|
||
|
|
$params = array(
|
||
|
|
1 => array($entityId, 'Integer'),
|
||
|
|
2 => array($entity, 'Text'),
|
||
|
|
);
|
||
|
|
|
||
|
|
$getTaxDetails = FALSE;
|
||
|
|
$invoiceSettings = Civi::settings()->get('contribution_invoice_settings');
|
||
|
|
$invoicing = CRM_Utils_Array::value('invoicing', $invoiceSettings);
|
||
|
|
|
||
|
|
$dao = CRM_Core_DAO::executeQuery("$selectClause $fromClause $whereClause $orderByClause", $params);
|
||
|
|
while ($dao->fetch()) {
|
||
|
|
if (!$dao->id) {
|
||
|
|
continue;
|
||
|
|
}
|
||
|
|
$lineItems[$dao->id] = array(
|
||
|
|
'qty' => (float) $dao->qty,
|
||
|
|
'label' => $dao->label,
|
||
|
|
'unit_price' => $dao->unit_price,
|
||
|
|
'line_total' => $dao->line_total,
|
||
|
|
'price_field_id' => $dao->price_field_id,
|
||
|
|
'participant_count' => $dao->participant_count,
|
||
|
|
'price_field_value_id' => $dao->price_field_value_id,
|
||
|
|
'field_title' => $dao->field_title,
|
||
|
|
'html_type' => $dao->html_type,
|
||
|
|
'description' => $dao->description,
|
||
|
|
'entity_id' => $dao->entity_id,
|
||
|
|
'entity_table' => $dao->entity_table,
|
||
|
|
'contribution_id' => $dao->contribution_id,
|
||
|
|
'financial_type_id' => $dao->financial_type_id,
|
||
|
|
'financial_type' => CRM_Core_PseudoConstant::getLabel('CRM_Contribute_BAO_Contribution', 'financial_type_id', $dao->financial_type_id),
|
||
|
|
'membership_type_id' => $dao->membership_type_id,
|
||
|
|
'membership_num_terms' => $dao->membership_num_terms,
|
||
|
|
'tax_amount' => $dao->tax_amount,
|
||
|
|
'price_set_id' => $dao->price_set_id,
|
||
|
|
);
|
||
|
|
$taxRates = CRM_Core_PseudoConstant::getTaxRates();
|
||
|
|
if (isset($lineItems[$dao->id]['financial_type_id']) && array_key_exists($lineItems[$dao->id]['financial_type_id'], $taxRates)) {
|
||
|
|
// Cast to float so trailing zero decimals are removed for display.
|
||
|
|
$lineItems[$dao->id]['tax_rate'] = (float) $taxRates[$lineItems[$dao->id]['financial_type_id']];
|
||
|
|
}
|
||
|
|
else {
|
||
|
|
// There is no Tax Rate associated with this Financial Type
|
||
|
|
$lineItems[$dao->id]['tax_rate'] = FALSE;
|
||
|
|
}
|
||
|
|
$lineItems[$dao->id]['subTotal'] = $lineItems[$dao->id]['qty'] * $lineItems[$dao->id]['unit_price'];
|
||
|
|
if ($lineItems[$dao->id]['tax_amount'] != '') {
|
||
|
|
$getTaxDetails = TRUE;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
if ($invoicing) {
|
||
|
|
$taxTerm = CRM_Utils_Array::value('tax_term', $invoiceSettings);
|
||
|
|
$smarty = CRM_Core_Smarty::singleton();
|
||
|
|
$smarty->assign('taxTerm', $taxTerm);
|
||
|
|
$smarty->assign('getTaxDetails', $getTaxDetails);
|
||
|
|
}
|
||
|
|
return $lineItems;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* This method will create the lineItem array required for
|
||
|
|
* processAmount method
|
||
|
|
*
|
||
|
|
* @param int $fid
|
||
|
|
* Price set field id.
|
||
|
|
* @param array $params
|
||
|
|
* Reference to form values.
|
||
|
|
* @param array $fields
|
||
|
|
* Array of fields belonging to the price set used for particular event
|
||
|
|
* @param array $values
|
||
|
|
* Reference to the values array(.
|
||
|
|
* this is
|
||
|
|
* lineItem array)
|
||
|
|
* @param string $amount_override
|
||
|
|
* Amount override must be in format 1000.00 - ie no thousand separator & if
|
||
|
|
* a decimal point is used it should be a decimal
|
||
|
|
*
|
||
|
|
* @todo - this parameter is only used for partial payments. It's unclear why a partial
|
||
|
|
* payment would change the line item price.
|
||
|
|
*/
|
||
|
|
public static function format($fid, $params, $fields, &$values, $amount_override = NULL) {
|
||
|
|
if (empty($params["price_{$fid}"])) {
|
||
|
|
return;
|
||
|
|
}
|
||
|
|
|
||
|
|
//lets first check in fun parameter,
|
||
|
|
//since user might modified w/ hooks.
|
||
|
|
$options = array();
|
||
|
|
if (array_key_exists('options', $fields)) {
|
||
|
|
$options = $fields['options'];
|
||
|
|
}
|
||
|
|
else {
|
||
|
|
CRM_Price_BAO_PriceFieldValue::getValues($fid, $options, 'weight', TRUE);
|
||
|
|
}
|
||
|
|
$fieldTitle = CRM_Utils_Array::value('label', $fields);
|
||
|
|
if (!$fieldTitle) {
|
||
|
|
$fieldTitle = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceField', $fid, 'label');
|
||
|
|
}
|
||
|
|
|
||
|
|
foreach ($params["price_{$fid}"] as $oid => $qty) {
|
||
|
|
$price = $amount_override === NULL ? $options[$oid]['amount'] : $amount_override;
|
||
|
|
|
||
|
|
$participantsPerField = CRM_Utils_Array::value('count', $options[$oid], 0);
|
||
|
|
|
||
|
|
$values[$oid] = array(
|
||
|
|
'price_field_id' => $fid,
|
||
|
|
'price_field_value_id' => $oid,
|
||
|
|
'label' => CRM_Utils_Array::value('label', $options[$oid]),
|
||
|
|
'field_title' => $fieldTitle,
|
||
|
|
'description' => CRM_Utils_Array::value('description', $options[$oid]),
|
||
|
|
'qty' => $qty,
|
||
|
|
'unit_price' => $price,
|
||
|
|
'line_total' => $qty * $price,
|
||
|
|
'participant_count' => $qty * $participantsPerField,
|
||
|
|
'max_value' => CRM_Utils_Array::value('max_value', $options[$oid]),
|
||
|
|
'membership_type_id' => CRM_Utils_Array::value('membership_type_id', $options[$oid]),
|
||
|
|
'membership_num_terms' => CRM_Utils_Array::value('membership_num_terms', $options[$oid]),
|
||
|
|
'auto_renew' => CRM_Utils_Array::value('auto_renew', $options[$oid]),
|
||
|
|
'html_type' => $fields['html_type'],
|
||
|
|
'financial_type_id' => CRM_Utils_Array::value('financial_type_id', $options[$oid]),
|
||
|
|
'tax_amount' => CRM_Utils_Array::value('tax_amount', $options[$oid]),
|
||
|
|
'non_deductible_amount' => CRM_Utils_Array::value('non_deductible_amount', $options[$oid]),
|
||
|
|
);
|
||
|
|
|
||
|
|
if ($values[$oid]['membership_type_id'] && empty($values[$oid]['auto_renew'])) {
|
||
|
|
$values[$oid]['auto_renew'] = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipType', $values[$oid]['membership_type_id'], 'auto_renew');
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Delete line items for given entity.
|
||
|
|
*
|
||
|
|
* @param int $entityId
|
||
|
|
* @param int $entityTable
|
||
|
|
*
|
||
|
|
* @return bool
|
||
|
|
*/
|
||
|
|
public static function deleteLineItems($entityId, $entityTable) {
|
||
|
|
if (!$entityId || !$entityTable) {
|
||
|
|
return FALSE;
|
||
|
|
}
|
||
|
|
|
||
|
|
if ($entityId && !is_array($entityId)) {
|
||
|
|
$entityId = array($entityId);
|
||
|
|
}
|
||
|
|
|
||
|
|
$query = "DELETE FROM civicrm_line_item where entity_id IN ('" . implode("','", $entityId) . "') AND entity_table = '$entityTable'";
|
||
|
|
$dao = CRM_Core_DAO::executeQuery($query);
|
||
|
|
return TRUE;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Process price set and line items.
|
||
|
|
*
|
||
|
|
* @param int $entityId
|
||
|
|
* @param array $lineItem
|
||
|
|
* Line item array.
|
||
|
|
* @param object $contributionDetails
|
||
|
|
* @param string $entityTable
|
||
|
|
* Entity table.
|
||
|
|
*
|
||
|
|
* @param bool $update
|
||
|
|
*
|
||
|
|
* @return void
|
||
|
|
*/
|
||
|
|
public static function processPriceSet($entityId, $lineItem, $contributionDetails = NULL, $entityTable = 'civicrm_contribution', $update = FALSE) {
|
||
|
|
if (!$entityId || !is_array($lineItem)
|
||
|
|
|| CRM_Utils_system::isNull($lineItem)
|
||
|
|
) {
|
||
|
|
return;
|
||
|
|
}
|
||
|
|
|
||
|
|
foreach ($lineItem as $priceSetId => &$values) {
|
||
|
|
if (!$priceSetId) {
|
||
|
|
continue;
|
||
|
|
}
|
||
|
|
|
||
|
|
foreach ($values as &$line) {
|
||
|
|
if (empty($line['entity_table'])) {
|
||
|
|
$line['entity_table'] = $entityTable;
|
||
|
|
}
|
||
|
|
if (empty($line['entity_id'])) {
|
||
|
|
$line['entity_id'] = $entityId;
|
||
|
|
}
|
||
|
|
if (!empty($line['membership_type_id'])) {
|
||
|
|
$line['entity_table'] = 'civicrm_membership';
|
||
|
|
}
|
||
|
|
if (!empty($contributionDetails->id)) {
|
||
|
|
$line['contribution_id'] = $contributionDetails->id;
|
||
|
|
if ($line['entity_table'] == 'civicrm_contribution') {
|
||
|
|
$line['entity_id'] = $contributionDetails->id;
|
||
|
|
}
|
||
|
|
// CRM-19094: entity_table is set to civicrm_membership then ensure
|
||
|
|
// the entityId is set to membership ID not contribution by default
|
||
|
|
elseif ($line['entity_table'] == 'civicrm_membership' && !empty($line['entity_id']) && $line['entity_id'] == $contributionDetails->id) {
|
||
|
|
$membershipId = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipPayment', 'contribution_id', $line['entity_id'], 'membership_id');
|
||
|
|
$line['entity_id'] = $membershipId ? $membershipId : $line['entity_id'];
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
// if financial type is not set and if price field value is NOT NULL
|
||
|
|
// get financial type id of price field value
|
||
|
|
if (!empty($line['price_field_value_id']) && empty($line['financial_type_id'])) {
|
||
|
|
$line['financial_type_id'] = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceFieldValue', $line['price_field_value_id'], 'financial_type_id');
|
||
|
|
}
|
||
|
|
$lineItems = CRM_Price_BAO_LineItem::create($line);
|
||
|
|
if (!$update && $contributionDetails) {
|
||
|
|
$financialItem = CRM_Financial_BAO_FinancialItem::add($lineItems, $contributionDetails);
|
||
|
|
$line['financial_item_id'] = $financialItem->id;
|
||
|
|
if (!empty($line['tax_amount'])) {
|
||
|
|
CRM_Financial_BAO_FinancialItem::add($lineItems, $contributionDetails, TRUE);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
if (!$update && $contributionDetails) {
|
||
|
|
CRM_Core_BAO_FinancialTrxn::createDeferredTrxn($lineItem, $contributionDetails);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @param int $entityId
|
||
|
|
* @param string $entityTable
|
||
|
|
* @param $amount
|
||
|
|
* @param array $otherParams
|
||
|
|
*/
|
||
|
|
public static function syncLineItems($entityId, $entityTable = 'civicrm_contribution', $amount, $otherParams = NULL) {
|
||
|
|
if (!$entityId || CRM_Utils_System::isNull($amount)) {
|
||
|
|
return;
|
||
|
|
}
|
||
|
|
|
||
|
|
$from = " civicrm_line_item li
|
||
|
|
LEFT JOIN civicrm_price_field pf ON pf.id = li.price_field_id
|
||
|
|
LEFT JOIN civicrm_price_set ps ON ps.id = pf.price_set_id ";
|
||
|
|
|
||
|
|
$set = " li.unit_price = %3,
|
||
|
|
li.line_total = %3 ";
|
||
|
|
|
||
|
|
$where = " li.entity_id = %1 AND
|
||
|
|
li.entity_table = %2 ";
|
||
|
|
|
||
|
|
$params = array(
|
||
|
|
1 => array($entityId, 'Integer'),
|
||
|
|
2 => array($entityTable, 'String'),
|
||
|
|
3 => array($amount, 'Float'),
|
||
|
|
);
|
||
|
|
|
||
|
|
if ($entityTable == 'civicrm_contribution') {
|
||
|
|
$entityName = 'default_contribution_amount';
|
||
|
|
$where .= " AND ps.name = %4 ";
|
||
|
|
$params[4] = array($entityName, 'String');
|
||
|
|
}
|
||
|
|
elseif ($entityTable == 'civicrm_participant') {
|
||
|
|
$from .= "
|
||
|
|
LEFT JOIN civicrm_price_set_entity cpse ON cpse.price_set_id = ps.id
|
||
|
|
LEFT JOIN civicrm_price_field_value cpfv ON cpfv.price_field_id = pf.id and cpfv.label = %4 ";
|
||
|
|
$set .= " ,li.label = %4,
|
||
|
|
li.price_field_value_id = cpfv.id ";
|
||
|
|
$where .= " AND cpse.entity_table = 'civicrm_event' AND cpse.entity_id = %5 ";
|
||
|
|
$amount = empty($amount) ? 0 : $amount;
|
||
|
|
$params += array(
|
||
|
|
4 => array($otherParams['fee_label'], 'String'),
|
||
|
|
5 => array($otherParams['event_id'], 'String'),
|
||
|
|
);
|
||
|
|
}
|
||
|
|
|
||
|
|
$query = "
|
||
|
|
UPDATE $from
|
||
|
|
SET $set
|
||
|
|
WHERE $where
|
||
|
|
";
|
||
|
|
|
||
|
|
CRM_Core_DAO::executeQuery($query, $params);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Build line items array.
|
||
|
|
*
|
||
|
|
* @param array $params
|
||
|
|
* Form values.
|
||
|
|
*
|
||
|
|
* @param string $entityId
|
||
|
|
* Entity id.
|
||
|
|
*
|
||
|
|
* @param string $entityTable
|
||
|
|
* Entity Table.
|
||
|
|
*
|
||
|
|
* @param bool $isRelatedID
|
||
|
|
*/
|
||
|
|
public static function getLineItemArray(&$params, $entityId = NULL, $entityTable = 'contribution', $isRelatedID = FALSE) {
|
||
|
|
if (!$entityId) {
|
||
|
|
$priceSetDetails = CRM_Price_BAO_PriceSet::getDefaultPriceSet($entityTable);
|
||
|
|
$totalAmount = CRM_Utils_Array::value('partial_payment_total', $params, CRM_Utils_Array::value('total_amount', $params));
|
||
|
|
$financialType = CRM_Utils_Array::value('financial_type_id', $params);
|
||
|
|
foreach ($priceSetDetails as $values) {
|
||
|
|
if ($entityTable == 'membership') {
|
||
|
|
if ($isRelatedID != $values['membership_type_id']) {
|
||
|
|
continue;
|
||
|
|
}
|
||
|
|
if (!$totalAmount) {
|
||
|
|
$totalAmount = $values['amount'];
|
||
|
|
}
|
||
|
|
$financialType = $values['financial_type_id'];
|
||
|
|
}
|
||
|
|
$params['line_item'][$values['setID']][$values['priceFieldID']] = array(
|
||
|
|
'price_field_id' => $values['priceFieldID'],
|
||
|
|
'price_field_value_id' => $values['priceFieldValueID'],
|
||
|
|
'label' => $values['label'],
|
||
|
|
'qty' => 1,
|
||
|
|
'unit_price' => $totalAmount,
|
||
|
|
'line_total' => $totalAmount,
|
||
|
|
'financial_type_id' => $financialType,
|
||
|
|
'membership_type_id' => $values['membership_type_id'],
|
||
|
|
);
|
||
|
|
break;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
else {
|
||
|
|
$setID = NULL;
|
||
|
|
$totalEntityId = count($entityId);
|
||
|
|
if ($entityTable == 'contribution') {
|
||
|
|
$isRelatedID = TRUE;
|
||
|
|
}
|
||
|
|
foreach ($entityId as $id) {
|
||
|
|
$lineItems = CRM_Price_BAO_LineItem::getLineItems($id, $entityTable, FALSE, TRUE, $isRelatedID);
|
||
|
|
foreach ($lineItems as $key => $values) {
|
||
|
|
if (!$setID && $values['price_field_id']) {
|
||
|
|
$setID = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceField', $values['price_field_id'], 'price_set_id');
|
||
|
|
$params['is_quick_config'] = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceSet', $setID, 'is_quick_config');
|
||
|
|
}
|
||
|
|
if (!empty($params['is_quick_config']) && array_key_exists('total_amount', $params)
|
||
|
|
&& $totalEntityId == 1
|
||
|
|
) {
|
||
|
|
$values['line_total'] = $values['unit_price'] = $params['total_amount'];
|
||
|
|
}
|
||
|
|
$values['id'] = $key;
|
||
|
|
$params['line_item'][$setID][$key] = $values;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Function to update related contribution of a entity and
|
||
|
|
* add/update/cancel financial records
|
||
|
|
*
|
||
|
|
* @param array $params
|
||
|
|
* @param int $entityID
|
||
|
|
* @param int $entity
|
||
|
|
* @param int $contributionId
|
||
|
|
* @param $feeBlock
|
||
|
|
* @param array $lineItems
|
||
|
|
* @param $paidAmount
|
||
|
|
*
|
||
|
|
*/
|
||
|
|
public static function changeFeeSelections(
|
||
|
|
$params,
|
||
|
|
$entityID,
|
||
|
|
$entity,
|
||
|
|
$contributionId,
|
||
|
|
$feeBlock,
|
||
|
|
$lineItems,
|
||
|
|
$paidAmount
|
||
|
|
) {
|
||
|
|
$entityTable = "civicrm_" . $entity;
|
||
|
|
CRM_Price_BAO_PriceSet::processAmount($feeBlock,
|
||
|
|
$params, $lineItems
|
||
|
|
);
|
||
|
|
// initialize empty Lineitem instance to call protected helper functions
|
||
|
|
$lineItemObj = new CRM_Price_BAO_LineItem();
|
||
|
|
|
||
|
|
// fetch submitted LineItems from input params and feeBlock information
|
||
|
|
$submittedLineItems = $lineItemObj->_getSubmittedLineItems($params, $feeBlock);
|
||
|
|
|
||
|
|
// retrieve the submitted price field value IDs from $submittedLineItems array keys
|
||
|
|
$submittedPriceFieldValueIDs = empty($submittedLineItems) ? array() : array_keys($submittedLineItems);
|
||
|
|
|
||
|
|
// get lineItems need to be updated and added to record changed fee
|
||
|
|
list($lineItemsToAdd, $lineItemsToUpdate) = $lineItemObj->_getLineItemsToAddAndUpdate($submittedLineItems, $entityID, $entity);
|
||
|
|
|
||
|
|
// cancel previous line item
|
||
|
|
$additionalWhereClause = empty($submittedPriceFieldValueIDs) ? NULL : sprintf("price_field_value_id NOT IN (%s)", implode(', ', $submittedPriceFieldValueIDs));
|
||
|
|
$lineItemObj->_cancelLineItems($entityID, $entityTable, $additionalWhereClause);
|
||
|
|
|
||
|
|
// get financial information that need to be recorded on basis on submitted price field value IDs
|
||
|
|
$financialItemsArray = $lineItemObj->_getFinancialItemsToRecord(
|
||
|
|
$entityID,
|
||
|
|
$entityTable,
|
||
|
|
$contributionId,
|
||
|
|
$submittedPriceFieldValueIDs
|
||
|
|
);
|
||
|
|
|
||
|
|
// update line item with changed line total and other information
|
||
|
|
$totalParticipant = $participantCount = 0;
|
||
|
|
$amountLevel = array();
|
||
|
|
if (!empty($lineItemsToUpdate)) {
|
||
|
|
foreach ($lineItemsToUpdate as $priceFieldValueID => $value) {
|
||
|
|
$taxAmount = "NULL";
|
||
|
|
if (isset($value['tax_amount'])) {
|
||
|
|
$taxAmount = $value['tax_amount'];
|
||
|
|
}
|
||
|
|
$amountLevel[] = $value['label'] . ' - ' . (float) $value['qty'];
|
||
|
|
if ($entity == 'participant' && isset($value['participant_count'])) {
|
||
|
|
$participantCount = $value['participant_count'];
|
||
|
|
$totalParticipant += $value['participant_count'];
|
||
|
|
}
|
||
|
|
$updateLineItemSQL = "
|
||
|
|
UPDATE civicrm_line_item li
|
||
|
|
SET li.qty = {$value['qty']},
|
||
|
|
li.line_total = {$value['line_total']},
|
||
|
|
li.tax_amount = {$taxAmount},
|
||
|
|
li.unit_price = {$value['unit_price']},
|
||
|
|
li.participant_count = {$participantCount},
|
||
|
|
li.label = %1
|
||
|
|
WHERE (li.entity_table = '{$entityTable}' AND li.entity_id = {$entityID}) AND
|
||
|
|
(price_field_value_id = {$priceFieldValueID}) ";
|
||
|
|
|
||
|
|
CRM_Core_DAO::executeQuery($updateLineItemSQL, array(1 => array($value['label'], 'String')));
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
// insert new 'adjusted amount' transaction entry and update contribution entry.
|
||
|
|
// ensure entity_financial_trxn table has a linking of it.
|
||
|
|
// insert new line items
|
||
|
|
$lineItemObj->_addLineItemOnChangeFeeSelection($lineItemsToAdd, $entityID, $entityTable, $contributionId);
|
||
|
|
|
||
|
|
// the recordAdjustedAmt code would execute over here
|
||
|
|
$count = 0;
|
||
|
|
if ($entity == 'participant') {
|
||
|
|
$count = count(CRM_Event_BAO_Participant::getParticipantIds($contributionId));
|
||
|
|
}
|
||
|
|
else {
|
||
|
|
$count = CRM_Utils_Array::value('count', civicrm_api3('MembershipPayment', 'getcount', array('contribution_id' => $contributionId)));
|
||
|
|
}
|
||
|
|
if ($count > 1) {
|
||
|
|
$updatedAmount = CRM_Price_BAO_LineItem::getLineTotal($contributionId);
|
||
|
|
}
|
||
|
|
else {
|
||
|
|
$updatedAmount = CRM_Utils_Array::value('amount', $params, CRM_Utils_Array::value('total_amount', $params));
|
||
|
|
}
|
||
|
|
if (strlen($params['tax_amount']) != 0) {
|
||
|
|
$taxAmount = $params['tax_amount'];
|
||
|
|
}
|
||
|
|
else {
|
||
|
|
$taxAmount = "NULL";
|
||
|
|
}
|
||
|
|
$displayParticipantCount = '';
|
||
|
|
if ($totalParticipant > 0) {
|
||
|
|
$displayParticipantCount = ' Participant Count -' . $totalParticipant;
|
||
|
|
}
|
||
|
|
$updateAmountLevel = NULL;
|
||
|
|
if (!empty($amountLevel)) {
|
||
|
|
$updateAmountLevel = CRM_Core_DAO::VALUE_SEPARATOR . implode(CRM_Core_DAO::VALUE_SEPARATOR, $amountLevel) . $displayParticipantCount . CRM_Core_DAO::VALUE_SEPARATOR;
|
||
|
|
}
|
||
|
|
$trxn = $lineItemObj->_recordAdjustedAmt($updatedAmount, $paidAmount, $contributionId, $taxAmount, $updateAmountLevel);
|
||
|
|
|
||
|
|
$contributionCompletedStatusID = CRM_Core_PseudoConstant::getKey('CRM_Contribute_DAO_Contribution', 'contribution_status_id', 'Completed');
|
||
|
|
if (!empty($financialItemsArray)) {
|
||
|
|
foreach ($financialItemsArray as $updateFinancialItemInfoValues) {
|
||
|
|
$newFinancialItem = CRM_Financial_BAO_FinancialItem::create($updateFinancialItemInfoValues);
|
||
|
|
// record reverse transaction only if Contribution is Completed because for pending refund or
|
||
|
|
// partially paid we are already recording the surplus owed or refund amount
|
||
|
|
if (!empty($updateFinancialItemInfoValues['financialTrxn']) && ($contributionCompletedStatusID ==
|
||
|
|
CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_Contribution', $contributionId, 'contribution_status_id'))
|
||
|
|
) {
|
||
|
|
$updateFinancialItemInfoValues = array_merge($updateFinancialItemInfoValues['financialTrxn'], array(
|
||
|
|
'entity_id' => $newFinancialItem->id,
|
||
|
|
'entity_table' => 'civicrm_financial_item',
|
||
|
|
));
|
||
|
|
$reverseTrxn = CRM_Core_BAO_FinancialTrxn::create($updateFinancialItemInfoValues);
|
||
|
|
// record reverse entity financial trxn linked to membership's related contribution
|
||
|
|
civicrm_api3('EntityFinancialTrxn', 'create', array(
|
||
|
|
'entity_table' => "civicrm_contribution",
|
||
|
|
'entity_id' => $contributionId,
|
||
|
|
'financial_trxn_id' => $reverseTrxn->id,
|
||
|
|
'amount' => $reverseTrxn->total_amount,
|
||
|
|
));
|
||
|
|
unset($updateFinancialItemInfoValues['financialTrxn']);
|
||
|
|
}
|
||
|
|
if (!empty($updateFinancialItemInfoValues['tax'])) {
|
||
|
|
$updateFinancialItemInfoValues['tax']['amount'] = $updateFinancialItemInfoValues['amount'];
|
||
|
|
$updateFinancialItemInfoValues['tax']['description'] = $updateFinancialItemInfoValues['description'];
|
||
|
|
if (!empty($updateFinancialItemInfoValues['financial_account_id'])) {
|
||
|
|
$updateFinancialItemInfoValues['financial_account_id'] = $updateFinancialItemInfoValues['tax']['financial_account_id'];
|
||
|
|
}
|
||
|
|
CRM_Financial_BAO_FinancialItem::create($updateFinancialItemInfoValues);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
$trxnId = array();
|
||
|
|
if (!empty($trxn->id)) {
|
||
|
|
$trxnId['id'] = $trxn->id;
|
||
|
|
}
|
||
|
|
$lineItemObj->_addLineItemOnChangeFeeSelection($lineItemsToAdd, $entityID, $entityTable, $contributionId, $trxnId, TRUE);
|
||
|
|
|
||
|
|
// update participant fee_amount column
|
||
|
|
$lineItemObj->_updateEntityRecordOnChangeFeeSelection($params, $entityID, $entity);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Function to cancel Lineitem whose corrosponding price field option is
|
||
|
|
* unselected on membership or participant backoffice form
|
||
|
|
*
|
||
|
|
* @param int $entityID
|
||
|
|
* @param string $entityTable
|
||
|
|
* @param string $additionalWhereClause
|
||
|
|
*
|
||
|
|
*/
|
||
|
|
protected function _cancelLineItems($entityID, $entityTable, $additionalWhereClause = NULL) {
|
||
|
|
$whereClauses = array(
|
||
|
|
"li.entity_id = %1",
|
||
|
|
"li.entity_table = %2",
|
||
|
|
);
|
||
|
|
if ($additionalWhereClause) {
|
||
|
|
$whereClauses[] = $additionalWhereClause;
|
||
|
|
}
|
||
|
|
|
||
|
|
$where = implode(' AND ', $whereClauses);
|
||
|
|
$sql = "
|
||
|
|
UPDATE civicrm_line_item li
|
||
|
|
INNER JOIN civicrm_financial_item fi ON (li.id = fi.entity_id AND fi.entity_table = 'civicrm_line_item')
|
||
|
|
SET li.qty = 0,
|
||
|
|
li.line_total = 0.00,
|
||
|
|
li.tax_amount = NULL,
|
||
|
|
li.participant_count = 0,
|
||
|
|
li.non_deductible_amount = 0.00
|
||
|
|
WHERE {$where} ";
|
||
|
|
|
||
|
|
CRM_Core_DAO::executeQuery($sql, array(
|
||
|
|
1 => array($entityID, 'Integer'),
|
||
|
|
2 => array($entityTable, 'String'),
|
||
|
|
));
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Function to retrieve formatted financial items that need to be recorded as result of changed fee
|
||
|
|
*
|
||
|
|
* @param int $entityID
|
||
|
|
* @param string $entityTable
|
||
|
|
* @param int $contributionID
|
||
|
|
* @param array $submittedPriceFieldValueIDs
|
||
|
|
*
|
||
|
|
* @return array
|
||
|
|
* List of formatted Financial Items to be recorded
|
||
|
|
*/
|
||
|
|
protected function _getFinancialItemsToRecord($entityID, $entityTable, $contributionID, $submittedPriceFieldValueIDs) {
|
||
|
|
$previousLineItems = CRM_Price_BAO_LineItem::getLineItems($entityID, str_replace('civicrm_', '', $entityTable));
|
||
|
|
|
||
|
|
$financialItemsArray = array();
|
||
|
|
|
||
|
|
if (empty($submittedPriceFieldValueIDs)) {
|
||
|
|
return $financialItemsArray;
|
||
|
|
}
|
||
|
|
|
||
|
|
// gathering necessary info to record negative (deselected) financial_item
|
||
|
|
$updateFinancialItem = "
|
||
|
|
SELECT fi.*, SUM(fi.amount) as differenceAmt, price_field_value_id, financial_type_id, tax_amount
|
||
|
|
FROM civicrm_financial_item fi LEFT JOIN civicrm_line_item li ON (li.id = fi.entity_id AND fi.entity_table = 'civicrm_line_item')
|
||
|
|
WHERE (li.entity_table = '{$entityTable}' AND li.entity_id = {$entityID})
|
||
|
|
GROUP BY li.entity_table, li.entity_id, price_field_value_id, fi.id
|
||
|
|
";
|
||
|
|
$updateFinancialItemInfoDAO = CRM_Core_DAO::executeQuery($updateFinancialItem);
|
||
|
|
|
||
|
|
$invoiceSettings = Civi::settings()->get('contribution_invoice_settings');
|
||
|
|
$taxTerm = CRM_Utils_Array::value('tax_term', $invoiceSettings);
|
||
|
|
$updateFinancialItemInfoValues = array();
|
||
|
|
while ($updateFinancialItemInfoDAO->fetch()) {
|
||
|
|
$updateFinancialItemInfoValues = (array) $updateFinancialItemInfoDAO;
|
||
|
|
$updateFinancialItemInfoValues['transaction_date'] = date('YmdHis');
|
||
|
|
// the below params are not needed
|
||
|
|
$previousFinancialItemID = $updateFinancialItemInfoValues['id'];
|
||
|
|
unset($updateFinancialItemInfoValues['id']);
|
||
|
|
unset($updateFinancialItemInfoValues['created_date']);
|
||
|
|
// if not submitted and difference is not 0 make it negative
|
||
|
|
if (!in_array($updateFinancialItemInfoValues['price_field_value_id'], $submittedPriceFieldValueIDs) && $updateFinancialItemInfoValues['differenceAmt'] != 0) {
|
||
|
|
// INSERT negative financial_items
|
||
|
|
$updateFinancialItemInfoValues['amount'] = -$updateFinancialItemInfoValues['amount'];
|
||
|
|
// reverse the related financial trxn too
|
||
|
|
$updateFinancialItemInfoValues['financialTrxn'] = $this->_getRelatedCancelFinancialTrxn($previousFinancialItemID);
|
||
|
|
if ($previousLineItems[$updateFinancialItemInfoValues['entity_id']]['tax_amount']) {
|
||
|
|
$updateFinancialItemInfoValues['tax']['amount'] = -($previousLineItems[$updateFinancialItemInfoValues['entity_id']]['tax_amount']);
|
||
|
|
$updateFinancialItemInfoValues['tax']['description'] = $taxTerm;
|
||
|
|
if ($updateFinancialItemInfoValues['financial_type_id']) {
|
||
|
|
$updateFinancialItemInfoValues['tax']['financial_account_id'] = CRM_Contribute_BAO_Contribution::getFinancialAccountId($updateFinancialItemInfoValues['financial_type_id']);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
// INSERT negative financial_items for tax amount
|
||
|
|
$financialItemsArray[] = $updateFinancialItemInfoValues;
|
||
|
|
}
|
||
|
|
// if submitted and difference is 0 add a positive entry again
|
||
|
|
elseif (in_array($updateFinancialItemInfoValues['price_field_value_id'], $submittedPriceFieldValueIDs) && $updateFinancialItemInfoValues['differenceAmt'] == 0) {
|
||
|
|
$updateFinancialItemInfoValues['amount'] = $updateFinancialItemInfoValues['amount'];
|
||
|
|
// INSERT financial_items for tax amount
|
||
|
|
if ($updateFinancialItemInfoValues['entity_id'] == $lineItemsToUpdate[$updateFinancialItemInfoValues['price_field_value_id']]['id'] &&
|
||
|
|
isset($lineItemsToUpdate[$updateFinancialItemInfoValues['price_field_value_id']]['tax_amount'])
|
||
|
|
) {
|
||
|
|
$updateFinancialItemInfoValues['tax']['amount'] = $lineItemsToUpdate[$updateFinancialItemInfoValues['price_field_value_id']]['tax_amount'];
|
||
|
|
$updateFinancialItemInfoValues['tax']['description'] = $taxTerm;
|
||
|
|
if ($lineItemsToUpdate[$updateFinancialItemInfoValues['price_field_value_id']]['financial_type_id']) {
|
||
|
|
$updateFinancialItemInfoValues['tax']['financial_account_id'] = CRM_Contribute_BAO_Contribution::getFinancialAccountId($lineItemsToUpdate[$updateFinancialItemInfoValues['price_field_value_id']]['financial_type_id']);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
$financialItemsArray[] = $updateFinancialItemInfoValues;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
return $financialItemsArray;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Helper function to retrieve submitted line items from form values $inputParams and used $feeBlock
|
||
|
|
*
|
||
|
|
* @param array $inputParams
|
||
|
|
* @param array $feeBlock
|
||
|
|
*
|
||
|
|
* @return array
|
||
|
|
* List of submitted line items
|
||
|
|
*/
|
||
|
|
protected function _getSubmittedLineItems($inputParams, $feeBlock) {
|
||
|
|
$submittedLineItems = array();
|
||
|
|
foreach ($feeBlock as $id => $values) {
|
||
|
|
CRM_Price_BAO_LineItem::format($id, $inputParams, $values, $submittedLineItems);
|
||
|
|
}
|
||
|
|
|
||
|
|
return $submittedLineItems;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Helper function to retrieve formatted lineitems need to be added and/or updated
|
||
|
|
*
|
||
|
|
* @param array $submittedLineItems
|
||
|
|
* @param int $entityID
|
||
|
|
* @param string $entity
|
||
|
|
*
|
||
|
|
* @return array
|
||
|
|
* Array of formatted lineitems
|
||
|
|
*/
|
||
|
|
protected function _getLineItemsToAddAndUpdate($submittedLineItems, $entityID, $entity) {
|
||
|
|
$previousLineItems = CRM_Price_BAO_LineItem::getLineItems($entityID, $entity);
|
||
|
|
|
||
|
|
$lineItemsToAdd = $submittedLineItems;
|
||
|
|
$lineItemsToUpdate = array();
|
||
|
|
$submittedPriceFieldValueIDs = array_keys($submittedLineItems);
|
||
|
|
|
||
|
|
foreach ($previousLineItems as $id => $previousLineItem) {
|
||
|
|
// check through the submitted items if the previousItem exists,
|
||
|
|
// if found in submitted items, do not use it for new item creations
|
||
|
|
if (in_array($previousLineItem['price_field_value_id'], $submittedPriceFieldValueIDs)) {
|
||
|
|
// if submitted line items are existing don't fire INSERT query
|
||
|
|
if ($previousLineItem['line_total'] != 0) {
|
||
|
|
unset($lineItemsToAdd[$previousLineItem['price_field_value_id']]);
|
||
|
|
}
|
||
|
|
else {
|
||
|
|
$lineItemsToAdd[$previousLineItem['price_field_value_id']]['skip'] = TRUE;
|
||
|
|
}
|
||
|
|
// for updating the line items i.e. use-case - once deselect-option selecting again
|
||
|
|
if (($previousLineItem['line_total'] != $submittedLineItems[$previousLineItem['price_field_value_id']]['line_total']) ||
|
||
|
|
($submittedLineItems[$previousLineItem['price_field_value_id']]['line_total'] == 0 && $submittedLineItems[$previousLineItem['price_field_value_id']]['qty'] == 1) ||
|
||
|
|
($previousLineItem['qty'] != $submittedLineItems[$previousLineItem['price_field_value_id']]['qty'])
|
||
|
|
) {
|
||
|
|
$lineItemsToUpdate[$previousLineItem['price_field_value_id']] = $submittedLineItems[$previousLineItem['price_field_value_id']];
|
||
|
|
$lineItemsToUpdate[$previousLineItem['price_field_value_id']]['id'] = $id;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
return array($lineItemsToAdd, $lineItemsToUpdate);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Helper function to add lineitems or financial item related to it, to as result of fee change
|
||
|
|
*
|
||
|
|
* @param array $lineItemsToAdd
|
||
|
|
* @param int $entityID
|
||
|
|
* @param string $entityTable
|
||
|
|
* @param int $contributionID
|
||
|
|
* @param array $adjustedFinancialTrxnID
|
||
|
|
* @param bool $addFinancialItemOnly
|
||
|
|
*
|
||
|
|
* @return void
|
||
|
|
*/
|
||
|
|
protected function _addLineItemOnChangeFeeSelection(
|
||
|
|
$lineItemsToAdd,
|
||
|
|
$entityID,
|
||
|
|
$entityTable,
|
||
|
|
$contributionID,
|
||
|
|
$adjustedFinancialTrxnID = NULL,
|
||
|
|
$addFinancialItemOnly = FALSE
|
||
|
|
) {
|
||
|
|
// if there is no line item to add, do not proceed
|
||
|
|
if (empty($lineItemsToAdd)) {
|
||
|
|
return;
|
||
|
|
}
|
||
|
|
|
||
|
|
$changedFinancialTypeID = NULL;
|
||
|
|
$fetchCon = array('id' => $contributionID);
|
||
|
|
$updatedContribution = CRM_Contribute_BAO_Contribution::retrieve($fetchCon, CRM_Core_DAO::$_nullArray, CRM_Core_DAO::$_nullArray);
|
||
|
|
// insert financial items
|
||
|
|
foreach ($lineItemsToAdd as $priceFieldValueID => $lineParams) {
|
||
|
|
$tempFinancialTrxnID = $adjustedFinancialTrxnID;
|
||
|
|
$lineParams = array_merge($lineParams, array(
|
||
|
|
'entity_table' => $entityTable,
|
||
|
|
'entity_id' => $entityID,
|
||
|
|
'contribution_id' => $contributionID,
|
||
|
|
));
|
||
|
|
if ($addFinancialItemOnly) {
|
||
|
|
// don't add financial item for cancelled line item
|
||
|
|
if ($lineParams['qty'] == 0) {
|
||
|
|
continue;
|
||
|
|
}
|
||
|
|
elseif (empty($adjustedFinancialTrxnID)) {
|
||
|
|
// add financial item if ONLY financial type is changed
|
||
|
|
if ($lineParams['financial_type_id'] != $updatedContribution->financial_type_id) {
|
||
|
|
$changedFinancialTypeID = $lineParams['financial_type_id'];
|
||
|
|
$adjustedTrxnValues = array(
|
||
|
|
'from_financial_account_id' => NULL,
|
||
|
|
'to_financial_account_id' => CRM_Financial_BAO_FinancialTypeAccount::getInstrumentFinancialAccount($updatedContribution->payment_instrument_id),
|
||
|
|
'total_amount' => $lineParams['line_total'],
|
||
|
|
'net_amount' => $lineParams['line_total'],
|
||
|
|
'status_id' => $updatedContribution->contribution_status_id,
|
||
|
|
'payment_instrument_id' => $updatedContribution->payment_instrument_id,
|
||
|
|
'contribution_id' => $updatedContribution->id,
|
||
|
|
'is_payment' => TRUE, // since balance is 0, which means contribution is completed
|
||
|
|
'trxn_date' => date('YmdHis'),
|
||
|
|
'currency' => $updatedContribution->currency,
|
||
|
|
);
|
||
|
|
$adjustedTrxn = CRM_Core_BAO_FinancialTrxn::create($adjustedTrxnValues);
|
||
|
|
$tempFinancialTrxnID = array('id' => $adjustedTrxn->id);
|
||
|
|
}
|
||
|
|
// don't add financial item if line_total and financial type aren't changed,
|
||
|
|
// which is identified by empty $adjustedFinancialTrxnID
|
||
|
|
else {
|
||
|
|
continue;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
$lineObj = CRM_Price_BAO_LineItem::retrieve($lineParams, CRM_Core_DAO::$_nullArray);
|
||
|
|
// insert financial items
|
||
|
|
// ensure entity_financial_trxn table has a linking of it.
|
||
|
|
CRM_Financial_BAO_FinancialItem::add($lineObj, $updatedContribution, NULL, $tempFinancialTrxnID);
|
||
|
|
if (isset($lineObj->tax_amount)) {
|
||
|
|
CRM_Financial_BAO_FinancialItem::add($lineObj, $updatedContribution, TRUE, $tempFinancialTrxnID);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
elseif (!array_key_exists('skip', $lineParams)) {
|
||
|
|
self::create($lineParams);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
if ($changedFinancialTypeID) {
|
||
|
|
$updatedContribution->financial_type_id = $changedFinancialTypeID;
|
||
|
|
$updatedContribution->save();
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Helper function to update entity record on change fee selection
|
||
|
|
*
|
||
|
|
* @param array $inputParams
|
||
|
|
* @param int $entityID
|
||
|
|
* @param string $entity
|
||
|
|
*
|
||
|
|
*/
|
||
|
|
protected function _updateEntityRecordOnChangeFeeSelection($inputParams, $entityID, $entity) {
|
||
|
|
$entityTable = "civicrm_{$entity}";
|
||
|
|
|
||
|
|
if ($entity == 'participant') {
|
||
|
|
$partUpdateFeeAmt = array('id' => $entityID);
|
||
|
|
$getUpdatedLineItems = "SELECT *
|
||
|
|
FROM civicrm_line_item
|
||
|
|
WHERE (entity_table = '{$entityTable}' AND entity_id = {$entityID} AND qty > 0)";
|
||
|
|
$getUpdatedLineItemsDAO = CRM_Core_DAO::executeQuery($getUpdatedLineItems);
|
||
|
|
$line = array();
|
||
|
|
while ($getUpdatedLineItemsDAO->fetch()) {
|
||
|
|
$line[$getUpdatedLineItemsDAO->price_field_value_id] = $getUpdatedLineItemsDAO->label . ' - ' . (float) $getUpdatedLineItemsDAO->qty;
|
||
|
|
}
|
||
|
|
|
||
|
|
$partUpdateFeeAmt['fee_level'] = implode(', ', $line);
|
||
|
|
$partUpdateFeeAmt['fee_amount'] = $inputParams['amount'];
|
||
|
|
CRM_Event_BAO_Participant::add($partUpdateFeeAmt);
|
||
|
|
|
||
|
|
//activity creation
|
||
|
|
CRM_Event_BAO_Participant::addActivityForSelection($entityID, 'Change Registration');
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Helper function to retrieve financial trxn parameters to reverse
|
||
|
|
* for given financial item identified by $financialItemID
|
||
|
|
*
|
||
|
|
* @param int $financialItemID
|
||
|
|
*
|
||
|
|
* @return array $financialTrxn
|
||
|
|
*
|
||
|
|
*/
|
||
|
|
protected function _getRelatedCancelFinancialTrxn($financialItemID) {
|
||
|
|
$financialTrxn = civicrm_api3('EntityFinancialTrxn', 'getsingle', array(
|
||
|
|
'entity_table' => 'civicrm_financial_item',
|
||
|
|
'entity_id' => $financialItemID,
|
||
|
|
'options' => array(
|
||
|
|
'sort' => 'id DESC',
|
||
|
|
'limit' => 1,
|
||
|
|
),
|
||
|
|
'api.FinancialTrxn.getsingle' => array(
|
||
|
|
'id' => "\$value.financial_trxn_id",
|
||
|
|
),
|
||
|
|
));
|
||
|
|
|
||
|
|
$financialTrxn = array_merge($financialTrxn['api.FinancialTrxn.getsingle'], array(
|
||
|
|
'trxn_date' => date('YmdHis'),
|
||
|
|
'total_amount' => -$financialTrxn['api.FinancialTrxn.getsingle']['total_amount'],
|
||
|
|
'net_amount' => -$financialTrxn['api.FinancialTrxn.getsingle']['net_amount'],
|
||
|
|
'entity_table' => 'civicrm_financial_item',
|
||
|
|
'entity_id' => $financialItemID,
|
||
|
|
));
|
||
|
|
unset($financialTrxn['id']);
|
||
|
|
|
||
|
|
return $financialTrxn;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Record adjusted amount.
|
||
|
|
*
|
||
|
|
* @param int $updatedAmount
|
||
|
|
* @param int $paidAmount
|
||
|
|
* @param int $contributionId
|
||
|
|
*
|
||
|
|
* @param int $taxAmount
|
||
|
|
* @param bool $updateAmountLevel
|
||
|
|
*
|
||
|
|
* @return bool|\CRM_Core_BAO_FinancialTrxn
|
||
|
|
*/
|
||
|
|
protected function _recordAdjustedAmt($updatedAmount, $paidAmount, $contributionId, $taxAmount = NULL, $updateAmountLevel = NULL) {
|
||
|
|
$pendingAmount = CRM_Core_BAO_FinancialTrxn::getBalanceTrxnAmt($contributionId);
|
||
|
|
$pendingAmount = CRM_Utils_Array::value('total_amount', $pendingAmount, 0);
|
||
|
|
$balanceAmt = $updatedAmount - $paidAmount;
|
||
|
|
if ($paidAmount != $pendingAmount) {
|
||
|
|
$balanceAmt -= $pendingAmount;
|
||
|
|
}
|
||
|
|
|
||
|
|
$contributionStatuses = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');
|
||
|
|
$partiallyPaidStatusId = array_search('Partially paid', $contributionStatuses);
|
||
|
|
$pendingRefundStatusId = array_search('Pending refund', $contributionStatuses);
|
||
|
|
$completedStatusId = array_search('Completed', $contributionStatuses);
|
||
|
|
|
||
|
|
$updatedContributionDAO = new CRM_Contribute_BAO_Contribution();
|
||
|
|
$adjustedTrxn = $skip = FALSE;
|
||
|
|
if ($balanceAmt) {
|
||
|
|
if ($balanceAmt > 0 && $paidAmount != 0) {
|
||
|
|
$contributionStatusVal = $partiallyPaidStatusId;
|
||
|
|
}
|
||
|
|
elseif ($balanceAmt < 0 && $paidAmount != 0) {
|
||
|
|
$contributionStatusVal = $pendingRefundStatusId;
|
||
|
|
}
|
||
|
|
elseif ($paidAmount == 0) {
|
||
|
|
//skip updating the contribution status if no payment is made
|
||
|
|
$skip = TRUE;
|
||
|
|
$updatedContributionDAO->cancel_date = 'null';
|
||
|
|
$updatedContributionDAO->cancel_reason = NULL;
|
||
|
|
}
|
||
|
|
// update contribution status and total amount without trigger financial code
|
||
|
|
// as this is handled in current BAO function used for change selection
|
||
|
|
$updatedContributionDAO->id = $contributionId;
|
||
|
|
if (!$skip) {
|
||
|
|
$updatedContributionDAO->contribution_status_id = $contributionStatusVal;
|
||
|
|
}
|
||
|
|
$updatedContributionDAO->total_amount = $updatedContributionDAO->net_amount = $updatedAmount;
|
||
|
|
$updatedContributionDAO->fee_amount = 0;
|
||
|
|
$updatedContributionDAO->tax_amount = $taxAmount;
|
||
|
|
if (!empty($updateAmountLevel)) {
|
||
|
|
$updatedContributionDAO->amount_level = $updateAmountLevel;
|
||
|
|
}
|
||
|
|
$updatedContributionDAO->save();
|
||
|
|
// adjusted amount financial_trxn creation
|
||
|
|
$updatedContribution = CRM_Contribute_BAO_Contribution::getValues(
|
||
|
|
array('id' => $contributionId),
|
||
|
|
CRM_Core_DAO::$_nullArray,
|
||
|
|
CRM_Core_DAO::$_nullArray
|
||
|
|
);
|
||
|
|
$toFinancialAccount = CRM_Contribute_PseudoConstant::getRelationalFinancialAccount($updatedContribution->financial_type_id, 'Accounts Receivable Account is');
|
||
|
|
$adjustedTrxnValues = array(
|
||
|
|
'from_financial_account_id' => NULL,
|
||
|
|
'to_financial_account_id' => $toFinancialAccount,
|
||
|
|
'total_amount' => $balanceAmt,
|
||
|
|
'net_amount' => $balanceAmt,
|
||
|
|
'status_id' => $completedStatusId,
|
||
|
|
'payment_instrument_id' => $updatedContribution->payment_instrument_id,
|
||
|
|
'contribution_id' => $updatedContribution->id,
|
||
|
|
'trxn_date' => date('YmdHis'),
|
||
|
|
'currency' => $updatedContribution->currency,
|
||
|
|
);
|
||
|
|
$adjustedTrxn = CRM_Core_BAO_FinancialTrxn::create($adjustedTrxnValues);
|
||
|
|
}
|
||
|
|
return $adjustedTrxn;
|
||
|
|
}
|
||
|
|
|
||
|
|
}
|