$dontCare) {
$scheduledAmount = CRM_Core_DAO::getFieldValue(
'CRM_Pledge_DAO_PledgePayment',
$paymentId,
'scheduled_amount',
'id'
);
$pledgePayment = ($amount >= $scheduledAmount) ? $scheduledAmount : $amount;
if ($pledgePayment > 0) {
$pledgePaymentParams[] = [
'id' => $paymentId,
'contribution_id' => $contribution->id,
'status_id' => $contribution->contribution_status_id,
'actual_amount' => $pledgePayment,
];
$amount -= $pledgePayment;
}
}
if ($amount > 0 && count($pledgePaymentParams)) {
$pledgePaymentParams[count($pledgePaymentParams) - 1]['actual_amount'] += $amount;
}
foreach ($pledgePaymentParams as $p) {
CRM_Pledge_BAO_PledgePayment::add($p);
}
//update pledge status according to the new payment statuses
CRM_Pledge_BAO_PledgePayment::updatePledgePaymentStatus($pledgeID);
return $form;
}
else {
//when user creating pledge record.
$pledgeParams = [];
$pledgeParams['contact_id'] = $contribution->contact_id;
$pledgeParams['installment_amount'] = $pledgeParams['actual_amount'] = $contribution->total_amount;
$pledgeParams['contribution_id'] = $contribution->id;
$pledgeParams['contribution_page_id'] = $contribution->contribution_page_id;
$pledgeParams['financial_type_id'] = $contribution->financial_type_id;
$pledgeParams['frequency_interval'] = $params['pledge_frequency_interval'];
$pledgeParams['installments'] = $params['pledge_installments'];
$pledgeParams['frequency_unit'] = $params['pledge_frequency_unit'];
if ($pledgeParams['frequency_unit'] == 'month') {
$pledgeParams['frequency_day'] = intval(date("d"));
}
else {
$pledgeParams['frequency_day'] = 1;
}
$pledgeParams['create_date'] = $pledgeParams['start_date'] = $pledgeParams['scheduled_date'] = date("Ymd");
if (CRM_Utils_Array::value('start_date', $params)) {
$pledgeParams['frequency_day'] = intval(date("d", strtotime(CRM_Utils_Array::value('start_date', $params))));
$pledgeParams['start_date'] = $pledgeParams['scheduled_date'] = date('Ymd', strtotime(CRM_Utils_Array::value('start_date', $params)));
}
$pledgeParams['status_id'] = $contribution->contribution_status_id;
$pledgeParams['max_reminders'] = $form->_values['max_reminders'];
$pledgeParams['initial_reminder_day'] = $form->_values['initial_reminder_day'];
$pledgeParams['additional_reminder_day'] = $form->_values['additional_reminder_day'];
$pledgeParams['is_test'] = $contribution->is_test;
$pledgeParams['acknowledge_date'] = date('Ymd');
$pledgeParams['original_installment_amount'] = $pledgeParams['installment_amount'];
//inherit campaign from contirb page.
$pledgeParams['campaign_id'] = CRM_Utils_Array::value('campaign_id', $contributionParams);
$pledge = CRM_Pledge_BAO_Pledge::create($pledgeParams);
$form->_params['pledge_id'] = $pledge->id;
//send acknowledgment email. only when pledge is created
if ($pledge->id && $isEmailReceipt) {
//build params to send acknowledgment.
$pledgeParams['id'] = $pledge->id;
$pledgeParams['receipt_from_name'] = $form->_values['receipt_from_name'];
$pledgeParams['receipt_from_email'] = $form->_values['receipt_from_email'];
//scheduled amount will be same as installment_amount.
$pledgeParams['scheduled_amount'] = $pledgeParams['installment_amount'];
//get total pledge amount.
$pledgeParams['total_pledge_amount'] = $pledge->amount;
CRM_Pledge_BAO_Pledge::sendAcknowledgment($form, $pledgeParams);
return $form;
}
return $form;
}
}
/**
* Set the parameters to be passed to contribution create function.
*
* @param array $params
* @param int $financialTypeID
* @param array $paymentProcessorOutcome
* @param string $receiptDate
* @param int $recurringContributionID
*
* @return array
*/
public static function getContributionParams(
$params, $financialTypeID,
$paymentProcessorOutcome, $receiptDate, $recurringContributionID) {
$contributionParams = [
'financial_type_id' => $financialTypeID,
'receive_date' => (CRM_Utils_Array::value('receive_date', $params)) ? CRM_Utils_Date::processDate($params['receive_date']) : date('YmdHis'),
'tax_amount' => CRM_Utils_Array::value('tax_amount', $params),
'amount_level' => CRM_Utils_Array::value('amount_level', $params),
'invoice_id' => $params['invoiceID'],
'currency' => $params['currencyID'],
'is_pay_later' => CRM_Utils_Array::value('is_pay_later', $params, 0),
//configure cancel reason, cancel date and thankyou date
//from 'contribution' type profile if included
'cancel_reason' => CRM_Utils_Array::value('cancel_reason', $params, 0),
'cancel_date' => isset($params['cancel_date']) ? CRM_Utils_Date::format($params['cancel_date']) : NULL,
'thankyou_date' => isset($params['thankyou_date']) ? CRM_Utils_Date::format($params['thankyou_date']) : NULL,
//setting to make available to hook - although seems wrong to set on form for BAO hook availability
'skipLineItem' => CRM_Utils_Array::value('skipLineItem', $params, 0),
];
if ($paymentProcessorOutcome) {
$contributionParams['payment_processor'] = CRM_Utils_Array::value('payment_processor', $paymentProcessorOutcome);
}
if (!empty($params["is_email_receipt"])) {
$contributionParams += [
'receipt_date' => $receiptDate,
];
}
if ($recurringContributionID) {
$contributionParams['contribution_recur_id'] = $recurringContributionID;
}
$contributionParams['contribution_status_id'] = CRM_Core_PseudoConstant::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Pending');
if (isset($contributionParams['invoice_id'])) {
$contributionParams['id'] = CRM_Core_DAO::getFieldValue(
'CRM_Contribute_DAO_Contribution',
$contributionParams['invoice_id'],
'id',
'invoice_id'
);
}
return $contributionParams;
}
/**
* Get non-deductible amount.
*
* This is a bit too much about wierd form interpretation to be this deep.
*
* CRM-11885
* if non_deductible_amount exists i.e. Additional Details fieldset was opened [and staff typed something] -> keep
* it.
*
* @param array $params
* @param CRM_Financial_BAO_FinancialType $financialType
* @param bool $online
* @param CRM_Contribute_Form_Contribution_Confirm $form
*
* @return array
*/
protected static function getNonDeductibleAmount($params, $financialType, $online, $form) {
if (isset($params['non_deductible_amount']) && (!empty($params['non_deductible_amount']))) {
return $params['non_deductible_amount'];
}
$priceSetId = CRM_Utils_Array::value('priceSetId', $params);
// return non-deductible amount if it is set at the price field option level
if ($priceSetId && !empty($form->_lineItem)) {
$nonDeductibleAmount = CRM_Price_BAO_PriceSet::getNonDeductibleAmountFromPriceSet($priceSetId, $form->_lineItem);
}
if (!empty($nonDeductibleAmount)) {
return $nonDeductibleAmount;
}
else {
if ($financialType->is_deductible) {
if ($online && isset($params['selectProduct'])) {
$selectProduct = CRM_Utils_Array::value('selectProduct', $params);
}
if (!$online && isset($params['product_name'][0])) {
$selectProduct = $params['product_name'][0];
}
// if there is a product - compare the value to the contribution amount
if (isset($selectProduct) &&
$selectProduct != 'no_thanks'
) {
$productDAO = new CRM_Contribute_DAO_Product();
$productDAO->id = $selectProduct;
$productDAO->find(TRUE);
// product value exceeds contribution amount
if ($params['amount'] < $productDAO->price) {
$nonDeductibleAmount = $params['amount'];
return $nonDeductibleAmount;
}
// product value does NOT exceed contribution amount
else {
return $productDAO->price;
}
}
// contribution is deductible - but there is no product
else {
return '0.00';
}
}
// contribution is NOT deductible
else {
return $params['amount'];
}
}
}
/**
* Set variables up before form is built.
*/
public function preProcess() {
$config = CRM_Core_Config::singleton();
parent::preProcess();
// lineItem isn't set until Register postProcess
$this->_lineItem = $this->get('lineItem');
$this->_ccid = $this->get('ccid');
$this->_params = $this->controller->exportValues('Main');
$this->_params['ip_address'] = CRM_Utils_System::ipAddress();
$this->_params['amount'] = $this->get('amount');
if (isset($this->_params['amount'])) {
$this->setFormAmountFields($this->_params['priceSetId']);
}
$this->_params['tax_amount'] = $this->get('tax_amount');
$this->_useForMember = $this->get('useForMember');
if (isset($this->_params['credit_card_exp_date'])) {
$this->_params['year'] = CRM_Core_Payment_Form::getCreditCardExpirationYear($this->_params);
$this->_params['month'] = CRM_Core_Payment_Form::getCreditCardExpirationMonth($this->_params);
}
$this->_params['currencyID'] = $config->defaultCurrency;
if (!empty($this->_membershipBlock)) {
$this->_params['selectMembership'] = $this->get('selectMembership');
}
if (!empty($this->_paymentProcessor) && $this->_paymentProcessor['object']->supports('preApproval')) {
$preApprovalParams = $this->_paymentProcessor['object']->getPreApprovalDetails($this->get('pre_approval_parameters'));
$this->_params = array_merge($this->_params, $preApprovalParams);
// We may have fetched some billing details from the getPreApprovalDetails function so we
// want to ensure we set this after that function has been called.
CRM_Core_Payment_Form::mapParams($this->_bltID, $preApprovalParams, $this->_params, FALSE);
}
$this->_params['is_pay_later'] = $this->get('is_pay_later');
$this->assign('is_pay_later', $this->_params['is_pay_later']);
if ($this->_params['is_pay_later']) {
$this->assign('pay_later_receipt', CRM_Utils_Array::value('pay_later_receipt', $this->_values));
}
// if onbehalf-of-organization
if (!empty($this->_values['onbehalf_profile_id']) && !empty($this->_params['onbehalf']['organization_name'])) {
if (empty($this->_params['org_option']) && empty($this->_params['organization_id'])) {
$this->_params['organization_id'] = CRM_Utils_Array::value('onbehalfof_id', $this->_params);
}
$this->_params['organization_name'] = $this->_params['onbehalf']['organization_name'];
$addressBlocks = [
'street_address',
'city',
'state_province',
'postal_code',
'country',
'supplemental_address_1',
'supplemental_address_2',
'supplemental_address_3',
'postal_code_suffix',
'geo_code_1',
'geo_code_2',
'address_name',
];
$blocks = ['email', 'phone', 'im', 'url', 'openid'];
foreach ($this->_params['onbehalf'] as $loc => $value) {
$field = $typeId = NULL;
if (strstr($loc, '-')) {
list($field, $locType) = explode('-', $loc);
}
if (in_array($field, $addressBlocks)) {
if ($locType == 'Primary') {
$defaultLocationType = CRM_Core_BAO_LocationType::getDefault();
$locType = $defaultLocationType->id;
}
if ($field == 'country') {
$value = CRM_Core_PseudoConstant::countryIsoCode($value);
}
elseif ($field == 'state_province') {
$value = CRM_Core_PseudoConstant::stateProvinceAbbreviation($value);
}
$isPrimary = 1;
if (isset($this->_params['onbehalf_location']['address'])
&& count($this->_params['onbehalf_location']['address']) > 0
) {
$isPrimary = 0;
}
$this->_params['onbehalf_location']['address'][$locType][$field] = $value;
if (empty($this->_params['onbehalf_location']['address'][$locType]['is_primary'])) {
$this->_params['onbehalf_location']['address'][$locType]['is_primary'] = $isPrimary;
}
$this->_params['onbehalf_location']['address'][$locType]['location_type_id'] = $locType;
}
elseif (in_array($field, $blocks)) {
if (!$typeId || is_numeric($typeId)) {
$blockName = $fieldName = $field;
$locationType = 'location_type_id';
if ($locType == 'Primary') {
$defaultLocationType = CRM_Core_BAO_LocationType::getDefault();
$locationValue = $defaultLocationType->id;
}
else {
$locationValue = $locType;
}
$locTypeId = '';
$phoneExtField = [];
if ($field == 'url') {
$blockName = 'website';
$locationType = 'website_type_id';
list($field, $locationValue) = explode('-', $loc);
}
elseif ($field == 'im') {
$fieldName = 'name';
$locTypeId = 'provider_id';
$typeId = $this->_params['onbehalf']["{$loc}-provider_id"];
}
elseif ($field == 'phone') {
list($field, $locType, $typeId) = explode('-', $loc);
$locTypeId = 'phone_type_id';
//check if extension field exists
$extField = str_replace('phone', 'phone_ext', $loc);
if (isset($this->_params['onbehalf'][$extField])) {
$phoneExtField = ['phone_ext' => $this->_params['onbehalf'][$extField]];
}
}
$isPrimary = 1;
if (isset($this->_params['onbehalf_location'][$blockName])
&& count($this->_params['onbehalf_location'][$blockName]) > 0
) {
$isPrimary = 0;
}
if ($locationValue) {
$blockValues = [
$fieldName => $value,
$locationType => $locationValue,
'is_primary' => $isPrimary,
];
if ($locTypeId) {
$blockValues = array_merge($blockValues, [$locTypeId => $typeId]);
}
if (!empty($phoneExtField)) {
$blockValues = array_merge($blockValues, $phoneExtField);
}
$this->_params['onbehalf_location'][$blockName][] = $blockValues;
}
}
}
elseif (strstr($loc, 'custom')) {
if ($value && isset($this->_params['onbehalf']["{$loc}_id"])) {
$value = $this->_params['onbehalf']["{$loc}_id"];
}
$this->_params['onbehalf_location']["{$loc}"] = $value;
}
else {
if ($loc == 'contact_sub_type') {
$this->_params['onbehalf_location'][$loc] = $value;
}
else {
$this->_params['onbehalf_location'][$field] = $value;
}
}
}
}
elseif (!empty($this->_values['is_for_organization'])) {
// no on behalf of an organization, CRM-5519
// so reset loc blocks from main params.
foreach ([
'phone',
'email',
'address',
] as $blk) {
if (isset($this->_params[$blk])) {
unset($this->_params[$blk]);
}
}
}
$this->setRecurringMembershipParams();
if ($this->_pcpId) {
$params = $this->processPcp($this, $this->_params);
$this->_params = $params;
}
$this->_params['invoiceID'] = $this->get('invoiceID');
//carry campaign from profile.
if (array_key_exists('contribution_campaign_id', $this->_params)) {
$this->_params['campaign_id'] = $this->_params['contribution_campaign_id'];
}
// assign contribution page id to the template so we can add css class for it
$this->assign('contributionPageID', $this->_id);
$this->assign('is_for_organization', CRM_Utils_Array::value('is_for_organization', $this->_params));
$this->set('params', $this->_params);
}
/**
* Build the form object.
*/
public function buildQuickForm() {
// FIXME: Some of this code is identical to Thankyou.php and should be broken out into a shared function
$this->assignToTemplate();
$params = $this->_params;
// make sure we have values for it
if (!empty($this->_values['honoree_profile_id']) && !empty($params['soft_credit_type_id']) && empty($this->_ccid)) {
$honorName = NULL;
$softCreditTypes = CRM_Core_OptionGroup::values("soft_credit_type", FALSE);
$this->assign('soft_credit_type', $softCreditTypes[$params['soft_credit_type_id']]);
CRM_Contribute_BAO_ContributionSoft::formatHonoreeProfileFields($this, $params['honor']);
$fieldTypes = ['Contact'];
$fieldTypes[] = CRM_Core_BAO_UFGroup::getContactType($this->_values['honoree_profile_id']);
$this->buildCustom($this->_values['honoree_profile_id'], 'honoreeProfileFields', TRUE, 'honor', $fieldTypes);
}
$this->assign('receiptFromEmail', CRM_Utils_Array::value('receipt_from_email', $this->_values));
$amount_block_is_active = $this->get('amount_block_is_active');
$this->assign('amount_block_is_active', $amount_block_is_active);
// Make a copy of line items array to use for display only
$tplLineItems = $this->_lineItem;
if (CRM_Invoicing_Utils::isInvoicingEnabled()) {
// @todo $params seems like exactly the wrong place to get totalTaxAmount from
// this is a calculated variable so we it should be transparent how we
// calculated it rather than coming from 'params'
$this->assign('totalTaxAmount', $params['tax_amount']);
}
$this->assignLineItemsToTemplate($tplLineItems);
$isDisplayLineItems = $this->_priceSetId && !CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceSet', $this->_priceSetId, 'is_quick_config');
$this->assign('isDisplayLineItems', $isDisplayLineItems);
if (!$isDisplayLineItems) {
// quickConfig is deprecated in favour of isDisplayLineItems. Lots of logic has been harnessed to quick config
// whereas isDisplayLineItems is specific & clear.
$this->assign('is_quick_config', 1);
$this->_params['is_quick_config'] = 1;
}
if (!empty($params['selectProduct']) && $params['selectProduct'] != 'no_thanks') {
$option = CRM_Utils_Array::value('options_' . $params['selectProduct'], $params);
$productID = $params['selectProduct'];
CRM_Contribute_BAO_Premium::buildPremiumBlock($this, $this->_id, FALSE,
$productID, $option
);
$this->set('productID', $productID);
$this->set('option', $option);
}
$config = CRM_Core_Config::singleton();
if (in_array('CiviMember', $config->enableComponents) && empty($this->_ccid)) {
if (isset($params['selectMembership']) &&
$params['selectMembership'] != 'no_thanks'
) {
$this->buildMembershipBlock(
$this->_membershipContactID,
FALSE,
$params['selectMembership'],
FALSE
);
if (!empty($params['auto_renew'])) {
$this->assign('auto_renew', TRUE);
}
}
else {
$this->assign('membershipBlock', FALSE);
}
}
if (empty($this->_ccid)) {
$this->buildCustom($this->_values['custom_pre_id'], 'customPre', TRUE);
$this->buildCustom($this->_values['custom_post_id'], 'customPost', TRUE);
}
if (!empty($this->_values['onbehalf_profile_id']) &&
!empty($params['onbehalf']) &&
($this->_values['is_for_organization'] == 2 ||
!empty($params['is_for_organization'])
) && empty($this->_ccid)
) {
$fieldTypes = ['Contact', 'Organization'];
$contactSubType = CRM_Contact_BAO_ContactType::subTypes('Organization');
$fieldTypes = array_merge($fieldTypes, $contactSubType);
if (is_array($this->_membershipBlock) && !empty($this->_membershipBlock)) {
$fieldTypes = array_merge($fieldTypes, ['Membership']);
}
else {
$fieldTypes = array_merge($fieldTypes, ['Contribution']);
}
$this->buildCustom($this->_values['onbehalf_profile_id'], 'onbehalfProfile', TRUE, 'onbehalf', $fieldTypes);
}
$this->_separateMembershipPayment = $this->get('separateMembershipPayment');
$this->assign('is_separate_payment', $this->_separateMembershipPayment);
$this->assign('priceSetID', $this->_priceSetId);
// The concept of contributeMode is deprecated.
// the is_monetary concept probably should be too as it can be calculated from
// the existence of 'amount' & seems fragile.
if ($this->_contributeMode == 'notify' ||
$this->_amount <= 0.0 || $this->_params['is_pay_later']
) {
$contribButton = ts('Continue');
}
elseif (!empty($this->_ccid)) {
$contribButton = ts('Make Payment');
}
else {
$contribButton = ts('Make Contribution');
}
$this->assign('button', $contribButton);
$this->assign('continueText',
$this->getPaymentProcessorObject()->getText('contributionPageContinueText', [
'is_payment_to_existing' => !empty($this->_ccid),
'amount' => $this->_amount,
])
);
$this->addButtons([
[
'type' => 'next',
'name' => $contribButton,
'spacing' => ' ',
'isDefault' => TRUE,
'js' => ['onclick' => "return submitOnce(this,'" . $this->_name . "','" . ts('Processing') . "');"],
],
[
'type' => 'back',
'name' => ts('Go Back'),
],
]);
$defaults = [];
$fields = array_fill_keys(array_keys($this->_fields), 1);
$fields["billing_state_province-{$this->_bltID}"] = $fields["billing_country-{$this->_bltID}"] = $fields["email-{$this->_bltID}"] = 1;
$contact = $this->_params;
foreach ($fields as $name => $dontCare) {
// Recursively set defaults for nested fields
if (isset($contact[$name]) && is_array($contact[$name]) && ($name == 'onbehalf' || $name == 'honor')) {
foreach ($contact[$name] as $fieldName => $fieldValue) {
if (is_array($fieldValue) && !in_array($this->_fields[$name][$fieldName]['html_type'], [
'Multi-Select',
'AdvMulti-Select',
])
) {
foreach ($fieldValue as $key => $value) {
$defaults["{$name}[{$fieldName}][{$key}]"] = $value;
}
}
else {
$defaults["{$name}[{$fieldName}]"] = $fieldValue;
}
}
}
elseif (isset($contact[$name])) {
$defaults[$name] = $contact[$name];
if (substr($name, 0, 7) == 'custom_') {
$timeField = "{$name}_time";
if (isset($contact[$timeField])) {
$defaults[$timeField] = $contact[$timeField];
}
if (isset($contact["{$name}_id"])) {
$defaults["{$name}_id"] = $contact["{$name}_id"];
}
}
elseif (in_array($name, [
'addressee',
'email_greeting',
'postal_greeting',
]) && !empty($contact[$name . '_custom'])
) {
$defaults[$name . '_custom'] = $contact[$name . '_custom'];
}
}
}
$this->assign('useForMember', $this->get('useForMember'));
$this->setDefaults($defaults);
$this->freeze();
}
/**
* Overwrite action.
*
* Since we are only showing elements in frozen mode no help display needed.
*
* @return int
*/
public function getAction() {
if ($this->_action & CRM_Core_Action::PREVIEW) {
return CRM_Core_Action::VIEW | CRM_Core_Action::PREVIEW;
}
else {
return CRM_Core_Action::VIEW;
}
}
/**
* Set default values for the form.
*
* Note that in edit/view mode
* the default values are retrieved from the database
*/
public function setDefaultValues() {
}
/**
* Process the form.
*/
public function postProcess() {
$contactID = $this->getContactID();
try {
$result = $this->processFormSubmission($contactID);
}
catch (CRM_Core_Exception $e) {
$this->bounceOnError($e->getMessage());
}
if (is_array($result) && !empty($result['is_payment_failure'])) {
$this->bounceOnError($result['error']->getMessage());
}
// Presumably this is for hooks to access? Not quite clear & perhaps not required.
$this->set('params', $this->_params);
}
/**
* Wrangle financial type ID.
*
* This wrangling of the financialType ID was happening in a shared function rather than in the form it relates to & hence has been moved to that form
* Pledges are not relevant to the membership code so that portion will not go onto the membership form.
*
* Comments from previous refactor indicate doubt as to what was going on.
*
* @param int $financialTypeID
*
* @return null|string
*/
public function wrangleFinancialTypeID($financialTypeID) {
if (empty($financialTypeID) && !empty($this->_values['pledge_id'])) {
$financialTypeID = CRM_Core_DAO::getFieldValue('CRM_Pledge_DAO_Pledge',
$this->_values['pledge_id'],
'financial_type_id'
);
}
return $financialTypeID;
}
/**
* Process the form.
*
* @param array $premiumParams
* @param CRM_Contribute_BAO_Contribution $contribution
*/
protected function postProcessPremium($premiumParams, $contribution) {
$hour = $minute = $second = 0;
// assigning Premium information to receipt tpl
$selectProduct = CRM_Utils_Array::value('selectProduct', $premiumParams);
if ($selectProduct &&
$selectProduct != 'no_thanks'
) {
$startDate = $endDate = "";
$this->assign('selectPremium', TRUE);
$productDAO = new CRM_Contribute_DAO_Product();
$productDAO->id = $selectProduct;
$productDAO->find(TRUE);
$this->assign('product_name', $productDAO->name);
$this->assign('price', $productDAO->price);
$this->assign('sku', $productDAO->sku);
$this->assign('option', CRM_Utils_Array::value('options_' . $premiumParams['selectProduct'], $premiumParams));
$periodType = $productDAO->period_type;
if ($periodType) {
$fixed_period_start_day = $productDAO->fixed_period_start_day;
$duration_unit = $productDAO->duration_unit;
$duration_interval = $productDAO->duration_interval;
if ($periodType == 'rolling') {
$startDate = date('Y-m-d');
}
elseif ($periodType == 'fixed') {
if ($fixed_period_start_day) {
$date = explode('-', date('Y-m-d'));
$month = substr($fixed_period_start_day, 0, strlen($fixed_period_start_day) - 2);
$day = substr($fixed_period_start_day, -2) . "
";
$year = $date[0];
$startDate = $year . '-' . $month . '-' . $day;
}
else {
$startDate = date('Y-m-d');
}
}
$date = explode('-', $startDate);
$year = $date[0];
$month = $date[1];
$day = $date[2];
switch ($duration_unit) {
case 'year':
$year = $year + $duration_interval;
break;
case 'month':
$month = $month + $duration_interval;
break;
case 'day':
$day = $day + $duration_interval;
break;
case 'week':
$day = $day + ($duration_interval * 7);
}
$endDate = date('Y-m-d H:i:s', mktime($hour, $minute, $second, $month, $day, $year));
$this->assign('start_date', $startDate);
$this->assign('end_date', $endDate);
}
$dao = new CRM_Contribute_DAO_Premium();
$dao->entity_table = 'civicrm_contribution_page';
$dao->entity_id = $this->_id;
$dao->find(TRUE);
$this->assign('contact_phone', $dao->premiums_contact_phone);
$this->assign('contact_email', $dao->premiums_contact_email);
//create Premium record
$params = [
'product_id' => $premiumParams['selectProduct'],
'contribution_id' => $contribution->id,
'product_option' => CRM_Utils_Array::value('options_' . $premiumParams['selectProduct'], $premiumParams),
'quantity' => 1,
'start_date' => CRM_Utils_Date::customFormat($startDate, '%Y%m%d'),
'end_date' => CRM_Utils_Date::customFormat($endDate, '%Y%m%d'),
];
if (!empty($premiumParams['selectProduct'])) {
$daoPremiumsProduct = new CRM_Contribute_DAO_PremiumsProduct();
$daoPremiumsProduct->product_id = $premiumParams['selectProduct'];
$daoPremiumsProduct->premiums_id = $dao->id;
$daoPremiumsProduct->find(TRUE);
$params['financial_type_id'] = $daoPremiumsProduct->financial_type_id;
}
//Fixed For CRM-3901
$daoContrProd = new CRM_Contribute_DAO_ContributionProduct();
$daoContrProd->contribution_id = $contribution->id;
if ($daoContrProd->find(TRUE)) {
$params['id'] = $daoContrProd->id;
}
CRM_Contribute_BAO_Contribution::addPremium($params);
if ($productDAO->cost && !empty($params['financial_type_id'])) {
$trxnParams = [
'cost' => $productDAO->cost,
'currency' => $productDAO->currency,
'financial_type_id' => $params['financial_type_id'],
'contributionId' => $contribution->id,
];
CRM_Core_BAO_FinancialTrxn::createPremiumTrxn($trxnParams);
}
}
elseif ($selectProduct == 'no_thanks') {
//Fixed For CRM-3901
$daoContrProd = new CRM_Contribute_DAO_ContributionProduct();
$daoContrProd->contribution_id = $contribution->id;
if ($daoContrProd->find(TRUE)) {
$daoContrProd->delete();
}
}
}
/**
* Process the contribution.
*
* @param CRM_Core_Form $form
* @param array $params
* @param array $result
* @param array $contributionParams
* Parameters to be passed to contribution create action.
* This differs from params in that we are currently adding params to it and 1) ensuring they are being
* passed consistently & 2) documenting them here.
* - contact_id
* - line_item
* - is_test
* - campaign_id
* - contribution_page_id
* - source
* - payment_type_id
* - thankyou_date (not all forms will set this)
*
* @param CRM_Financial_DAO_FinancialType $financialType
* @param bool $online
* Is the form a front end form? If so set a bunch of unpredictable things that should be passed in from the form.
*
* @param int $billingLocationID
* ID of billing location type.
* @param bool $isRecur
* Is this recurring?
*
* @return \CRM_Contribute_DAO_Contribution
* @throws \Exception
*/
public static function processFormContribution(
&$form,
$params,
$result,
$contributionParams,
$financialType,
$online,
$billingLocationID,
$isRecur
) {
$transaction = new CRM_Core_Transaction();
$contactID = $contributionParams['contact_id'];
$isEmailReceipt = !empty($form->_values['is_email_receipt']);
$isSeparateMembershipPayment = empty($params['separate_membership_payment']) ? FALSE : TRUE;
$pledgeID = !empty($params['pledge_id']) ? $params['pledge_id'] : CRM_Utils_Array::value('pledge_id', $form->_values);
if (!$isSeparateMembershipPayment && !empty($form->_values['pledge_block_id']) &&
(!empty($params['is_pledge']) || $pledgeID)) {
$isPledge = TRUE;
}
else {
$isPledge = FALSE;
}
// add these values for the recurringContrib function ,CRM-10188
$params['financial_type_id'] = $financialType->id;
$contributionParams['address_id'] = CRM_Contribute_BAO_Contribution::createAddress($params, $billingLocationID);
//@todo - this is being set from the form to resolve CRM-10188 - an
// eNotice caused by it not being set @ the front end
// however, we then get it being over-written with null for backend contributions
// a better fix would be to set the values in the respective forms rather than require
// a function being shared by two forms to deal with their respective values
// moving it to the BAO & not taking the $form as a param would make sense here.
if (!isset($params['is_email_receipt']) && $isEmailReceipt) {
$params['is_email_receipt'] = $isEmailReceipt;
}
$params['is_recur'] = $isRecur;
$params['payment_instrument_id'] = CRM_Utils_Array::value('payment_instrument_id', $contributionParams);
$recurringContributionID = self::processRecurringContribution($form, $params, $contactID, $financialType);
$now = date('YmdHis');
$receiptDate = CRM_Utils_Array::value('receipt_date', $params);
if ($isEmailReceipt) {
$receiptDate = $now;
}
if (isset($params['amount'])) {
$contributionParams = array_merge(self::getContributionParams(
$params, $financialType->id,
$result, $receiptDate,
$recurringContributionID), $contributionParams
);
$contributionParams['non_deductible_amount'] = self::getNonDeductibleAmount($params, $financialType, $online, $form);
$contributionParams['skipCleanMoney'] = TRUE;
// @todo this is the wrong place for this - it should be done as close to form submission
// as possible
$contributionParams['total_amount'] = $params['amount'];
$contribution = CRM_Contribute_BAO_Contribution::add($contributionParams);
$invoiceSettings = Civi::settings()->get('contribution_invoice_settings');
$invoicing = CRM_Utils_Array::value('invoicing', $invoiceSettings);
if ($invoicing) {
$dataArray = [];
// @todo - interrogate the line items passed in on the params array.
// No reason to assume line items will be set on the form.
foreach ($form->_lineItem as $lineItemKey => $lineItemValue) {
foreach ($lineItemValue as $key => $value) {
if (isset($value['tax_amount']) && isset($value['tax_rate'])) {
if (isset($dataArray[$value['tax_rate']])) {
$dataArray[$value['tax_rate']] = $dataArray[$value['tax_rate']] + CRM_Utils_Array::value('tax_amount', $value);
}
else {
$dataArray[$value['tax_rate']] = CRM_Utils_Array::value('tax_amount', $value);
}
}
}
}
$smarty = CRM_Core_Smarty::singleton();
$smarty->assign('dataArray', $dataArray);
$smarty->assign('totalTaxAmount', $params['tax_amount']);
}
// lets store it in the form variable so postProcess hook can get to this and use it
$form->_contributionID = $contribution->id;
}
// process soft credit / pcp params first
CRM_Contribute_BAO_ContributionSoft::formatSoftCreditParams($params, $form);
//CRM-13981, processing honor contact into soft-credit contribution
CRM_Contribute_BAO_ContributionSoft::processSoftContribution($params, $contribution);
if ($isPledge) {
$form = self::handlePledge($form, $params, $contributionParams, $pledgeID, $contribution, $isEmailReceipt);
}
if ($online && $contribution) {
CRM_Core_BAO_CustomValueTable::postProcess($params,
'civicrm_contribution',
$contribution->id,
'Contribution'
);
}
elseif ($contribution) {
//handle custom data.
$params['contribution_id'] = $contribution->id;
if (!empty($params['custom']) &&
is_array($params['custom'])
) {
CRM_Core_BAO_CustomValueTable::store($params['custom'], 'civicrm_contribution', $contribution->id);
}
}
// Save note
if ($contribution && !empty($params['contribution_note'])) {
$noteParams = [
'entity_table' => 'civicrm_contribution',
'note' => $params['contribution_note'],
'entity_id' => $contribution->id,
'contact_id' => $contribution->contact_id,
'modified_date' => date('Ymd'),
];
CRM_Core_BAO_Note::add($noteParams, []);
}
if (isset($params['related_contact'])) {
$contactID = $params['related_contact'];
}
elseif (isset($params['cms_contactID'])) {
$contactID = $params['cms_contactID'];
}
//create contribution activity w/ individual and target
//activity w/ organisation contact id when onbelf, CRM-4027
$targetContactID = NULL;
if (!empty($params['hidden_onbehalf_profile'])) {
$targetContactID = $contribution->contact_id;
$contribution->contact_id = $contactID;
}
// create an activity record
if ($contribution) {
CRM_Activity_BAO_Activity::addActivity($contribution, NULL, $targetContactID);
}
$transaction->commit();
// CRM-13074 - create the CMSUser after the transaction is completed as it
// is not appropriate to delete a valid contribution if a user create problem occurs
CRM_Contribute_BAO_Contribution_Utils::createCMSUser($params,
$contactID,
'email-' . $billingLocationID
);
return $contribution;
}
/**
* Create the recurring contribution record.
*
* @param CRM_Core_Form $form
* @param array $params
* @param int $contactID
* @param string $contributionType
*
* @return int|null
*/
public static function processRecurringContribution(&$form, &$params, $contactID, $contributionType) {
if (empty($params['is_recur'])) {
return NULL;
}
$recurParams = ['contact_id' => $contactID];
$recurParams['amount'] = CRM_Utils_Array::value('amount', $params);
$recurParams['auto_renew'] = CRM_Utils_Array::value('auto_renew', $params);
$recurParams['frequency_unit'] = CRM_Utils_Array::value('frequency_unit', $params);
$recurParams['frequency_interval'] = CRM_Utils_Array::value('frequency_interval', $params);
$recurParams['installments'] = CRM_Utils_Array::value('installments', $params);
$recurParams['financial_type_id'] = CRM_Utils_Array::value('financial_type_id', $params);
$recurParams['currency'] = CRM_Utils_Array::value('currency', $params);
$recurParams['payment_instrument_id'] = $params['payment_instrument_id'];
// CRM-14354: For an auto-renewing membership with an additional contribution,
// if separate payments is not enabled, make sure only the membership fee recurs
if (!empty($form->_membershipBlock)
&& $form->_membershipBlock['is_separate_payment'] === '0'
&& isset($params['selectMembership'])
&& $form->_values['is_allow_other_amount'] == '1'
// CRM-16331
&& !empty($form->_membershipTypeValues)
&& !empty($form->_membershipTypeValues[$params['selectMembership']]['minimum_fee'])
) {
$recurParams['amount'] = $form->_membershipTypeValues[$params['selectMembership']]['minimum_fee'];
}
$recurParams['is_test'] = 0;
if (($form->_action & CRM_Core_Action::PREVIEW) ||
(isset($form->_mode) && ($form->_mode == 'test'))
) {
$recurParams['is_test'] = 1;
}
$recurParams['start_date'] = $recurParams['create_date'] = $recurParams['modified_date'] = date('YmdHis');
if (!empty($params['receive_date'])) {
$recurParams['start_date'] = date('YmdHis', strtotime($params['receive_date']));
}
$recurParams['invoice_id'] = CRM_Utils_Array::value('invoiceID', $params);
$recurParams['contribution_status_id'] = CRM_Core_PseudoConstant::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Pending');
$recurParams['payment_processor_id'] = CRM_Utils_Array::value('payment_processor_id', $params);
$recurParams['is_email_receipt'] = CRM_Utils_Array::value('is_email_receipt', $params);
// we need to add a unique trxn_id to avoid a unique key error
// in paypal IPN we reset this when paypal sends us the real trxn id, CRM-2991
$recurParams['trxn_id'] = CRM_Utils_Array::value('trxn_id', $params, $params['invoiceID']);
$recurParams['financial_type_id'] = $contributionType->id;
$campaignId = CRM_Utils_Array::value('campaign_id', $params, CRM_Utils_Array::value('campaign_id', $form->_values));
$recurParams['campaign_id'] = $campaignId;
$recurring = CRM_Contribute_BAO_ContributionRecur::add($recurParams);
if (is_a($recurring, 'CRM_Core_Error')) {
CRM_Core_Error::displaySessionError($recurring);
$urlString = 'civicrm/contribute/transact';
$urlParams = '_qf_Main_display=true';
if (get_class($form) == 'CRM_Contribute_Form_Contribution') {
$urlString = 'civicrm/contact/view/contribution';
$urlParams = "action=add&cid={$form->_contactID}";
if ($form->_mode) {
$urlParams .= "&mode={$form->_mode}";
}
}
CRM_Utils_System::redirect(CRM_Utils_System::url($urlString, $urlParams));
}
// Only set contribution recur ID for contributions since offline membership recur payments are handled somewhere else.
if (!is_a($form, "CRM_Member_Form_Membership")) {
$form->_params['contributionRecurID'] = $recurring->id;
}
return $recurring->id;
}
/**
* Add on behalf of organization and it's location.
*
* This situation occurs when on behalf of is enabled for the contribution page and the person
* signing up does so on behalf of an organization.
*
* @param array $behalfOrganization
* array of organization info.
* @param int $contactID
* individual contact id. One.
* who is doing the process of signup / contribution.
*
* @param array $values
* form values array.
* @param array $params
* @param array $fields
* Array of fields from the onbehalf profile relevant to the organization.
*/
public static function processOnBehalfOrganization(&$behalfOrganization, &$contactID, &$values, &$params, $fields = NULL) {
$isNotCurrentEmployer = FALSE;
$dupeIDs = [];
$orgID = NULL;
if (!empty($behalfOrganization['organization_id'])) {
$orgID = $behalfOrganization['organization_id'];
unset($behalfOrganization['organization_id']);
}
// create employer relationship with $contactID only when new organization is there
// else retain the existing relationship
else {
// get the Employee relationship type id
$relTypeId = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_RelationshipType', 'Employee of', 'id', 'name_a_b');
// keep relationship params ready
$relParams['relationship_type_id'] = $relTypeId . '_a_b';
$relParams['is_permission_a_b'] = 1;
$relParams['is_active'] = 1;
$isNotCurrentEmployer = TRUE;
}
// formalities for creating / editing organization.
$behalfOrganization['contact_type'] = 'Organization';
if (!$orgID) {
// check if matching organization contact exists
$dupeIDs = CRM_Contact_BAO_Contact::getDuplicateContacts($behalfOrganization, 'Organization', 'Unsupervised', [], FALSE);
// CRM-6243 says to pick the first org even if more than one match
if (count($dupeIDs) >= 1) {
$behalfOrganization['contact_id'] = $orgID = $dupeIDs[0];
// don't allow name edit
unset($behalfOrganization['organization_name']);
}
}
else {
// if found permissioned related organization, allow location edit
$behalfOrganization['contact_id'] = $orgID;
// don't allow name edit
unset($behalfOrganization['organization_name']);
}
// handling for image url
if (!empty($behalfOrganization['image_URL'])) {
CRM_Contact_BAO_Contact::processImageParams($behalfOrganization);
}
// create organization, add location
$orgID = CRM_Contact_BAO_Contact::createProfileContact($behalfOrganization, $fields, $orgID,
NULL, NULL, 'Organization'
);
// create relationship
if ($isNotCurrentEmployer) {
$relParams['contact_check'][$orgID] = 1;
$cid = ['contact' => $contactID];
CRM_Contact_BAO_Relationship::legacyCreateMultiple($relParams, $cid);
}
// if multiple match - send a duplicate alert
if ($dupeIDs && (count($dupeIDs) > 1)) {
$values['onbehalf_dupe_alert'] = 1;
// required for IPN
$params['onbehalf_dupe_alert'] = 1;
}
// make sure organization-contact-id is considered for recording
// contribution/membership etc..
if ($contactID != $orgID) {
// take a note of contact-id, so we can send the
// receipt to individual contact as well.
// required for mailing/template display ..etc
$values['related_contact'] = $contactID;
//CRM-19172: Create CMS user for individual on whose behalf organization is doing contribution
$params['onbehalf_contact_id'] = $contactID;
//make this employee of relationship as current
//employer / employee relationship, CRM-3532
if ($isNotCurrentEmployer &&
($orgID != CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $contactID, 'employer_id'))
) {
$isNotCurrentEmployer = FALSE;
}
if (!$isNotCurrentEmployer && $orgID) {
//build current employer params
$currentEmpParams[$contactID] = $orgID;
CRM_Contact_BAO_Contact_Utils::setCurrentEmployer($currentEmpParams);
}
// contribution / signup will be done using this
// organization id.
$contactID = $orgID;
}
}
/**
* Function used to send notification mail to pcp owner.
*
* This is used by contribution and also event PCPs.
*
* @param object $contribution
* @param object $contributionSoft
* Contribution object.
*/
public static function pcpNotifyOwner($contribution, $contributionSoft) {
$params = ['id' => $contributionSoft->pcp_id];
CRM_Core_DAO::commonRetrieve('CRM_PCP_DAO_PCP', $params, $pcpInfo);
$ownerNotifyID = CRM_Core_DAO::getFieldValue('CRM_PCP_DAO_PCPBlock', $pcpInfo['pcp_block_id'], 'owner_notify_id');
$ownerNotifyOption = CRM_Core_PseudoConstant::getName('CRM_PCP_DAO_PCPBlock', 'owner_notify_id', $ownerNotifyID);
if ($ownerNotifyOption != 'no_notifications' &&
(($ownerNotifyOption == 'owner_chooses' &&
CRM_Core_DAO::getFieldValue('CRM_PCP_DAO_PCP', $contributionSoft->pcp_id, 'is_notify')) ||
$ownerNotifyOption == 'all_owners')) {
$pcpInfoURL = CRM_Utils_System::url('civicrm/pcp/info',
"reset=1&id={$contributionSoft->pcp_id}",
TRUE, NULL, FALSE, TRUE
);
// set email in the template here
if (CRM_Core_BAO_LocationType::getBilling()) {
list($donorName, $email) = CRM_Contact_BAO_Contact_Location::getEmailDetails($contribution->contact_id,
FALSE, CRM_Core_BAO_LocationType::getBilling());
}
// get primary location email if no email exist( for billing location).
if (!$email) {
list($donorName, $email) = CRM_Contact_BAO_Contact_Location::getEmailDetails($contribution->contact_id);
}
list($ownerName, $ownerEmail) = CRM_Contact_BAO_Contact_Location::getEmailDetails($contributionSoft->contact_id);
$tplParams = [
'page_title' => $pcpInfo['title'],
'receive_date' => $contribution->receive_date,
'total_amount' => $contributionSoft->amount,
'donors_display_name' => $donorName,
'donors_email' => $email,
'pcpInfoURL' => $pcpInfoURL,
'is_honor_roll_enabled' => $contributionSoft->pcp_display_in_roll,
'currency' => $contributionSoft->currency,
];
$domainValues = CRM_Core_BAO_Domain::getNameAndEmail();
$sendTemplateParams = [
'groupName' => 'msg_tpl_workflow_contribution',
'valueName' => 'pcp_owner_notify',
'contactId' => $contributionSoft->contact_id,
'toEmail' => $ownerEmail,
'toName' => $ownerName,
'from' => "$domainValues[0] <$domainValues[1]>",
'tplParams' => $tplParams,
'PDFFilename' => 'receipt.pdf',
];
CRM_Core_BAO_MessageTemplate::sendTemplate($sendTemplateParams);
}
}
/**
* Function used to se pcp related defaults / params.
*
* This is used by contribution and also event PCPs
*
* @param CRM_Core_Form $page
* Form object.
* @param array $params
*
* @return array
*/
public static function processPcp(&$page, $params) {
$params['pcp_made_through_id'] = $page->_pcpId;
$page->assign('pcpBlock', TRUE);
if (!empty($params['pcp_display_in_roll']) && empty($params['pcp_roll_nickname'])) {
$params['pcp_roll_nickname'] = ts('Anonymous');
$params['pcp_is_anonymous'] = 1;
}
else {
$params['pcp_is_anonymous'] = 0;
}
foreach ([
'pcp_display_in_roll',
'pcp_is_anonymous',
'pcp_roll_nickname',
'pcp_personal_note',
] as $val) {
if (!empty($params[$val])) {
$page->assign($val, $params[$val]);
}
}
return $params;
}
/**
* Process membership.
*
* @param array $membershipParams
* @param int $contactID
* @param array $customFieldsFormatted
* @param array $fieldTypes
* @param array $premiumParams
* @param array $membershipLineItems
* Line items specifically relating to memberships.
*/
protected function processMembership($membershipParams, $contactID, $customFieldsFormatted, $fieldTypes, $premiumParams,
$membershipLineItems) {
$membershipTypeIDs = (array) $membershipParams['selectMembership'];
$membershipTypes = CRM_Member_BAO_Membership::buildMembershipTypeValues($this, $membershipTypeIDs);
$membershipType = empty($membershipTypes) ? [] : reset($membershipTypes);
$isPending = $this->getIsPending();
$this->assign('membership_name', CRM_Utils_Array::value('name', $membershipType));
$this->_values['membership_name'] = CRM_Utils_Array::value('name', $membershipType);
$isPaidMembership = FALSE;
if ($this->_amount >= 0.0 && isset($membershipParams['amount'])) {
//amount must be greater than zero for
//adding contribution record to contribution table.
//this condition arises when separate membership payment is
//enabled and contribution amount is not selected. fix for CRM-3010
$isPaidMembership = TRUE;
}
$isProcessSeparateMembershipTransaction = $this->isSeparateMembershipTransaction($this->_id, $this->_values['amount_block_is_active']);
if ($this->_values['amount_block_is_active']) {
$financialTypeID = $this->_values['financial_type_id'];
}
else {
$financialTypeID = CRM_Utils_Array::value('financial_type_id', $membershipType, CRM_Utils_Array::value('financial_type_id', $membershipParams));
}
if (CRM_Utils_Array::value('membership_source', $this->_params)) {
$membershipParams['contribution_source'] = $this->_params['membership_source'];
}
$this->postProcessMembership($membershipParams, $contactID,
$this, $premiumParams, $customFieldsFormatted, $fieldTypes, $membershipType, $membershipTypeIDs, $isPaidMembership, $this->_membershipId, $isProcessSeparateMembershipTransaction, $financialTypeID,
$membershipLineItems, $isPending);
$this->assign('membership_assign', TRUE);
$this->set('membershipTypeID', $membershipParams['selectMembership']);
}
/**
* Process the Memberships.
*
* @param array $membershipParams
* Array of membership fields.
* @param int $contactID
* Contact id.
* @param CRM_Contribute_Form_Contribution_Confirm $form
* Confirmation form object.
*
* @param array $premiumParams
* @param null $customFieldsFormatted
* @param null $includeFieldTypes
*
* @param array $membershipDetails
*
* @param array $membershipTypeIDs
*
* @param bool $isPaidMembership
* @param array $membershipID
*
* @param bool $isProcessSeparateMembershipTransaction
*
* @param int $financialTypeID
* @param array $unprocessedLineItems
* Line items for payment options chosen on the form.
* @param bool $isPending
*
* @throws \CRM_Core_Exception
*/
protected function postProcessMembership(
$membershipParams, $contactID, &$form, $premiumParams,
$customFieldsFormatted = NULL, $includeFieldTypes = NULL, $membershipDetails, $membershipTypeIDs, $isPaidMembership, $membershipID,
$isProcessSeparateMembershipTransaction, $financialTypeID, $unprocessedLineItems, $isPending) {
$membershipContribution = NULL;
$isTest = CRM_Utils_Array::value('is_test', $membershipParams, FALSE);
$errors = $paymentResults = [];
$form->_values['isMembership'] = TRUE;
$isRecurForFirstTransaction = CRM_Utils_Array::value('is_recur', $form->_params, CRM_Utils_Array::value('is_recur', $membershipParams));
$totalAmount = $membershipParams['amount'];
if ($isPaidMembership) {
if ($isProcessSeparateMembershipTransaction) {
// If we have 2 transactions only one can use the invoice id.
$membershipParams['invoiceID'] .= '-2';
if (!empty($membershipParams['auto_renew'])) {
$isRecurForFirstTransaction = FALSE;
}
}
if (!$isProcessSeparateMembershipTransaction) {
// Skip line items in the contribution processing transaction.
// We will create them with the membership for proper linking.
$membershipParams['skipLineItem'] = 1;
}
else {
$membershipParams['total_amount'] = $totalAmount;
$membershipParams['skipLineItem'] = 0;
CRM_Price_BAO_LineItem::getLineItemArray($membershipParams);
}
$paymentResult = CRM_Contribute_BAO_Contribution_Utils::processConfirm(
$form,
$membershipParams,
$contactID,
$financialTypeID,
$isTest,
$isRecurForFirstTransaction
);
if (!empty($paymentResult['contribution'])) {
$paymentResults[] = ['contribution_id' => $paymentResult['contribution']->id, 'result' => $paymentResult];
$this->postProcessPremium($premiumParams, $paymentResult['contribution']);
//note that this will be over-written if we are using a separate membership transaction. Otherwise there is only one
$membershipContribution = $paymentResult['contribution'];
// Save the contribution ID so that I can be used in email receipts
// For example, if you need to generate a tax receipt for the donation only.
$form->_values['contribution_other_id'] = $membershipContribution->id;
}
}
if ($isProcessSeparateMembershipTransaction) {
try {
$form->_lineItem = $unprocessedLineItems;
if (empty($form->_params['auto_renew']) && !empty($membershipParams['is_recur'])) {
unset($membershipParams['is_recur']);
}
list($membershipContribution, $secondPaymentResult) = $this->processSecondaryFinancialTransaction($contactID, $form, array_merge($membershipParams, ['skipLineItem' => 1]),
$isTest, $unprocessedLineItems, CRM_Utils_Array::value('minimum_fee', $membershipDetails, 0), CRM_Utils_Array::value('financial_type_id', $membershipDetails));
$paymentResults[] = ['contribution_id' => $membershipContribution->id, 'result' => $secondPaymentResult];
$totalAmount = $membershipContribution->total_amount;
}
catch (CRM_Core_Exception $e) {
$errors[2] = $e->getMessage();
$membershipContribution = NULL;
}
}
$membership = NULL;
if (!empty($membershipContribution) && !is_a($membershipContribution, 'CRM_Core_Error')) {
$membershipContributionID = $membershipContribution->id;
}
//@todo - why is this nested so deep? it seems like it could be just set on the calling function on the form layer
if (isset($membershipParams['onbehalf']) && !empty($membershipParams['onbehalf']['member_campaign_id'])) {
$form->_params['campaign_id'] = $membershipParams['onbehalf']['member_campaign_id'];
}
//@todo it should no longer be possible for it to get to this point & membership to not be an array
if (is_array($membershipTypeIDs) && !empty($membershipContributionID)) {
$typesTerms = CRM_Utils_Array::value('types_terms', $membershipParams, []);
$membershipLines = $nonMembershipLines = [];
foreach ($unprocessedLineItems as $priceSetID => $lines) {
foreach ($lines as $line) {
if (!empty($line['membership_type_id'])) {
$membershipLines[$line['membership_type_id']] = $line['price_field_value_id'];
}
}
}
$i = 1;
$form->_params['createdMembershipIDs'] = [];
foreach ($membershipTypeIDs as $memType) {
$membershipLineItems = [];
if ($i < count($membershipTypeIDs)) {
$membershipLineItems[$priceSetID][$membershipLines[$memType]] = $unprocessedLineItems[$priceSetID][$membershipLines[$memType]];
unset($unprocessedLineItems[$priceSetID][$membershipLines[$memType]]);
}
else {
$membershipLineItems = $unprocessedLineItems;
}
$i++;
$numTerms = CRM_Utils_Array::value($memType, $typesTerms, 1);
if (!empty($membershipContribution)) {
$pendingStatus = CRM_Core_PseudoConstant::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Pending');
$pending = ($membershipContribution->contribution_status_id == $pendingStatus) ? TRUE : FALSE;
}
else {
$pending = $isPending;
}
$contributionRecurID = isset($form->_params['contributionRecurID']) ? $form->_params['contributionRecurID'] : NULL;
$membershipSource = NULL;
if (!empty($form->_params['membership_source'])) {
$membershipSource = $form->_params['membership_source'];
}
elseif (isset($form->_values['title']) && !empty($form->_values['title'])) {
$membershipSource = ts('Online Contribution:') . ' ' . $form->_values['title'];
}
$isPayLater = NULL;
if (isset($form->_params)) {
$isPayLater = CRM_Utils_Array::value('is_pay_later', $form->_params);
}
$campaignId = NULL;
if (isset($form->_values) && is_array($form->_values) && !empty($form->_values)) {
$campaignId = CRM_Utils_Array::value('campaign_id', $form->_params);
if (!array_key_exists('campaign_id', $form->_params)) {
$campaignId = CRM_Utils_Array::value('campaign_id', $form->_values);
}
}
list($membership, $renewalMode, $dates) = CRM_Member_BAO_Membership::processMembership(
$contactID, $memType, $isTest,
date('YmdHis'), CRM_Utils_Array::value('cms_contactID', $membershipParams),
$customFieldsFormatted,
$numTerms, $membershipID, $pending,
$contributionRecurID, $membershipSource, $isPayLater, $campaignId, [], $membershipContribution,
$membershipLineItems
);
$form->set('renewal_mode', $renewalMode);
if (!empty($dates)) {
$form->assign('mem_start_date', CRM_Utils_Date::customFormat($dates['start_date'], '%Y%m%d'));
$form->assign('mem_end_date', CRM_Utils_Date::customFormat($dates['end_date'], '%Y%m%d'));
}
if (!empty($membershipContribution)) {
// update recurring id for membership record
CRM_Member_BAO_Membership::updateRecurMembership($membership, $membershipContribution);
// Next line is probably redundant. Checksprevent it happening twice.
CRM_Member_BAO_Membership::linkMembershipPayment($membership, $membershipContribution);
}
if ($membership) {
CRM_Core_BAO_CustomValueTable::postProcess($form->_params, 'civicrm_membership', $membership->id, 'Membership');
$form->_params['createdMembershipIDs'][] = $membership->id;
$form->_params['membershipID'] = $membership->id;
//CRM-15232: Check if membership is created and on the basis of it use
//membership receipt template to send payment receipt
$form->_values['isMembership'] = TRUE;
}
}
if ($form->_priceSetId && !empty($form->_useForMember) && !empty($form->_lineItem)) {
foreach ($form->_lineItem[$form->_priceSetId] as & $priceFieldOp) {
if (!empty($priceFieldOp['membership_type_id']) && $membership->membership_type_id == $priceFieldOp['membership_type_id']) {
$membershipOb = $membership;
$priceFieldOp['start_date'] = $membershipOb->start_date ? CRM_Utils_Date::customFormat($membershipOb->start_date, '%B %E%f, %Y') : '-';
$priceFieldOp['end_date'] = $membershipOb->end_date ? CRM_Utils_Date::customFormat($membershipOb->end_date, '%B %E%f, %Y') : '-';
}
else {
$priceFieldOp['start_date'] = $priceFieldOp['end_date'] = 'N/A';
}
}
$form->_values['lineItem'] = $form->_lineItem;
$form->assign('lineItem', $form->_lineItem);
}
}
if (!empty($errors)) {
$message = $this->compileErrorMessage($errors);
throw new CRM_Core_Exception($message);
}
if (isset($membershipContributionID)) {
$form->_values['contribution_id'] = $membershipContributionID;
}
if (empty($form->_params['is_pay_later']) && $form->_paymentProcessor) {
// the is_monetary concept probably should be deprecated as it can be calculated from
// the existence of 'amount' & seems fragile.
if ($form->_values['is_monetary'] && $form->_amount > 0.0 && !$form->_params['is_pay_later']) {
// call postProcess hook before leaving
$form->postProcessHook();
}
$payment = Civi\Payment\System::singleton()->getByProcessor($form->_paymentProcessor);
// The contribution_other_id is effectively the ID for the only contribution or the non-membership contribution.
// Since we have called the membership contribution (in a 2 contribution scenario) this is out
// primary-contribution compared to that - but let's face it - it's all just too hard & confusing at the moment!
$paymentParams = array_merge($form->_params, ['contributionID' => $form->_values['contribution_other_id']]);
// CRM-19792 : set necessary fields for payment processor
CRM_Core_Payment_Form::mapParams($form->_bltID, $paymentParams, $paymentParams, TRUE);
// If this is a single membership-related contribution, it won't have
// be performed yet, so do it now.
if ($isPaidMembership && !$isProcessSeparateMembershipTransaction) {
$paymentActionResult = $payment->doPayment($paymentParams, 'contribute');
$paymentResults[] = ['contribution_id' => $paymentResult['contribution']->id, 'result' => $paymentActionResult];
}
// Do not send an email if Recurring transaction is done via Direct Mode
// Email will we sent when the IPN is received.
foreach ($paymentResults as $result) {
//CRM-18211: Fix situation where second contribution doesn't exist because it is optional.
if ($result['contribution_id']) {
$this->completeTransaction($result['result'], $result['contribution_id']);
}
}
return;
}
$emailValues = array_merge($membershipParams, $form->_values);
$emailValues['membership_assign'] = 1;
$emailValues['useForMember'] = !empty($form->_useForMember);
// Finally send an email receipt for pay-later scenario (although it might sometimes be caught above!)
if ($totalAmount == 0) {
// This feels like a bizarre hack as the variable name doesn't seem to be directly connected to it's use in the template.
$emailValues['useForMember'] = 0;
$emailValues['amount'] = 0;
//CRM-18071, where on selecting $0 free membership payment section got hidden and
// also it reset any payment processor selection result into pending free membership
// so its a kind of hack to complete free membership at this point since there is no $form->_paymentProcessor info
if (!empty($membershipContribution) && !is_a($membershipContribution, 'CRM_Core_Error')) {
if (empty($form->_paymentProcessor)) {
// @todo this can maybe go now we are setting payment_processor_id = 0 more reliably.
$paymentProcessorIDs = explode(CRM_Core_DAO::VALUE_SEPARATOR, CRM_Utils_Array::value('payment_processor', $this->_values));
$this->_paymentProcessor['id'] = $paymentProcessorIDs[0];
}
$result = ['payment_status_id' => 1, 'contribution' => $membershipContribution];
$this->completeTransaction($result, $result['contribution']->id);
}
// return as completeTransaction() already sends the receipt mail.
return;
}
CRM_Contribute_BAO_ContributionPage::sendMail($contactID,
$emailValues,
$isTest, FALSE,
$includeFieldTypes
);
}
/**
* Turn array of errors into message string.
*
* @param array $errors
*
* @return string
*/
protected function compileErrorMessage($errors) {
foreach ($errors as $error) {
if (is_string($error)) {
$message[] = $error;
}
}
return ts('Payment Processor Error message') . ': ' . implode('
', $message);
}
/**
* Where a second separate financial transaction is supported we will process it here.
*
* @param int $contactID
* @param CRM_Contribute_Form_Contribution_Confirm $form
* @param array $tempParams
* @param bool $isTest
* @param array $lineItems
* @param $minimumFee
* @param int $financialTypeID
*
* @throws CRM_Core_Exception
* @throws Exception
* @return CRM_Contribute_BAO_Contribution
*/
protected function processSecondaryFinancialTransaction($contactID, &$form, $tempParams, $isTest, $lineItems, $minimumFee,
$financialTypeID) {
$financialType = new CRM_Financial_DAO_FinancialType();
$financialType->id = $financialTypeID;
$financialType->find(TRUE);
$tempParams['amount'] = $minimumFee;
$tempParams['invoiceID'] = md5(uniqid(rand(), TRUE));
$isRecur = CRM_Utils_Array::value('is_recur', $tempParams);
//assign receive date when separate membership payment
//and contribution amount not selected.
if ($form->_amount == 0) {
$now = date('YmdHis');
$form->_params['receive_date'] = $now;
$receiveDate = CRM_Utils_Date::mysqlToIso($now);
$form->set('params', $form->_params);
$form->assign('receive_date', $receiveDate);
}
$form->set('membership_amount', $minimumFee);
$form->assign('membership_amount', $minimumFee);
// we don't need to create the user twice, so lets disable cms_create_account
// irrespective of the value, CRM-2888
$tempParams['cms_create_account'] = 0;
//set this variable as we are not creating pledge for
//separate membership payment contribution.
//so for differentiating membership contribution from
//main contribution.
$form->_params['separate_membership_payment'] = 1;
$contributionParams = [
'contact_id' => $contactID,
'line_item' => $lineItems,
'is_test' => $isTest,
'campaign_id' => CRM_Utils_Array::value('campaign_id', $tempParams, CRM_Utils_Array::value('campaign_id',
$form->_values)),
'contribution_page_id' => $form->_id,
'source' => CRM_Utils_Array::value('source', $tempParams, CRM_Utils_Array::value('description', $tempParams)),
];
$isMonetary = !empty($form->_values['is_monetary']);
if ($isMonetary) {
if (empty($paymentParams['is_pay_later'])) {
$contributionParams['payment_instrument_id'] = $form->_paymentProcessor['payment_instrument_id'];
}
}
// CRM-19792 : set necessary fields for payment processor
CRM_Core_Payment_Form::mapParams($form->_bltID, $form->_params, $tempParams, TRUE);
$membershipContribution = CRM_Contribute_Form_Contribution_Confirm::processFormContribution($form,
$tempParams,
$tempParams,
$contributionParams,
$financialType,
TRUE,
$form->_bltID,
$isRecur
);
$result = [];
// We're not processing the line item here because we are processing a membership.
// To ensure processing of the correct parameters, replace relevant parameters
// in $tempParams with those in $membershipContribution.
$tempParams['amount_level'] = $membershipContribution->amount_level;
$tempParams['total_amount'] = $membershipContribution->total_amount;
$tempParams['tax_amount'] = $membershipContribution->tax_amount;
$tempParams['contactID'] = $membershipContribution->contact_id;
$tempParams['financialTypeID'] = $membershipContribution->financial_type_id;
$tempParams['invoiceID'] = $membershipContribution->invoice_id;
$tempParams['trxn_id'] = $membershipContribution->trxn_id;
$tempParams['contributionID'] = $membershipContribution->id;
if ($form->_values['is_monetary'] && !$form->_params['is_pay_later'] && $minimumFee > 0.0) {
// At the moment our tests are calling this form in a way that leaves 'object' empty. For
// now we compensate here.
if (empty($form->_paymentProcessor['object'])) {
$payment = Civi\Payment\System::singleton()->getByProcessor($this->_paymentProcessor);
}
else {
$payment = $form->_paymentProcessor['object'];
}
$result = $payment->doPayment($tempParams, 'contribute');
$form->set('membership_trx_id', $result['trxn_id']);
$form->assign('membership_trx_id', $result['trxn_id']);
}
return [$membershipContribution, $result];
}
/**
* Is the payment a pending payment.
*
* We are moving towards always creating as pending and updating at the end (based on payment), so this should be
* an interim refactoring. It was shared with another unrelated form & some parameters may not apply to this form.
*
* @return bool
*/
protected function getIsPending() {
// The concept of contributeMode is deprecated.
// the is_monetary concept probably should be too as it can be calculated from
// the existence of 'amount' & seems fragile.
if (((isset($this->_contributeMode)) || !empty($this->_params['is_pay_later'])
) &&
(($this->_values['is_monetary'] && $this->_amount > 0.0))
) {
return TRUE;
}
return FALSE;
}
/**
* Are we going to do 2 financial transactions.
*
* Ie the membership block supports a separate transactions AND the contribution form has been configured for a
* contribution
* transaction AND a membership transaction AND the payment processor supports double financial transactions (ie. NOT doTransferCheckout style)
*
* @param int $formID
* @param bool $amountBlockActiveOnForm
*
* @return bool
*/
public function isSeparateMembershipTransaction($formID, $amountBlockActiveOnForm) {
$memBlockDetails = CRM_Member_BAO_Membership::getMembershipBlock($formID);
if (!empty($memBlockDetails['is_separate_payment']) && $amountBlockActiveOnForm) {
return TRUE;
}
return FALSE;
}
/**
* This function sets the fields.
*
* - $this->_params['amount_level']
* - $this->_params['selectMembership']
* And under certain circumstances sets
* $this->_params['amount'] = null;
*
* @param int $priceSetID
*/
public function setFormAmountFields($priceSetID) {
$isQuickConfig = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceSet', $this->_params['priceSetId'], 'is_quick_config');
$priceField = new CRM_Price_DAO_PriceField();
$priceField->price_set_id = $priceSetID;
$priceField->orderBy('weight');
$priceField->find();
$paramWeDoNotUnderstand = NULL;
while ($priceField->fetch()) {
if ($priceField->name == "contribution_amount") {
$paramWeDoNotUnderstand = $priceField->id;
}
if ($isQuickConfig && !empty($this->_params["price_{$priceField->id}"])) {
if ($this->_values['fee'][$priceField->id]['html_type'] != 'Text') {
// @todo - stop setting amount level in this function & call the CRM_Price_BAO_PriceSet::getAmountLevel
// function to get correct amount level consistently. Remove setting of the amount level in
// CRM_Price_BAO_PriceSet::processAmount. Extend the unit tests in CRM_Price_BAO_PriceSetTest
// to cover all variants.
$this->_params['amount_level'] = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceFieldValue',
$this->_params["price_{$priceField->id}"], 'label');
}
if ($priceField->name == "membership_amount") {
$this->_params['selectMembership'] = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceFieldValue',
$this->_params["price_{$priceField->id}"], 'membership_type_id');
}
}
// If separate payment we set contribution amount to be null, so that it will not show contribution amount same
// as membership amount.
// @todo - this needs more documentation - it appears the setting to null is tied up with separate membership payments
// but the circumstances are very confusing. Many of these conditions are repeated in the next conditional
// so we should merge them together
// the quick config seems like a red-herring - if this is about a separate membership payment then there
// are 2 types of line items - membership ones & non-membership ones - regardless of whether quick config is set
elseif (
CRM_Utils_Array::value('is_separate_payment', $this->_membershipBlock)
&& !empty($this->_values['fee'][$priceField->id])
&& ($this->_values['fee'][$priceField->id]['name'] == "other_amount")
&& CRM_Utils_Array::value("price_{$paramWeDoNotUnderstand}", $this->_params) < 1
&& empty($this->_params["price_{$priceField->id}"])
) {
$this->_params['amount'] = NULL;
}
// Fix for CRM-14375 - If we are using separate payments and "no
// thank you" is selected for the additional contribution, set
// contribution amount to be null, so that it will not show
// contribution amount same as membership amount.
//@todo - merge with section above
if ($this->_membershipBlock['is_separate_payment']
&& !empty($this->_values['fee'][$priceField->id])
&& CRM_Utils_Array::value('name', $this->_values['fee'][$priceField->id]) == 'contribution_amount'
&& CRM_Utils_Array::value("price_{$priceField->id}", $this->_params) == '-1'
) {
$this->_params['amount'] = NULL;
}
}
}
/**
* Submit function.
*
* @param array $params
*
* @throws CiviCRM_API3_Exception
*/
public static function submit($params) {
$form = new CRM_Contribute_Form_Contribution_Confirm();
$form->_id = $params['id'];
CRM_Contribute_BAO_ContributionPage::setValues($form->_id, $form->_values);
$form->_separateMembershipPayment = CRM_Contribute_BAO_ContributionPage::getIsMembershipPayment($form->_id);
//this way the mocked up controller ignores the session stuff
$_SERVER['REQUEST_METHOD'] = 'GET';
$form->controller = new CRM_Contribute_Controller_Contribution();
$params['invoiceID'] = md5(uniqid(rand(), TRUE));
$paramsProcessedForForm = $form->_params = self::getFormParams($params['id'], $params);
$form->_amount = $params['amount'];
// hack these in for test support.
$form->_fields['billing_first_name'] = 1;
$form->_fields['billing_last_name'] = 1;
// CRM-18854 - Set form values to allow pledge to be created for api test.
if (CRM_Utils_Array::value('pledge_block_id', $params)) {
$form->_values['pledge_id'] = CRM_Utils_Array::value('pledge_id', $params, NULL);
$form->_values['pledge_block_id'] = $params['pledge_block_id'];
$pledgeBlock = CRM_Pledge_BAO_PledgeBlock::getPledgeBlock($params['id']);
$form->_values['max_reminders'] = $pledgeBlock['max_reminders'];
$form->_values['initial_reminder_day'] = $pledgeBlock['initial_reminder_day'];
$form->_values['additional_reminder_day'] = $pledgeBlock['additional_reminder_day'];
$form->_values['is_email_receipt'] = FALSE;
}
$priceSetID = $form->_params['priceSetId'] = $paramsProcessedForForm['price_set_id'];
$priceFields = CRM_Price_BAO_PriceSet::getSetDetail($priceSetID);
$priceSetFields = reset($priceFields);
$form->_values['fee'] = $priceSetFields['fields'];
$form->_priceSetId = $priceSetID;
$form->setFormAmountFields($priceSetID);
$capabilities = [];
if ($form->_mode) {
$capabilities[] = (ucfirst($form->_mode) . 'Mode');
}
$form->_paymentProcessors = CRM_Financial_BAO_PaymentProcessor::getPaymentProcessors($capabilities);
$form->_params['payment_processor_id'] = isset($params['payment_processor_id']) ? $params['payment_processor_id'] : 0;
if ($form->_params['payment_processor_id'] !== '') {
// It can be blank with a $0 transaction - then no processor needs to be selected
$form->_paymentProcessor = $form->_paymentProcessors[$form->_params['payment_processor_id']];
}
if (!empty($params['payment_processor_id'])) {
// The concept of contributeMode is deprecated as is the billing_mode concept.
if ($form->_paymentProcessor['billing_mode'] == 1) {
$form->_contributeMode = 'direct';
}
else {
$form->_contributeMode = 'notify';
}
}
$priceFields = $priceFields[$priceSetID]['fields'];
$lineItems = [];
CRM_Price_BAO_PriceSet::processAmount($priceFields, $paramsProcessedForForm, $lineItems, 'civicrm_contribution', $priceSetID);
$form->_lineItem = [$priceSetID => $lineItems];
$membershipPriceFieldIDs = [];
foreach ((array) $lineItems as $lineItem) {
if (!empty($lineItem['membership_type_id'])) {
$form->set('useForMember', 1);
$form->_useForMember = 1;
$membershipPriceFieldIDs['id'] = $priceSetID;
$membershipPriceFieldIDs[] = $lineItem['price_field_value_id'];
}
}
$form->set('memberPriceFieldIDS', $membershipPriceFieldIDs);
$form->setRecurringMembershipParams();
$form->processFormSubmission(CRM_Utils_Array::value('contact_id', $params));
}
/**
* Helper function for static submit function.
*
* Set relevant params - help us to build up an array that we can pass in.
*
* @param int $id
* @param array $params
*
* @return array
* @throws CiviCRM_API3_Exception
*/
public static function getFormParams($id, array $params) {
if (!isset($params['is_pay_later'])) {
if (!empty($params['payment_processor_id'])) {
$params['is_pay_later'] = 0;
}
elseif ($params['amount'] !== 0) {
$params['is_pay_later'] = civicrm_api3('contribution_page', 'getvalue', [
'id' => $id,
'return' => 'is_pay_later',
]);
}
}
if (empty($params['price_set_id'])) {
$params['price_set_id'] = CRM_Price_BAO_PriceSet::getFor('civicrm_contribution_page', $params['id']);
}
return $params;
}
/**
* Post form submission handling.
*
* This is also called from the test suite.
*
* @param int $contactID
*
* @return array
*/
protected function processFormSubmission($contactID) {
if (!isset($this->_params['payment_processor_id'])) {
// If there is no processor we are using the pay-later manual pseudo-processor.
// (note it might make sense to make this a row in the processor table in the db).
$this->_params['payment_processor_id'] = 0;
}
if (isset($this->_params['payment_processor_id']) && $this->_params['payment_processor_id'] === 0) {
$this->_params['is_pay_later'] = $isPayLater = TRUE;
}
if (!empty($this->_ccid)) {
$this->_params['contribution_id'] = $this->_ccid;
}
//Set email-bltID if pre/post profile contains an email.
if ($this->_emailExists == TRUE) {
foreach ($this->_params as $key => $val) {
if (substr($key, 0, 6) == 'email-' && empty($this->_params["email-{$this->_bltID}"])) {
$this->_params["email-{$this->_bltID}"] = $this->_params[$key];
}
}
}
// add a description field at the very beginning
$this->_params['description'] = ts('Online Contribution') . ': ' . (($this->_pcpInfo['title']) ? $this->_pcpInfo['title'] : $this->_values['title']);
$this->_params['accountingCode'] = CRM_Utils_Array::value('accountingCode', $this->_values);
// fix currency ID
$this->_params['currencyID'] = CRM_Core_Config::singleton()->defaultCurrency;
CRM_Contribute_Form_AbstractEditPayment::formatCreditCardDetails($this->_params);
// CRM-18854
if (CRM_Utils_Array::value('is_pledge', $this->_params) && !CRM_Utils_Array::value('pledge_id', $this->_values) && CRM_Utils_Array::value('adjust_recur_start_date', $this->_values)) {
$pledgeBlock = CRM_Pledge_BAO_PledgeBlock::getPledgeBlock($this->_id);
if (CRM_Utils_Array::value('start_date', $this->_params) || !CRM_Utils_Array::value('is_pledge_start_date_visible', $pledgeBlock)
|| !CRM_Utils_Array::value('is_pledge_start_date_editable', $pledgeBlock)) {
$pledgeStartDate = CRM_Utils_Array::value('start_date', $this->_params, NULL);
$this->_params['receive_date'] = CRM_Pledge_BAO_Pledge::getPledgeStartDate($pledgeStartDate, $pledgeBlock);
$recurParams = CRM_Pledge_BAO_Pledge::buildRecurParams($this->_params);
$this->_params = array_merge($this->_params, $recurParams);
}
}
//carry payment processor id.
if (CRM_Utils_Array::value('id', $this->_paymentProcessor)) {
$this->_params['payment_processor_id'] = $this->_paymentProcessor['id'];
}
$premiumParams = $membershipParams = $params = $this->_params;
if (!empty($params['image_URL'])) {
CRM_Contact_BAO_Contact::processImageParams($params);
}
$fields = ['email-Primary' => 1];
// get the add to groups
$addToGroups = [];
// now set the values for the billing location.
foreach ($this->_fields as $name => $value) {
$fields[$name] = 1;
// get the add to groups for uf fields
if (!empty($value['add_to_group_id'])) {
$addToGroups[$value['add_to_group_id']] = $value['add_to_group_id'];
}
}
$fields = $this->formatParamsForPaymentProcessor($fields);
// billing email address
$fields["email-{$this->_bltID}"] = 1;
// if onbehalf-of-organization contribution, take out
// organization params in a separate variable, to make sure
// normal behavior is continued. And use that variable to
// process on-behalf-of functionality.
if (!empty($this->_values['onbehalf_profile_id']) && empty($this->_ccid)) {
$behalfOrganization = [];
$orgFields = ['organization_name', 'organization_id', 'org_option'];
foreach ($orgFields as $fld) {
if (array_key_exists($fld, $params)) {
$behalfOrganization[$fld] = $params[$fld];
unset($params[$fld]);
}
}
if (is_array($params['onbehalf']) && !empty($params['onbehalf'])) {
foreach ($params['onbehalf'] as $fld => $values) {
if (strstr($fld, 'custom_')) {
$behalfOrganization[$fld] = $values;
}
elseif (!(strstr($fld, '-'))) {
if (in_array($fld, [
'contribution_campaign_id',
'member_campaign_id',
])) {
$fld = 'campaign_id';
}
else {
$behalfOrganization[$fld] = $values;
}
$this->_params[$fld] = $values;
}
}
}
if (array_key_exists('onbehalf_location', $params) && is_array($params['onbehalf_location'])) {
foreach ($params['onbehalf_location'] as $block => $vals) {
//fix for custom data (of type checkbox, multi-select)
if (substr($block, 0, 7) == 'custom_') {
continue;
}
// fix the index of block elements
if (is_array($vals)) {
foreach ($vals as $key => $val) {
//dont adjust the index of address block as
//it's index is WRT to location type
$newKey = ($block == 'address') ? $key : ++$key;
$behalfOrganization[$block][$newKey] = $val;
}
}
}
unset($params['onbehalf_location']);
}
if (!empty($params['onbehalf[image_URL]'])) {
$behalfOrganization['image_URL'] = $params['onbehalf[image_URL]'];
}
}
// check for profile double opt-in and get groups to be subscribed
$subscribeGroupIds = CRM_Core_BAO_UFGroup::getDoubleOptInGroupIds($params, $contactID);
// since we are directly adding contact to group lets unset it from mailing
if (!empty($addToGroups)) {
foreach ($addToGroups as $groupId) {
if (isset($subscribeGroupIds[$groupId])) {
unset($subscribeGroupIds[$groupId]);
}
}
}
foreach ($addToGroups as $k) {
if (array_key_exists($k, $subscribeGroupIds)) {
unset($addToGroups[$k]);
}
}
if (empty($contactID)) {
$dupeParams = $params;
if (!empty($dupeParams['onbehalf'])) {
unset($dupeParams['onbehalf']);
}
if (!empty($dupeParams['honor'])) {
unset($dupeParams['honor']);
}
$contactID = CRM_Contact_BAO_Contact::getFirstDuplicateContact($dupeParams, 'Individual', 'Unsupervised', [], FALSE);
// Fetch default greeting id's if creating a contact
if (!$contactID) {
foreach (CRM_Contact_BAO_Contact::$_greetingTypes as $greeting) {
if (!isset($params[$greeting])) {
$params[$greeting] = CRM_Contact_BAO_Contact_Utils::defaultGreeting('Individual', $greeting);
}
}
}
$contactType = NULL;
}
else {
$contactType = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $contactID, 'contact_type');
}
$contactID = CRM_Contact_BAO_Contact::createProfileContact(
$params,
$fields,
$contactID,
$addToGroups,
NULL,
$contactType,
TRUE
);
// Make the contact ID associated with the contribution available at the Class level.
// Also make available to the session.
//@todo consider handling this in $this->getContactID();
$this->set('contactID', $contactID);
$this->_contactID = $contactID;
//get email primary first if exist
$subscriptionEmail = ['email' => CRM_Utils_Array::value('email-Primary', $params)];
if (!$subscriptionEmail['email']) {
$subscriptionEmail['email'] = CRM_Utils_Array::value("email-{$this->_bltID}", $params);
}
// subscribing contact to groups
if (!empty($subscribeGroupIds) && $subscriptionEmail['email']) {
CRM_Mailing_Event_BAO_Subscribe::commonSubscribe($subscribeGroupIds, $subscriptionEmail, $contactID);
}
// If onbehalf-of-organization contribution / signup, add organization
// and it's location.
if (isset($this->_values['onbehalf_profile_id']) &&
isset($behalfOrganization['organization_name']) &&
($this->_values['is_for_organization'] == 2 ||
!empty($this->_params['is_for_organization'])
)
) {
$ufFields = [];
foreach ($this->_fields['onbehalf'] as $name => $value) {
$ufFields[$name] = 1;
}
self::processOnBehalfOrganization($behalfOrganization, $contactID, $this->_values,
$this->_params, $ufFields
);
}
elseif (!empty($this->_membershipContactID) && $contactID != $this->_membershipContactID) {
// this is an onbehalf renew case for inherited membership. For e.g a permissioned member of household,
// store current user id as related contact for later use for mailing / activity..
$this->_values['related_contact'] = $contactID;
$this->_params['related_contact'] = $contactID;
// swap contact like we do for on-behalf-org case, so parent/primary membership is affected
$contactID = $this->_membershipContactID;
}
// lets store the contactID in the session
// for things like tell a friend
$session = CRM_Core_Session::singleton();
if (!$session->get('userID')) {
$session->set('transaction.userID', $contactID);
}
else {
$session->set('transaction.userID', NULL);
}
$this->_useForMember = $this->get('useForMember');
// store the fact that this is a membership and membership type is selected
if ((!empty($membershipParams['selectMembership']) &&
$membershipParams['selectMembership'] != 'no_thanks'
) ||
$this->_useForMember
) {
if (!$this->_useForMember) {
$this->assign('membership_assign', TRUE);
$this->set('membershipTypeID', $this->_params['selectMembership']);
}
if ($this->_action & CRM_Core_Action::PREVIEW) {
$membershipParams['is_test'] = 1;
}
if ($this->_params['is_pay_later']) {
$membershipParams['is_pay_later'] = 1;
}
if (isset($this->_params['onbehalf_contact_id'])) {
$membershipParams['onbehalf_contact_id'] = $this->_params['onbehalf_contact_id'];
}
//inherit campaign from contribution page.
if (!array_key_exists('campaign_id', $membershipParams)) {
$membershipParams['campaign_id'] = CRM_Utils_Array::value('campaign_id', $this->_values);
}
$this->_params = CRM_Core_Payment_Form::mapParams($this->_bltID, $this->_params, $membershipParams, TRUE);
$this->doMembershipProcessing($contactID, $membershipParams, $premiumParams, $this->_lineItem);
}
else {
// at this point we've created a contact and stored its address etc
// all the payment processors expect the name and address to be in the
// so we copy stuff over to first_name etc.
$paymentParams = $this->_params;
// Make it explict that we are letting the processConfirm function figure out the line items.
$paymentParams['skipLineItem'] = 0;
if (!isset($paymentParams['line_item'])) {
$paymentParams['line_item'] = $this->_lineItem;
}
if (!empty($paymentParams['onbehalf']) &&
is_array($paymentParams['onbehalf'])
) {
foreach ($paymentParams['onbehalf'] as $key => $value) {
if (strstr($key, 'custom_')) {
$this->_params[$key] = $value;
}
}
}
$result = CRM_Contribute_BAO_Contribution_Utils::processConfirm($this, $paymentParams,
$contactID,
$this->wrangleFinancialTypeID($this->_values['financial_type_id']),
($this->_mode == 'test') ? 1 : 0,
CRM_Utils_Array::value('is_recur', $paymentParams)
);
if (empty($result['is_payment_failure'])) {
// @todo move premium processing to complete transaction if it truly is an 'after' action.
$this->postProcessPremium($premiumParams, $result['contribution']);
}
if (!empty($result['contribution'])) {
// It seems this line is hit when there is a zero dollar transaction & in tests, not sure when else.
$this->completeTransaction($result, $result['contribution']->id);
}
return $result;
}
}
/**
* Membership processing section.
*
* This is in a separate function as part of a move towards refactoring.
*
* @param int $contactID
* @param array $membershipParams
* @param array $premiumParams
* @param array $formLineItems
*/
protected function doMembershipProcessing($contactID, $membershipParams, $premiumParams, $formLineItems) {
// This could be set by a hook.
if (!empty($this->_params['installments'])) {
$membershipParams['installments'] = $this->_params['installments'];
}
// added new parameter for cms user contact id, needed to distinguish behaviour for on behalf of sign-ups
if (isset($this->_params['related_contact'])) {
$membershipParams['cms_contactID'] = $this->_params['related_contact'];
}
else {
$membershipParams['cms_contactID'] = $contactID;
}
if (!empty($membershipParams['onbehalf']) &&
is_array($membershipParams['onbehalf']) && !empty($membershipParams['onbehalf']['member_campaign_id'])
) {
$this->_params['campaign_id'] = $membershipParams['onbehalf']['member_campaign_id'];
}
$customFieldsFormatted = $fieldTypes = [];
if (!empty($membershipParams['onbehalf']) &&
is_array($membershipParams['onbehalf'])
) {
foreach ($membershipParams['onbehalf'] as $key => $value) {
if (strstr($key, 'custom_')) {
$customFieldId = explode('_', $key);
CRM_Core_BAO_CustomField::formatCustomField(
$customFieldId[1],
$customFieldsFormatted,
$value,
'Membership',
NULL,
$contactID
);
}
}
$fieldTypes = ['Contact', 'Organization', 'Membership'];
}
$priceFieldIds = $this->get('memberPriceFieldIDS');
if (!empty($priceFieldIds)) {
$membershipParams['financial_type_id'] = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceSet', $priceFieldIds['id'], 'financial_type_id');
unset($priceFieldIds['id']);
$membershipTypeIds = [];
$membershipTypeTerms = [];
foreach ($priceFieldIds as $priceFieldId) {
$membershipTypeId = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceFieldValue', $priceFieldId, 'membership_type_id');
if ($membershipTypeId) {
$membershipTypeIds[] = $membershipTypeId;
$term = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceFieldValue', $priceFieldId, 'membership_num_terms') ?: 1;
$membershipTypeTerms[$membershipTypeId] = ($term > 1) ? $term : 1;
}
}
$membershipParams['selectMembership'] = $membershipTypeIds;
$membershipParams['types_terms'] = $membershipTypeTerms;
}
if (!empty($membershipParams['selectMembership'])) {
// CRM-12233
$membershipLineItems = $formLineItems;
if ($this->_separateMembershipPayment && $this->_values['amount_block_is_active']) {
$membershipLineItems = [];
foreach ($this->_values['fee'] as $key => $feeValues) {
if ($feeValues['name'] == 'membership_amount') {
$fieldId = $this->_params['price_' . $key];
$membershipLineItems[$this->_priceSetId][$fieldId] = $this->_lineItem[$this->_priceSetId][$fieldId];
unset($this->_lineItem[$this->_priceSetId][$fieldId]);
break;
}
}
}
try {
$this->processMembership($membershipParams, $contactID, $customFieldsFormatted, $fieldTypes, $premiumParams, $membershipLineItems);
}
catch (\Civi\Payment\Exception\PaymentProcessorException $e) {
CRM_Core_Session::singleton()->setStatus($e->getMessage());
if (!empty($this->_contributionID)) {
CRM_Contribute_BAO_Contribution::failPayment($this->_contributionID,
$contactID, $e->getMessage());
}
CRM_Utils_System::redirect(CRM_Utils_System::url('civicrm/contribute/transact', "_qf_Main_display=true&qfKey={$this->_params['qfKey']}"));
}
catch (CRM_Core_Exception $e) {
CRM_Core_Session::singleton()->setStatus($e->getMessage());
CRM_Utils_System::redirect(CRM_Utils_System::url('civicrm/contribute/transact', "_qf_Main_display=true&qfKey={$this->_params['qfKey']}"));
}
if (!$this->_amount > 0.0 || !$membershipParams['amount']) {
// we need to explicitly create a CMS user in case of free memberships
// since it is done under processConfirm for paid memberships
CRM_Contribute_BAO_Contribution_Utils::createCMSUser($membershipParams,
$membershipParams['cms_contactID'],
'email-' . $this->_bltID
);
}
}
}
/**
* Complete transaction if payment has been processed.
*
* Check the result for a success outcome & if paid then complete the transaction.
*
* Completing will trigger update of related entities and emails.
*
* @param array $result
* @param int $contributionID
*
* @throws \CiviCRM_API3_Exception
* @throws \Exception
*/
protected function completeTransaction($result, $contributionID) {
if (CRM_Utils_Array::value('payment_status_id', $result) == 1) {
try {
civicrm_api3('contribution', 'completetransaction', [
'id' => $contributionID,
'trxn_id' => CRM_Utils_Array::value('trxn_id', $result),
'payment_processor_id' => CRM_Utils_Array::value('payment_processor_id', $result, $this->_paymentProcessor['id']),
'is_transactional' => FALSE,
'fee_amount' => CRM_Utils_Array::value('fee_amount', $result),
'receive_date' => CRM_Utils_Array::value('receive_date', $result),
'card_type_id' => CRM_Utils_Array::value('card_type_id', $result),
'pan_truncation' => CRM_Utils_Array::value('pan_truncation', $result),
]);
}
catch (CiviCRM_API3_Exception $e) {
if ($e->getErrorCode() != 'contribution_completed') {
throw new CRM_Core_Exception('Failed to update contribution in database');
}
}
}
}
/**
* Bounce the user back to retry when an error occurs.
*
* @param string $message
*/
protected function bounceOnError($message) {
CRM_Core_Session::singleton()
->setStatus(ts("Payment Processor Error message :") .
$message);
CRM_Utils_System::redirect(CRM_Utils_System::url('civicrm/contribute/transact',
"_qf_Main_display=true&qfKey={$this->_params['qfKey']}"
));
}
}