<?php
/*
+--------------------------------------------------------------------+
- | CiviCRM version 4.4 |
+ | CiviCRM version 4.5 |
+--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2013 |
+ | Copyright CiviCRM LLC (c) 2004-2014 |
+--------------------------------------------------------------------+
| This file is a part of CiviCRM. |
| |
/**
*
* @package CRM
- * @copyright CiviCRM LLC (c) 2004-2013
+ * @copyright CiviCRM LLC (c) 2004-2014
* $Id$
*
*/
);
//if priceset is used, no need to cleanup money
- if (CRM_Utils_Array::value('skipCleanMoney', $params)) {
+ if (!empty($params['skipCleanMoney'])) {
unset($moneyFields[0]);
}
}
// CRM-13420, set payment instrument to default if payment_instrument_id is empty
- if (!$contributionID && !CRM_Utils_Array::value('payment_instrument_id', $params)) {
+ if (!$contributionID && empty($params['payment_instrument_id'])) {
$params['payment_instrument_id'] = key(CRM_Core_OptionGroup::values('payment_instrument',
FALSE, FALSE, FALSE, 'AND is_default = 1'));
}
- if (CRM_Utils_Array::value('payment_instrument_id', $params)) {
+ if (!empty($params['payment_instrument_id'])) {
$paymentInstruments = CRM_Contribute_PseudoConstant::paymentInstrument('name');
if ($params['payment_instrument_id'] != array_search('Check', $paymentInstruments)) {
$params['check_number'] = 'null';
// contribution status is missing, choose Completed as default status
// do this for create mode only
- if (!CRM_Utils_Array::value('contribution', $ids) && !CRM_Utils_Array::value('contribution_status_id', $params)) {
+ if (empty($ids['contribution']) && empty($params['contribution_status_id'])) {
$params['contribution_status_id'] = CRM_Core_OptionGroup::getValue('contribution_status', 'Completed', 'name');
}
+ $setPrevContribution = TRUE;
+ // CRM-13964 partial payment
+ if (!empty($params['partial_payment_total']) && !empty($params['partial_amount_pay'])) {
+ $partialAmtTotal = $params['partial_payment_total'];
+ $partialAmtPay = $params['partial_amount_pay'];
+ $params['total_amount'] = $partialAmtTotal;
+ if ($partialAmtPay < $partialAmtTotal) {
+ $params['contribution_status_id'] = CRM_Core_OptionGroup::getValue('contribution_status', 'Partially paid', 'name');
+ $params['is_pay_later'] = 0;
+ $setPrevContribution = FALSE;
+ }
+ }
if ($contributionID) {
CRM_Utils_Hook::pre('edit', 'Contribution', $contributionID, $params);
else {
CRM_Utils_Hook::pre('create', 'Contribution', NULL, $params);
}
-
$contribution = new CRM_Contribute_BAO_Contribution();
$contribution->copyValues($params);
$contribution->currency = $config->defaultCurrency;
}
- if ($contributionID) {
+ if ($contributionID && $setPrevContribution) {
$params['prevContribution'] = self::getValues(array('id' => $contributionID), CRM_Core_DAO::$_nullArray, CRM_Core_DAO::$_nullArray);
}
//add Account details
$params['contribution'] = $contribution;
- self::recordFinancialAccounts($params, $ids);
+ self::recordFinancialAccounts($params);
// reset the group contact cache for this group
CRM_Contact_BAO_GroupContactCache::remove();
$params['contribution_id'] = $contribution->id;
- if (CRM_Utils_Array::value('custom', $params) &&
+ if (!empty($params['custom']) &&
is_array($params['custom'])
) {
CRM_Core_BAO_CustomValueTable::store($params['custom'], 'civicrm_contribution', $contribution->id);
$session = CRM_Core_Session::singleton();
- if (CRM_Utils_Array::value('note', $params)) {
+ if (!empty($params['note'])) {
$noteParams = array(
'entity_table' => 'civicrm_contribution',
'note' => $params['note'],
}
// make entry in batch entity batch table
- if (CRM_Utils_Array::value('batch_id', $params)) {
+ if (!empty($params['batch_id'])) {
// in some update cases we need to get extra fields - ie an update that doesn't pass in all these params
$titleFields = array(
'contact_id',
}
// Handle soft credit and / or link to personal campaign page
- list($type, $softIDs) = CRM_Contribute_BAO_ContributionSoft::getSoftCreditType($contribution->id);
+ $softIDs = CRM_Contribute_BAO_ContributionSoft::getSoftCreditIds($contribution->id);
+
+ //Delete PCP against this contribution and create new on submitted PCP information
+ $pcpId = CRM_Contribute_BAO_ContributionSoft::getSoftCreditIds($contribution->id, TRUE);
+ if ($pcpId) {
+ $deleteParams = array('id' => $pcpId);
+ CRM_Contribute_BAO_ContributionSoft::del($deleteParams);
+ }
if ($pcp = CRM_Utils_Array::value('pcp', $params)) {
- if (!empty($type) && $type == 'soft') {
- $deleteParams = array('contribution_id' => $contribution->id);
- CRM_Contribute_BAO_ContributionSoft::del($deleteParams);
- }
$softParams = array();
$softParams['contribution_id'] = $contribution->id;
$softParams['pcp_id'] = $pcp['pcp_made_through_id'];
$softParams['pcp_display_in_roll'] = CRM_Utils_Array::value('pcp_display_in_roll', $pcp);
$softParams['pcp_roll_nickname'] = CRM_Utils_Array::value('pcp_roll_nickname', $pcp);
$softParams['pcp_personal_note'] = CRM_Utils_Array::value('pcp_personal_note', $pcp);
+ $softParams['soft_credit_type_id'] = CRM_Core_OptionGroup::getValue('soft_credit_type', 'pcp', 'name');
CRM_Contribute_BAO_ContributionSoft::add($softParams);
}
- elseif (CRM_Utils_Array::value('soft_credit', $params)) {
+ if (isset($params['soft_credit'])) {
$softParams = $params['soft_credit'];
if (!empty($softIDs)) {
foreach ($softParams as $softParam) {
$softParam['contribution_id'] = $contribution->id;
$softParam['currency'] = $contribution->currency;
- $softParam['pcp_id'] = 'null';
- $softParam['pcp_display_in_roll'] = 'null';
- $softParam['pcp_roll_nickname'] = 'null';
- $softParam['pcp_personal_note'] = 'NULL';
+ //case during Contribution Import when we assign soft contribution amount as contribution's total_amount by default
+ if (empty($softParam['amount'])) {
+ $softParam['amount'] = $contribution->total_amount;
+ }
CRM_Contribute_BAO_ContributionSoft::add($softParam);
}
}
$transaction->commit();
// do not add to recent items for import, CRM-4399
- if (!CRM_Utils_Array::value('skipRecentView', $params)) {
+ if (empty($params['skipRecentView'])) {
$url = CRM_Utils_System::url('civicrm/contact/view/contribution',
"action=view&reset=1&id={$contribution->id}&cid={$contribution->contact_id}&context=home"
);
)
);
+ $softCreditFields = array(
+ 'contribution_soft_credit_name' => array(
+ 'name' => 'contribution_soft_credit_name',
+ 'title' => 'Soft Credit For',
+ 'where' => 'civicrm_contact_d.display_name',
+ 'data_type' => CRM_Utils_Type::T_STRING
+ ),
+ 'contribution_soft_credit_amount' => array(
+ 'name' => 'contribution_soft_credit_amount',
+ 'title' => 'Soft Credit Amount',
+ 'where' => 'civicrm_contribution_soft.amount',
+ 'data_type' => CRM_Utils_Type::T_MONEY
+ ),
+ 'contribution_soft_credit_type' => array(
+ 'name' => 'contribution_soft_credit_type',
+ 'title' => 'Soft Credit Type',
+ 'where' => 'contribution_softcredit_type.label',
+ 'data_type' => CRM_Utils_Type::T_STRING
+ ),
+ 'contribution_soft_credit_contribution_id' => array(
+ 'name' => 'contribution_soft_credit_contribution_id',
+ 'title' => 'Soft Credit For Contribution ID',
+ 'where' => 'civicrm_contribution_soft.contribution_id',
+ 'data_type' => CRM_Utils_Type::T_INT
+ ),
+ );
+
$fields = array_merge($impFields, $typeField, $contributionStatus, $optionField, $expFieldProduct,
- $expFieldsContrib, $contributionNote, $contributionRecurId, $extraFields, $financialAccount,
+ $expFieldsContrib, $contributionNote, $contributionRecurId, $extraFields, $softCreditFields, $financialAccount,
CRM_Core_BAO_CustomField::getFieldsForImport('Contribution')
);
'headerPattern' => '/^honor_contact_email$/i',
'where' => 'honor_email.email',
),
- 'honor_contact_id' => array(
- 'name' => 'honor_contact_id',
- 'title' => 'Honor Contact ID',
- 'headerPattern' => '/^honor_contact_id$/i',
- 'where' => 'civicrm_contribution.honor_contact_id',
- ),
- 'honor_type_label' => array(
- 'name' => 'honor_type_label',
- 'title' => 'Honor Type Label',
- 'headerPattern' => '/^honor_type_label$/i',
- 'where' => 'honor_type.label',
- ),
- 'soft_credit_name' => array(
- 'name' => 'soft_credit_name',
+ 'contribution_soft_credit_name' => array(
+ 'name' => 'contribution_soft_credit_name',
'title' => 'Soft Credit Name',
'headerPattern' => '/^soft_credit_name$/i',
'where' => 'civicrm_contact_d.display_name',
),
- 'soft_credit_email' => array(
- 'name' => 'soft_credit_email',
+ 'contribution_soft_credit_email' => array(
+ 'name' => 'contribution_soft_credit_email',
'title' => 'Soft Credit Email',
'headerPattern' => '/^soft_credit_email$/i',
'where' => 'soft_email.email',
),
- 'soft_credit_phone' => array(
- 'name' => 'soft_credit_phone',
+ 'contribution_soft_credit_phone' => array(
+ 'name' => 'contribution_soft_credit_phone',
'title' => 'Soft Credit Phone',
'headerPattern' => '/^soft_credit_phone$/i',
'where' => 'soft_phone.phone',
),
- 'soft_credit_contact_id' => array(
- 'name' => 'soft_credit_contact_id',
+ 'contribution_soft_credit_contact_id' => array(
+ 'name' => 'contribution_soft_credit_contact_id',
'title' => 'Soft Credit Contact ID',
'headerPattern' => '/^soft_credit_contact_id$/i',
'where' => 'civicrm_contribution_soft.contact_id',
}
}
- /**
- * Function to create is honor of
- *
- * @param array $params associated array of fields (by reference)
- * @param int $honorId honor Id
- * @param array $honorParams any params that should be send to the create function
- *
- * @return contact id
- */
- static function createHonorContact(&$params, $honorId = NULL, $honorParams = array()) {
- $honorParams = array_merge(
- array(
- 'first_name' => $params['honor_first_name'],
- 'last_name' => $params['honor_last_name'],
- 'prefix_id' => $params['honor_prefix_id'],
- 'email-Primary' => $params['honor_email'],
- ),
- $honorParams
- );
- if (!$honorId) {
- $honorParams['email'] = $params['honor_email'];
-
- $dedupeParams = CRM_Dedupe_Finder::formatParams($honorParams, 'Individual');
- $dedupeParams['check_permission'] = FALSE;
- $ids = CRM_Dedupe_Finder::dupesByParams($dedupeParams, 'Individual');
-
- // if we find more than one contact, use the first one
- $honorId = CRM_Utils_Array::value(0, $ids);
- }
-
- $contactID = CRM_Contact_BAO_Contact::createProfileContact(
- $honorParams,
- CRM_Core_DAO::$_nullArray,
- $honorId
- );
- return $contactID;
- }
-
/**
* Function to get list of contribution In Honor of contact Ids
*
*/
static function getHonorContacts($honorId) {
$params = array();
- $honorDAO = new CRM_Contribute_DAO_Contribution();
- $honorDAO->honor_contact_id = $honorId;
+ $honorDAO = new CRM_Contribute_DAO_ContributionSoft();
+ $honorDAO->contact_id = $honorId;
$honorDAO->find();
- $status = CRM_Contribute_PseudoConstant::contributionStatus($honorDAO->contribution_status_id);
$type = CRM_Contribute_PseudoConstant::financialType();
while ($honorDAO->fetch()) {
- $params[$honorDAO->id]['honorId'] = $honorDAO->contact_id;
- $params[$honorDAO->id]['display_name'] = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $honorDAO->contact_id, 'display_name');
- $params[$honorDAO->id]['type'] = $type[$honorDAO->financial_type_id];
- $params[$honorDAO->id]['type_id'] = $honorDAO->financial_type_id;
- $params[$honorDAO->id]['amount'] = CRM_Utils_Money::format($honorDAO->total_amount, $honorDAO->currency);
- $params[$honorDAO->id]['source'] = $honorDAO->source;
- $params[$honorDAO->id]['receive_date'] = $honorDAO->receive_date;
- $params[$honorDAO->id]['contribution_status'] = CRM_Utils_Array::value($honorDAO->contribution_status_id, $status);
+ $contributionDAO = new CRM_Contribute_DAO_Contribution();
+ $contributionDAO->id = $honorDAO->contribution_id;
+
+ if ($contributionDAO->find(TRUE)) {
+ $params[$contributionDAO->id]['honor_type'] = CRM_Core_OptionGroup::getLabel('soft_credit_type', $honorDAO->soft_credit_type_id, 'value');
+ $params[$contributionDAO->id]['honorId'] = $contributionDAO->contact_id;
+ $params[$contributionDAO->id]['display_name'] = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $contributionDAO->contact_id, 'display_name');
+ $params[$contributionDAO->id]['type'] = $type[$contributionDAO->financial_type_id];
+ $params[$contributionDAO->id]['type_id'] = $contributionDAO->financial_type_id;
+ $params[$contributionDAO->id]['amount'] = CRM_Utils_Money::format($contributionDAO->total_amount, $contributionDAO->currency);
+ $params[$contributionDAO->id]['source'] = $contributionDAO->source;
+ $params[$contributionDAO->id]['receive_date'] = $contributionDAO->receive_date;
+ $params[$contributionDAO->id]['contribution_status'] = CRM_Contribute_PseudoConstant::contributionStatus($contributionDAO->contribution_status_id);
+ }
}
return $params;
}
}
- if (CRM_Utils_Array::value('contact_id', $componentDetails)) {
+ if (!empty($componentDetails['contact_id'])) {
$componentDetails['contact_id'] = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_Contribution',
$contributionId,
'contact_id'
}
// do check for required ids.
- if (!CRM_Utils_Array::value('membership', $componentDetails) &&
- !CRM_Utils_Array::value('participant', $componentDetails) &&
- !CRM_Utils_Array::value('pledge_payment', $componentDetails) ||
- !CRM_Utils_Array::value('contact_id', $componentDetails)
- ) {
+ if (empty($componentDetails['membership']) && empty($componentDetails['participant']) && empty($componentDetails['pledge_payment']) || empty($componentDetails['contact_id'])) {
return $updateResult;
}
$dates['end_date'],
$dates['join_date'],
'today',
- TRUE
+ TRUE,
+ $membership->membership_type_id,
+ (array) $membership
);
$formattedParams = array(
'contribution_status_id', 'non_deductible_amount', 'receipt_date', 'check_number',
);
foreach ($fields as $field) {
- if (!CRM_Utils_Array::value($field, $params)) {
+ if (empty($params[$field])) {
continue;
}
$contributionParams[$field] = $params[$field];
return $componentDetails;
}
- static function contributionCount($contactId, $includeSoftCredit = TRUE, $includeHonoree = TRUE) {
+ static function contributionCount($contactId, $includeSoftCredit = TRUE) {
if (!$contactId) {
return 0;
}
FROM civicrm_contribution contribution
WHERE contribution.is_test = 0 AND contribution.contact_id = {$contactId} ";
- $contactHonoreeContributionsSQL = "
- SELECT contribution.id
- FROM civicrm_contribution contribution
- WHERE contribution.is_test = 0 AND contribution.honor_contact_id = {$contactId} ";
-
$contactSoftCreditContributionsSQL = "
SELECT contribution.id
FROM civicrm_contribution contribution INNER JOIN civicrm_contribution_soft softContribution
$query .= $contactSoftCreditContributionsSQL;
}
- if ($includeHonoree) {
- $query .= " UNION ";
- $query .= $contactHonoreeContributionsSQL;
- }
-
$query .= ") x";
return CRM_Core_DAO::singleValueQuery($query);
);
}
//fail to load payment processor id.
- elseif (!CRM_Utils_Array::value('pledge_payment', $ids)) {
+ elseif (empty($ids['pledge_payment'])) {
$loadObjectSuccess = TRUE;
if ($required) {
throw new Exception("Could not find contribution page for contribution record: " . $this->id);
}
else {
$values['contribution_id'] = $this->id;
- if (CRM_Utils_Array::value('related_contact', $ids)) {
+ if (!empty($ids['related_contact'])) {
$values['related_contact'] = $ids['related_contact'];
if (isset($ids['onbehalf_dupe_alert'])) {
$values['onbehalf_dupe_alert'] = $ids['onbehalf_dupe_alert'];
$this->contact_id
);
// if this is onbehalf of contribution then set related contact
- if (CRM_Utils_Array::value('individual_id', $relatedContact)) {
+ if (!empty($relatedContact['individual_id'])) {
$values['related_contact'] = $ids['related_contact'] = $relatedContact['individual_id'];
}
}
$template->assign('useForMember', true);
}
//assign honor infomation to receiptmessage
- $honorID = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_Contribution',
- $this->id,
- 'honor_contact_id'
- );
- if (!empty($honorID)) {
-
- $honorDefault = $honorIds = array();
- $honorIds['contribution'] = $this->id;
- $idParams = array('id' => $honorID, 'contact_id' => $honorID);
- CRM_Contact_BAO_Contact::retrieve($idParams, $honorDefault, $honorIds);
- $honorType = CRM_Core_PseudoConstant::get('CRM_Contribute_DAO_Contribution', 'honor_type_id');
+ $softRecord = CRM_Contribute_BAO_ContributionSoft::getSoftContribution($this->id);
+
+ if (isset($softRecord['soft_credit'])) {
+ //if id of contribution page is present
+ if (!empty($values['id'])) {
+ $values['honor'] = array(
+ 'honor_profile_values' => array(),
+ 'honor_profile_id' => CRM_Core_DAO::getFieldValue('CRM_Core_DAO_UFJoin', $values['id'], 'uf_group_id', 'entity_id'),
+ 'honor_id' => $softRecord['soft_credit'][1]['contact_id'],
+ );
+ $softCreditTypes = CRM_Core_OptionGroup::values('soft_credit_type');
- $template->assign('honor_block_is_active', 1);
- if (CRM_Utils_Array::value('prefix_id', $honorDefault)) {
- $prefix = CRM_Core_PseudoConstant::get('CRM_Contact_DAO_Contact', 'prefix_id');
- $template->assign('honor_prefix', $prefix[$honorDefault['prefix_id']]);
+ $template->assign('soft_credit_type', $softRecord['soft_credit'][1]['soft_credit_type_label']);
+ $template->assign('honor_block_is_active', CRM_Core_DAO::getFieldValue('CRM_Core_DAO_UFJoin', $values['id'], 'is_active', 'entity_id'));
+ }
+ else {
+ //offline contribution
+ $softCreditTypes = $softCredits = array();
+ foreach ($softRecord['soft_credit'] as $key => $softCredit) {
+ $softCreditTypes[$key] = $softCredit['soft_credit_type_label'];
+ $softCredits[$key] = array(
+ 'Name' => $softCredit['contact_name'],
+ 'Amount' => CRM_Utils_Money::format($softCredit['amount'], $softCredit['currency'])
+ );
+ }
+ $template->assign('softCreditTypes', $softCreditTypes);
+ $template->assign('softCredits', $softCredits);
}
- $template->assign('honor_first_name', CRM_Utils_Array::value('first_name', $honorDefault));
- $template->assign('honor_last_name', CRM_Utils_Array::value('last_name', $honorDefault));
- $template->assign('honor_email', CRM_Utils_Array::value('email', $honorDefault['email'][1]));
- $template->assign('honor_type', $honorType[$this->honor_type_id]);
}
$dao = new CRM_Contribute_DAO_ContributionProduct();
* @access public
* @static
*/
- static function recordFinancialAccounts(&$params) {
+ static function recordFinancialAccounts(&$params, $financialTrxnVals = NULL) {
$skipRecords = $update = FALSE;
+ // in few scenarios we require the trxn record details which has got created
+ $return = NULL;
$additionalParticipantId = array();
$contributionStatuses = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');
$entityID += $additionalParticipantId;
}
// prevContribution appears to mean - original contribution object- ie copy of contribution from before the update started that is being updated
- if (!CRM_Utils_Array::value('prevContribution', $params)) {
+ if (empty($params['prevContribution'])) {
$entityID = NULL;
}
else {
$update = TRUE;
}
+ $statusId = $params['contribution']->contribution_status_id;
+ // CRM-13964 partial payment
+ if (CRM_Utils_Array::value('contribution_status_id', $params) == array_search('Partially paid', $contributionStatuses)
+ && !empty($params['partial_payment_total']) && !empty($params['partial_amount_pay'])) {
+ $partialAmtPay = $params['partial_amount_pay'];
+ $partialAmtTotal = $params['partial_payment_total'];
+
+ $relationTypeId = key(CRM_Core_PseudoConstant::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Accounts Receivable Account is' "));
+ $fromFinancialAccountId = CRM_Contribute_PseudoConstant::financialAccountType($params['financial_type_id'], $relationTypeId);
+ $statusId = CRM_Core_OptionGroup::getValue('contribution_status', 'Completed', 'name');
+ $params['total_amount'] = $partialAmtPay;
+
+ $balanceTrxnInfo = CRM_Core_BAO_FinancialTrxn::getBalanceTrxnAmt($params['contribution']->id, $params['financial_type_id']);
+ if (empty($balanceTrxnInfo['trxn_id'])) {
+ // create new balance transaction record
+ $relationTypeId = key(CRM_Core_PseudoConstant::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Accounts Receivable Account is' "));
+ $toFinancialAccount = CRM_Contribute_PseudoConstant::financialAccountType($params['financial_type_id'], $relationTypeId);
+
+ $balanceTrxnParams['total_amount'] = $partialAmtTotal;
+ $balanceTrxnParams['to_financial_account_id'] = $toFinancialAccount;
+ $balanceTrxnParams['contribution_id'] = $params['contribution']->id;
+ $balanceTrxnParams['trxn_date'] = date('YmdHis');
+ $balanceTrxnParams['fee_amount'] = CRM_Utils_Array::value('fee_amount', $params);
+ $balanceTrxnParams['net_amount'] = CRM_Utils_Array::value('net_amount', $params);
+ $balanceTrxnParams['currency'] = $params['contribution']->currency;
+ $balanceTrxnParams['trxn_id'] = $params['contribution']->trxn_id;
+ $balanceTrxnParams['status_id'] = $statusId;
+ $balanceTrxnParams['payment_instrument_id'] = $params['contribution']->payment_instrument_id;
+ $balanceTrxnParams['check_number'] = CRM_Utils_Array::value('check_number', $params);
+ if (!empty($params['payment_processor'])) {
+ $balanceTrxnParams['payment_processor_id'] = $params['payment_processor'];
+ }
+ CRM_Core_BAO_FinancialTrxn::create($balanceTrxnParams);
+ }
+ }
+
// build line item array if its not set in $params
- if (!CRM_Utils_Array::value('line_item', $params) || $additionalParticipantId) {
+ if (empty($params['line_item']) || $additionalParticipantId) {
CRM_Price_BAO_LineItem::getLineItemArray($params, $entityID, str_replace('civicrm_', '', $entityTable));
}
$relationTypeId = key(CRM_Core_PseudoConstant::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Accounts Receivable Account is' "));
$params['to_financial_account_id'] = CRM_Contribute_PseudoConstant::financialAccountType($params['financial_type_id'], $relationTypeId);
}
- elseif (CRM_Utils_Array::value('payment_processor', $params)) {
+ elseif (!empty($params['payment_processor'])) {
$params['to_financial_account_id'] = CRM_Financial_BAO_FinancialTypeAccount::getFinancialAccount($params['payment_processor'], 'civicrm_payment_processor', 'financial_account_id');
}
- elseif (CRM_Utils_Array::value('payment_instrument_id', $params)) {
+ elseif (!empty($params['payment_instrument_id'])) {
$params['to_financial_account_id'] = CRM_Financial_BAO_FinancialTypeAccount::getInstrumentFinancialAccount($params['payment_instrument_id']);
}
else {
}
$totalAmount = CRM_Utils_Array::value('total_amount', $params);
- if (!isset($totalAmount) && CRM_Utils_Array::value('prevContribution', $params)) {
+ if (!isset($totalAmount) && !empty($params['prevContribution'])) {
$totalAmount = $params['total_amount'] = $params['prevContribution']->total_amount;
}
+
//build financial transaction params
$trxnParams = array(
'contribution_id' => $params['contribution']->id,
'net_amount' => CRM_Utils_Array::value('net_amount', $params),
'currency' => $params['contribution']->currency,
'trxn_id' => $params['contribution']->trxn_id,
- 'status_id' => $params['contribution']->contribution_status_id,
+ 'status_id' => $statusId,
'payment_instrument_id' => $params['contribution']->payment_instrument_id,
'check_number' => CRM_Utils_Array::value('check_number', $params),
);
- if (CRM_Utils_Array::value('payment_processor', $params)) {
+ if (!empty($params['payment_processor'])) {
$trxnParams['payment_processor_id'] = $params['payment_processor'];
}
+
+ if (isset($fromFinancialAccountId)) {
+ $trxnParams['from_financial_account_id'] = $fromFinancialAccountId;
+ }
+
+ // consider external values passed for recording transaction entry
+ if (!empty($financialTrxnVals)) {
+ $trxnParams = array_merge($trxnParams, $financialTrxnVals);
+ }
+
$params['trxnParams'] = $trxnParams;
- if (CRM_Utils_Array::value('prevContribution', $params)) {
+ if (!empty($params['prevContribution'])) {
$params['trxnParams']['total_amount'] = $trxnParams['total_amount'] = $params['total_amount'] = $params['prevContribution']->total_amount;
$params['trxnParams']['fee_amount'] = $params['prevContribution']->fee_amount;
$params['trxnParams']['net_amount'] = $params['prevContribution']->net_amount;
$params['trxnParams']['check_number'] = $params['prevContribution']->check_number;
//if financial type is changed
- if (CRM_Utils_Array::value('financial_type_id', $params) &&
+ if (!empty($params['financial_type_id']) &&
$params['contribution']->financial_type_id != $params['prevContribution']->financial_type_id) {
$incomeTypeId = key(CRM_Core_PseudoConstant::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Income Account is' "));
$oldFinancialAccount = CRM_Contribute_PseudoConstant::financialAccountType($params['prevContribution']->financial_type_id, $incomeTypeId);
}
else {
$lastFinancialTrxnId = CRM_Core_BAO_FinancialTrxn::getFinancialTrxnId($params['prevContribution']->id, 'DESC');
- if (CRM_Utils_Array::value('financialTrxnId', $lastFinancialTrxnId)) {
+ if (!empty($lastFinancialTrxnId['financialTrxnId'])) {
$params['trxnParams']['to_financial_account_id'] = CRM_Core_DAO::getFieldValue('CRM_Financial_DAO_FinancialTrxn', $lastFinancialTrxnId['financialTrxnId'], 'to_financial_account_id');
}
}
//Update contribution status
$params['trxnParams']['status_id'] = $params['contribution']->contribution_status_id;
- if (CRM_Utils_Array::value('contribution_status_id', $params) &&
+ if (!empty($params['contribution_status_id']) &&
$params['prevContribution']->contribution_status_id != $params['contribution']->contribution_status_id) {
//Update Financial Records
self::updateFinancialAccounts($params, 'changedStatus');
}
if (!$update) {
- //records finanical trxn and entity financial trxn
- $financialTxn = CRM_Core_BAO_FinancialTrxn::create($trxnParams);
+ // records finanical trxn and entity financial trxn
+ // also make it available as return value
+ $return = $financialTxn = CRM_Core_BAO_FinancialTrxn::create($trxnParams);
$params['entity_id'] = $financialTxn->id;
}
}
// record line items and finacial items
- if (!CRM_Utils_Array::value('skipLineItem', $params)) {
+ if (empty($params['skipLineItem'])) {
CRM_Price_BAO_LineItem::processPriceSet($entityId, CRM_Utils_Array::value('line_item', $params), $params['contribution'], $entityTable, $update);
}
// create batch entry if batch_id is passed
- if (CRM_Utils_Array::value('batch_id', $params)) {
+ if (!empty($params['batch_id'])) {
$entityParams = array(
'batch_id' => $params['batch_id'],
'entity_table' => 'civicrm_financial_trxn',
}
// when a fee is charged
- if (CRM_Utils_Array::value('fee_amount', $params) && (!CRM_Utils_Array::value('prevContribution', $params)
- || $params['contribution']->fee_amount != $params['prevContribution']->fee_amount) && $skipRecords) {
+ if (!empty($params['fee_amount']) && (empty($params['prevContribution']) || $params['contribution']->fee_amount != $params['prevContribution']->fee_amount) && $skipRecords) {
CRM_Core_BAO_FinancialTrxn::recordFees($params);
}
- if (CRM_Utils_Array::value('prevContribution', $params) && $entityTable == 'civicrm_participant'
+ if (!empty($params['prevContribution']) && $entityTable == 'civicrm_participant'
&& $params['prevContribution']->contribution_status_id != $params['contribution']->contribution_status_id) {
$eventID = CRM_Core_DAO::getFieldValue('CRM_Event_DAO_Participant', $entityId, 'event_id');
$feeLevel[] = str_replace('\ 1', '', $params['prevContribution']->amount_level);
CRM_Event_BAO_Participant::createDiscountTrxn($eventID, $params, $feeLevel);
}
unset($params['line_item']);
+
+ return $return;
}
/**
$itemAmount = $trxnID = NULL;
//get all the statuses
$contributionStatus = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');
- if (($params['prevContribution']->contribution_status_id == array_search('Pending', $contributionStatus)
- || $params['prevContribution']->contribution_status_id == array_search('In Progress', $contributionStatus))
+ if (($params['prevContribution']->contribution_status_id == array_search('Pending', $contributionStatus)
+ || $params['prevContribution']->contribution_status_id == array_search('In Progress', $contributionStatus))
&& $params['contribution']->contribution_status_id == array_search('Completed', $contributionStatus)
&& $context == 'changePaymentInstrument') {
return;
elseif ($context == 'changePaymentInstrument') {
if ($params['trxnParams']['total_amount'] < 0) {
$lastFinancialTrxnId = CRM_Core_BAO_FinancialTrxn::getFinancialTrxnId($params['prevContribution']->id, 'DESC');
- if (CRM_Utils_Array::value('financialTrxnId', $lastFinancialTrxnId)) {
+ if (!empty($lastFinancialTrxnId['financialTrxnId'])) {
$params['trxnParams']['to_financial_account_id'] = CRM_Core_DAO::getFieldValue('CRM_Financial_DAO_FinancialTrxn', $lastFinancialTrxnId['financialTrxnId'], 'to_financial_account_id');
$params['trxnParams']['payment_instrument_id'] = $params['prevContribution']->payment_instrument_id;
}
if ($context == 'changedStatus') {
if (($params['prevContribution']->contribution_status_id == array_search('Pending', $contributionStatus)
- || $params['prevContribution']->contribution_status_id == array_search('In Progress', $contributionStatus))
+ || $params['prevContribution']->contribution_status_id == array_search('In Progress', $contributionStatus))
&& ($params['contribution']->contribution_status_id == array_search('Completed', $contributionStatus))) {
$query = "UPDATE civicrm_financial_item SET status_id = %1 WHERE entity_id = %2 and entity_table = 'civicrm_line_item'";
$sql = "SELECT id, amount FROM civicrm_financial_item WHERE entity_id = %1 and entity_table = 'civicrm_line_item'";
}
$financialAccount = $prevfinancialItem->financial_account_id;
- if (CRM_Utils_Array::value('financial_account_id', $params)) {
+ if (!empty($params['financial_account_id'])) {
$financialAccount = $params['financial_account_id'];
}
if ($params['contribution']->currency) {
$currency = $params['contribution']->currency;
}
- if (CRM_Utils_Array::value('is_quick_config', $params)) {
+ if (!empty($params['is_quick_config'])) {
$amount = $itemAmount;
if (!$amount) {
$amount = $params['total_amount'];
* @static
*/
static function checkStatusValidation($values, &$fields, &$errors) {
- if (CRM_Utils_System::isNull($values) && CRM_Utils_Array::value('id', $fields)) {
+ if (CRM_Utils_System::isNull($values) && !empty($fields['id'])) {
$values['contribution_status_id'] = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_Contribution', $fields['id'], 'contribution_status_id');
if ($values['contribution_status_id'] == $fields['contribution_status_id']) {
return FALSE;
}
return FALSE;
}
-}
+ /*
+ * Function to record additional payment for partial and refund contributions
+ *
+ * @param integer $contributionId : is the invoice contribution id (got created after processing participant payment)
+ * @param array $trxnData : to take user provided input of transaction details.
+ * @param string $paymentType 'owed' for purpose of recording partial payments, 'refund' for purpose of recording refund payments
+ */
+ static function recordAdditionalPayment($contributionId, $trxnsData, $paymentType = 'owed', $participantId = NULL) {
+ $statusId = CRM_Core_OptionGroup::getValue('contribution_status', 'Completed', 'name');
+ $getInfoOf['id'] = $contributionId;
+ $defaults = array();
+ $contributionDAO = CRM_Contribute_BAO_Contribution::retrieve($getInfoOf, $defaults, CRM_Core_DAO::$_nullArray);
+
+ if ($paymentType == 'owed') {
+ // build params for recording financial trxn entry
+ $params['contribution'] = $contributionDAO;
+ $params = array_merge($defaults, $params);
+ $params['skipLineItem'] = TRUE;
+ $params['partial_payment_total'] = $contributionDAO->total_amount;
+ $params['partial_amount_pay'] = $trxnsData['total_amount'];
+ $trxnsData['trxn_date'] = !empty($trxnsData['trxn_date']) ? $trxnsData['trxn_date'] : date('YmdHis');
+
+ // record the entry
+ $financialTrxn = CRM_Contribute_BAO_Contribution::recordFinancialAccounts($params, $trxnsData);
+ $relationTypeId = key(CRM_Core_PseudoConstant::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Accounts Receivable Account is' "));
+ $toFinancialAccount = CRM_Contribute_PseudoConstant::financialAccountType($contributionDAO->financial_type_id, $relationTypeId);
+
+ $trxnId = CRM_Core_BAO_FinancialTrxn::getBalanceTrxnAmt($contributionId, $contributionDAO->financial_type_id);
+ $trxnId = $trxnId['trxn_id'];
+
+ // update statuses
+ // criteria for updates contribution total_amount == financial_trxns of partial_payments
+ $sql = "SELECT SUM(ft.total_amount) as sum_of_payments
+FROM civicrm_financial_trxn ft
+LEFT JOIN civicrm_entity_financial_trxn eft
+ ON (ft.id = eft.financial_trxn_id)
+WHERE eft.entity_table = 'civicrm_contribution'
+ AND eft.entity_id = {$contributionId}
+ AND ft.to_financial_account_id != {$toFinancialAccount}
+ AND ft.status_id = {$statusId}
+";
+ $sumOfPayments = CRM_Core_DAO::singleValueQuery($sql);
+
+ // update statuses
+ if ($contributionDAO->total_amount == $sumOfPayments) {
+ // update contribution status
+ $contributionUpdate['id'] = $contributionId;
+ $contributionUpdate['contribution_status_id'] = $statusId;
+ $contributionUpdate['skipLineItem'] = TRUE;
+ // note : not using the self::add method,
+ // the reason because it performs 'status change' related code execution for financial records
+ // which in 'Partial Paid' => 'Completed' is not useful, instead specific financial record updates
+ // are coded below i.e. just updating financial_item status to 'Paid'
+ $contributionDetails = CRM_Core_DAO::setFieldValue('CRM_Contribute_BAO_Contribution', $contributionId, 'contribution_status_id', $statusId);
+
+ if ($participantId) {
+ // update participant status
+ $participantUpdate['id'] = $participantId;
+ $participantStatuses = CRM_Event_PseudoConstant::participantStatus();
+ $participantUpdate['status_id'] = array_search('Registered', $participantStatuses);
+ CRM_Event_BAO_Participant::add($participantUpdate);
+ }
+
+ // update financial item statuses
+ $financialItemStatus = CRM_Core_PseudoConstant::get('CRM_Financial_DAO_FinancialItem', 'status_id');
+ $paidStatus = array_search('Paid', $financialItemStatus);
+
+ $baseTrxnId = CRM_Core_BAO_FinancialTrxn::getFinancialTrxnId($contributionId);
+ $sqlFinancialItemUpdate = "
+UPDATE civicrm_financial_item fi
+ LEFT JOIN civicrm_entity_financial_trxn eft
+ ON (eft.entity_id = fi.id AND eft.entity_table = 'civicrm_financial_item')
+SET status_id = {$paidStatus}
+WHERE eft.financial_trxn_id IN ({$trxnId}, {$baseTrxnId['financialTrxnId']})
+";
+ CRM_Core_DAO::executeQuery($sqlFinancialItemUpdate);
+ }
+ }
+ elseif ($paymentType == 'refund') {
+ // build params for recording financial trxn entry
+ $params['contribution'] = $contributionDAO;
+ $params = array_merge($defaults, $params);
+ $params['skipLineItem'] = TRUE;
+ $trxnsData['trxn_date'] = !empty($trxnsData['trxn_date']) ? $trxnsData['trxn_date'] : date('YmdHis');
+ $trxnsData['total_amount'] = - $trxnsData['total_amount'];
+
+ $relationTypeId = key(CRM_Core_PseudoConstant::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Accounts Receivable Account is' "));
+ $trxnsData['from_financial_account_id'] = CRM_Contribute_PseudoConstant::financialAccountType($contributionDAO->financial_type_id, $relationTypeId);
+ $trxnsData['status_id'] = CRM_Core_OptionGroup::getValue('contribution_status', 'Refunded', 'name');
+ // record the entry
+ $financialTrxn = CRM_Contribute_BAO_Contribution::recordFinancialAccounts($params, $trxnsData);
+
+ // note : not using the self::add method,
+ // the reason because it performs 'status change' related code execution for financial records
+ // which in 'Pending Refund' => 'Completed' is not useful, instead specific financial record updates
+ // are coded below i.e. just updating financial_item status to 'Paid'
+ $contributionDetails = CRM_Core_DAO::setFieldValue('CRM_Contribute_BAO_Contribution', $contributionId, 'contribution_status_id', $statusId);
+
+ // add financial item entry
+ $financialItemStatus = CRM_Core_PseudoConstant::get('CRM_Financial_DAO_FinancialItem', 'status_id');
+ $getLine['entity_id'] = $contributionDAO->id;
+ $getLine['entity_table'] = 'civicrm_contribution';
+ $lineItemId = CRM_Price_BAO_LineItem::retrieve($getLine, CRM_Core_DAO::$_nullArray);
+ $addFinancialEntry = array(
+ 'transaction_date' => $financialTrxn->trxn_date,
+ 'contact_id' => $contributionDAO->contact_id,
+ 'amount' => $financialTrxn->total_amount,
+ 'status_id' => array_search('Paid', $financialItemStatus),
+ 'entity_id' => $lineItemId->id,
+ 'entity_table' => 'civicrm_line_item'
+ );
+ $trxnIds['id'] = $financialTrxn->id;
+ CRM_Financial_BAO_FinancialItem::create($addFinancialEntry, NULL, $trxnIds);
+
+ if ($participantId) {
+ // update participant status
+ $participantUpdate['id'] = $participantId;
+ $participantStatuses = CRM_Event_PseudoConstant::participantStatus();
+ $participantUpdate['status_id'] = array_search('Registered', $participantStatuses);
+ CRM_Event_BAO_Participant::add($participantUpdate);
+ }
+ }
+
+ // activity creation
+ if (!empty($financialTrxn)) {
+ if ($participantId) {
+ $inputParams['id'] = $participantId;
+ $values = array();
+ $ids = array();
+ $component = 'event';
+ $entityObj = CRM_Event_BAO_Participant::getValues($inputParams, $values, $ids);
+ $entityObj = $entityObj[$participantId];
+ }
+ $activityType = ($paymentType == 'refund') ? 'Refund' : 'Payment';
+
+ self::addActivityForPayment($entityObj, $financialTrxn, $activityType, $component, $contributionId);
+ }
+ return $financialTrxn;
+ }
+
+ static function addActivityForPayment($entityObj, $trxnObj, $activityType, $component, $contributionId) {
+ if ($component == 'event') {
+ $date = CRM_Utils_Date::isoToMysql($trxnObj->trxn_date);
+ $paymentAmount = CRM_Utils_Money::format($trxnObj->total_amount, $trxnObj->currency);
+ $eventTitle = CRM_Core_DAO::getFieldValue('CRM_Event_BAO_Event', $entityObj->event_id, 'title');
+ $subject = "{$paymentAmount} - Offline {$activityType} for {$eventTitle}";
+ $targetCid = $entityObj->contact_id;
+ // source record id would be the contribution id
+ $srcRecId = $contributionId;
+ }
+
+ // activity params
+ $activityParams = array(
+ 'source_contact_id' => $targetCid,
+ 'source_record_id' => $srcRecId,
+ 'activity_type_id' => CRM_Core_OptionGroup::getValue('activity_type',
+ $activityType,
+ 'name'
+ ),
+ 'subject' => $subject,
+ 'activity_date_time' => $date,
+ 'status_id' => CRM_Core_OptionGroup::getValue('activity_status',
+ 'Completed',
+ 'name'
+ ),
+ 'skipRecentView' => TRUE,
+ );
+
+ // create activity with target contacts
+ $session = CRM_Core_Session::singleton();
+ $id = $session->get('userID');
+ if ($id) {
+ $activityParams['source_contact_id'] = $id;
+ $activityParams['target_contact_id'][] = $targetCid;
+ }
+ CRM_Activity_BAO_Activity::create($activityParams);
+ }
+
+ static function getPaymentInfo($id, $component, $getTrxnInfo = FALSE, $usingLineTotal = FALSE) {
+ if ($component == 'event') {
+ $entity = 'participant';
+ $entityTable = 'civicrm_participant';
+ $contributionId = CRM_Core_DAO::getFieldValue('CRM_Event_BAO_ParticipantPayment', $id, 'contribution_id', 'participant_id');
+ }
+ $total = CRM_Core_BAO_FinancialTrxn::getBalanceTrxnAmt($contributionId);
+ $baseTrxnId = !empty($total['trxn_id']) ? $total['trxn_id'] : NULL;
+ $isBalance = NULL;
+ if ($baseTrxnId) {
+ $isBalance = TRUE;
+ }
+ else {
+ $baseTrxnId = CRM_Core_BAO_FinancialTrxn::getFinancialTrxnId($contributionId);
+ $baseTrxnId = $baseTrxnId['financialTrxnId'];
+ $isBalance = FALSE;
+ }
+ if (empty($total) || $usingLineTotal) {
+ $total = CRM_Price_BAO_LineItem::getLineTotal($id, $entityTable);
+ }
+ else {
+ $baseTrxnId = $total['trxn_id'];
+ $total = $total['total_amount'];
+ }
+
+ $paymentBalance = CRM_Core_BAO_FinancialTrxn::getPartialPaymentWithType($id, $entity, FALSE, $total);
+ $info['total'] = $total;
+ $info['paid'] = $total - $paymentBalance;
+ $info['balance'] = $paymentBalance;
+ $info['id'] = $id;
+ $info['component'] = $component;
+ $rows = array();
+ if ($getTrxnInfo && $baseTrxnId) {
+ $sql = "
+SELECT ft.total_amount, con.financial_type_id, ft.payment_instrument_id, ft.trxn_date, ft.trxn_id, ft.status_id, ft.check_number
+FROM civicrm_contribution con
+ LEFT JOIN civicrm_entity_financial_trxn eft ON (eft.entity_id = con.id AND eft.entity_table = 'civicrm_contribution')
+ LEFT JOIN civicrm_financial_trxn ft ON ft.id = eft.financial_trxn_id
+WHERE con.id = {$contributionId}
+";
+
+ // conditioned WHERE clause
+ if ($isBalance) {
+ // if balance trxn exists don't include details of it in transaction info
+ $sql .= " AND ft.id != {$baseTrxnId} ";
+ }
+ $resultDAO = CRM_Core_DAO::executeQuery($sql);
+
+ $statuses = CRM_Contribute_PseudoConstant::contributionStatus();
+ $financialTypes = CRM_Contribute_PseudoConstant::financialType();
+ while($resultDAO->fetch()) {
+ $paidByLabel = CRM_Core_PseudoConstant::getLabel('CRM_Core_BAO_FinancialTrxn', 'payment_instrument_id', $resultDAO->payment_instrument_id);
+ $paidByName = CRM_Core_PseudoConstant::getName('CRM_Core_BAO_FinancialTrxn', 'payment_instrument_id', $resultDAO->payment_instrument_id);
+ $val = array(
+ 'total_amount' => $resultDAO->total_amount,
+ 'financial_type' => $financialTypes[$resultDAO->financial_type_id],
+ 'payment_instrument' => $paidByLabel,
+ 'receive_date' => $resultDAO->trxn_date,
+ 'trxn_id' => $resultDAO->trxn_id,
+ 'status' => $statuses[$resultDAO->status_id],
+ );
+ if ($paidByName == 'Check') {
+ $val['check_number'] = $resultDAO->check_number;
+ }
+ $rows[] = $val;
+ }
+ $info['transaction'] = $rows;
+ }
+ return $info;
+ }
+}
projects / civicrm-core.git / blobdiff