3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2017 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2017
35 * This class generates form components for processing a Contribution.
37 class CRM_Contribute_Form_Contribution_Main
extends CRM_Contribute_Form_ContributionBase
{
40 * Define default MembershipType Id.
42 public $_defaultMemTypeId;
44 public $_paymentProcessors;
46 public $_membershipTypeValues;
48 public $_useForMember;
51 * Array of payment related fields to potentially display on this form (generally credit card or debit card fields). This is rendered via billingBlock.tpl
54 public $_paymentFields = array();
56 protected $_paymentProcessorID;
60 * Set variables up before form is built.
62 public function preProcess() {
65 $this->_paymentProcessors
= $this->get('paymentProcessors');
66 $this->preProcessPaymentOptions();
68 if (!empty($this->_ccid
)) {
69 $payment = CRM_Contribute_BAO_Contribution
::getPaymentInfo($this->_ccid
, 'contribution');
70 //bounce if the contribution is not pending.
71 if (empty($payment['balance'])) {
72 CRM_Core_Error
::statusBounce(ts("Returning since contribution has already been handled."));
74 if (!empty($payment['total'])) {
75 $this->_pendingAmount
= $payment['total'];
76 $this->assign('pendingAmount', $this->_pendingAmount
);
78 $lineItems = CRM_Price_BAO_LineItem
::getLineItemsByContributionID($this->_ccid
);
79 foreach (array_keys($lineItems) as $id) {
80 $lineItems[$id]['id'] = $id;
82 $itemId = key($lineItems);
83 if ($itemId && !empty($lineItems[$itemId]['price_field_id'])) {
84 $this->_priceSetId
= CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceField', $lineItems[$itemId]['price_field_id'], 'price_set_id');
87 if (!empty($lineItems[$itemId]['price_field_id'])) {
88 $this->_lineItem
[$this->_priceSetId
] = $lineItems;
90 $isQuickConfig = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet', $this->_priceSetId
, 'is_quick_config');
91 $this->assign('lineItem', $this->_lineItem
);
92 $this->assign('is_quick_config', $isQuickConfig);
93 $this->assign('priceSetID', $this->_priceSetId
);
96 // Make the contributionPageID available to the template
97 $this->assign('contributionPageID', $this->_id
);
98 $this->assign('ccid', $this->_ccid
);
99 $this->assign('isShare', CRM_Utils_Array
::value('is_share', $this->_values
));
100 $this->assign('isConfirmEnabled', CRM_Utils_Array
::value('is_confirm_enabled', $this->_values
));
102 $this->assign('reset', CRM_Utils_Request
::retrieve('reset', 'Boolean'));
103 $this->assign('mainDisplay', CRM_Utils_Request
::retrieve('_qf_Main_display', 'Boolean',
104 CRM_Core_DAO
::$_nullObject));
106 if (!empty($this->_pcpInfo
['id']) && !empty($this->_pcpInfo
['intro_text'])) {
107 $this->assign('intro_text', $this->_pcpInfo
['intro_text']);
109 elseif (!empty($this->_values
['intro_text'])) {
110 $this->assign('intro_text', $this->_values
['intro_text']);
113 $qParams = "reset=1&id={$this->_id}";
114 if ($pcpId = CRM_Utils_Array
::value('pcp_id', $this->_pcpInfo
)) {
115 $qParams .= "&pcpId={$pcpId}";
117 $this->assign('qParams', $qParams);
119 if (!empty($this->_values
['footer_text'])) {
120 $this->assign('footer_text', $this->_values
['footer_text']);
125 * Set the default values.
127 public function setDefaultValues() {
128 // check if the user is registered and we have a contact ID
129 $contactID = $this->getContactID();
131 if (!empty($contactID)) {
133 $removeCustomFieldTypes = array('Contribution', 'Membership');
134 $contribFields = CRM_Contribute_BAO_Contribution
::getContributionFields();
136 // remove component related fields
137 foreach ($this->_fields
as $name => $dontCare) {
138 //don't set custom data Used for Contribution (CRM-1344)
139 if (substr($name, 0, 7) == 'custom_') {
140 $id = substr($name, 7);
141 if (!CRM_Core_BAO_CustomGroup
::checkCustomField($id, $removeCustomFieldTypes)) {
144 // ignore component fields
146 elseif (array_key_exists($name, $contribFields) ||
(substr($name, 0, 11) == 'membership_') ||
(substr($name, 0, 13) == 'contribution_')) {
152 if (!empty($fields)) {
153 CRM_Core_BAO_UFGroup
::setProfileDefaults($contactID, $fields, $this->_defaults
);
156 $billingDefaults = $this->getProfileDefaults('Billing', $contactID);
157 $this->_defaults
= array_merge($this->_defaults
, $billingDefaults);
159 if (!empty($this->_ccid
) && !empty($this->_pendingAmount
)) {
160 $this->_defaults
['total_amount'] = CRM_Utils_Money
::format($this->_pendingAmount
, NULL, '%a');
164 * hack to simplify credit card entry for testing
166 * $this->_defaults['credit_card_type'] = 'Visa';
167 * $this->_defaults['amount'] = 168;
168 * $this->_defaults['credit_card_number'] = '4111111111111111';
169 * $this->_defaults['cvv2'] = '000';
170 * $this->_defaults['credit_card_exp_date'] = array('Y' => date('Y')+1, 'M' => '05');
171 * // hack to simplify direct debit entry for testing
172 * $this->_defaults['account_holder'] = 'Max Müller';
173 * $this->_defaults['bank_account_number'] = '12345678';
174 * $this->_defaults['bank_identification_number'] = '12030000';
175 * $this->_defaults['bank_name'] = 'Bankname';
178 //build set default for pledge overdue payment.
179 if (!empty($this->_values
['pledge_id'])) {
180 //used to record completed pledge payment ids used later for honor default
181 $completedContributionIds = array();
182 $pledgePayments = CRM_Pledge_BAO_PledgePayment
::getPledgePayments($this->_values
['pledge_id']);
186 foreach ($pledgePayments as $payId => $value) {
187 if ($value['status'] == 'Overdue') {
188 $this->_defaults
['pledge_amount'][$payId] = 1;
189 $paymentAmount +
= $value['scheduled_amount'];
191 elseif (!$duePayment && $value['status'] == 'Pending') {
192 $this->_defaults
['pledge_amount'][$payId] = 1;
193 $paymentAmount +
= $value['scheduled_amount'];
196 elseif ($value['status'] == 'Completed' && $value['contribution_id']) {
197 $completedContributionIds[] = $value['contribution_id'];
200 $this->_defaults
['price_' . $this->_priceSetId
] = $paymentAmount;
202 if (count($completedContributionIds)) {
203 $softCredit = array();
204 foreach ($completedContributionIds as $id) {
205 $softCredit = CRM_Contribute_BAO_ContributionSoft
::getSoftContribution($id);
207 if (isset($softCredit['soft_credit'])) {
208 $this->_defaults
['soft_credit_type_id'] = $softCredit['soft_credit'][1]['soft_credit_type'];
210 //since honoree profile fieldname of fields are prefixed with 'honor'
211 //we need to reformat the fieldname to append prefix during setting default values
212 CRM_Core_BAO_UFGroup
::setProfileDefaults(
213 $softCredit['soft_credit'][1]['contact_id'],
214 CRM_Core_BAO_UFGroup
::getFields($this->_honoreeProfileId
),
217 foreach ($defaults as $fieldName => $value) {
218 $this->_defaults
['honor[' . $fieldName . ']'] = $value;
223 elseif (!empty($this->_values
['pledge_block_id'])) {
224 //set default to one time contribution.
225 $this->_defaults
['is_pledge'] = 0;
228 // to process Custom data that are appended to URL
229 $getDefaults = CRM_Core_BAO_CustomGroup
::extractGetParams($this, "'Contact', 'Individual', 'Contribution'");
230 $this->_defaults
= array_merge($this->_defaults
, $getDefaults);
232 $config = CRM_Core_Config
::singleton();
233 // set default country from config if no country set
234 if (empty($this->_defaults
["billing_country_id-{$this->_bltID}"])) {
235 $this->_defaults
["billing_country_id-{$this->_bltID}"] = $config->defaultContactCountry
;
238 // set default state/province from config if no state/province set
239 if (empty($this->_defaults
["billing_state_province_id-{$this->_bltID}"])) {
240 $this->_defaults
["billing_state_province_id-{$this->_bltID}"] = $config->defaultContactStateProvince
;
243 $entityId = $memtypeID = NULL;
244 if ($this->_priceSetId
) {
245 if (($this->_useForMember
&& !empty($this->_currentMemberships
)) ||
$this->_defaultMemTypeId
) {
246 $selectedCurrentMemTypes = array();
247 foreach ($this->_priceSet
['fields'] as $key => $val) {
248 foreach ($val['options'] as $keys => $values) {
249 $opMemTypeId = CRM_Utils_Array
::value('membership_type_id', $values);
250 $priceFieldName = 'price_' . $values['price_field_id'];
251 $priceFieldValue = CRM_Price_BAO_PriceSet
::getPriceFieldValueFromURL($this, $priceFieldName);
252 if (!empty($priceFieldValue)) {
253 CRM_Price_BAO_PriceSet
::setDefaultPriceSetField($priceFieldName, $priceFieldValue, $val['html_type'], $this->_defaults
);
254 // break here to prevent overwriting of default due to 'is_default'
255 // option configuration or setting of current membership or
256 // membership for related organization.
257 // The value sent via URL get's higher priority.
260 elseif ($opMemTypeId &&
261 in_array($opMemTypeId, $this->_currentMemberships
) &&
262 !in_array($opMemTypeId, $selectedCurrentMemTypes)
264 CRM_Price_BAO_PriceSet
::setDefaultPriceSetField($priceFieldName, $keys, $val['html_type'], $this->_defaults
);
265 $memtypeID = $selectedCurrentMemTypes[] = $values['membership_type_id'];
267 elseif (!empty($values['is_default']) &&
269 (!isset($this->_defaults
[$priceFieldName]) ||
270 ($val['html_type'] == 'CheckBox' &&
271 !isset($this->_defaults
[$priceFieldName][$keys]))
273 CRM_Price_BAO_PriceSet
::setDefaultPriceSetField($priceFieldName, $keys, $val['html_type'], $this->_defaults
);
274 $memtypeID = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceFieldValue', $this->_defaults
[$priceFieldName], 'membership_type_id');
278 $entityId = CRM_Utils_Array
::value('id', CRM_Member_BAO_Membership
::getContactMembership($contactID, $memtypeID, NULL));
281 CRM_Price_BAO_PriceSet
::setDefaultPriceSet($this, $this->_defaults
);
285 //set custom field defaults set by admin if value is not set
286 if (!empty($this->_fields
)) {
287 //load default campaign from page.
288 if (array_key_exists('contribution_campaign_id', $this->_fields
)) {
289 $this->_defaults
['contribution_campaign_id'] = CRM_Utils_Array
::value('campaign_id', $this->_values
);
292 //set custom field defaults
293 foreach ($this->_fields
as $name => $field) {
294 if ($customFieldID = CRM_Core_BAO_CustomField
::getKeyID($name)) {
295 if (!isset($this->_defaults
[$name])) {
296 CRM_Core_BAO_CustomField
::setProfileDefaults($customFieldID, $name, $this->_defaults
,
297 $entityId, CRM_Profile_Form
::MODE_REGISTER
304 if (!empty($this->_paymentProcessors
)) {
305 foreach ($this->_paymentProcessors
as $pid => $value) {
306 if (!empty($value['is_default'])) {
307 $this->_defaults
['payment_processor_id'] = $pid;
312 return $this->_defaults
;
316 * Build the form object.
318 public function buildQuickForm() {
319 // build profiles first so that we can determine address fields etc
320 // and then show copy address checkbox
321 if (empty($this->_ccid
)) {
322 $this->buildCustom($this->_values
['custom_pre_id'], 'customPre');
323 $this->buildCustom($this->_values
['custom_post_id'], 'customPost');
325 // CRM-18399: used by template to pass pre profile id as a url arg
326 $this->assign('custom_pre_id', $this->_values
['custom_pre_id']);
328 $this->buildComponentForm($this->_id
, $this);
331 // Build payment processor form
332 CRM_Core_Payment_ProcessorForm
::buildQuickForm($this);
334 $config = CRM_Core_Config
::singleton();
336 $contactID = $this->getContactID();
338 $this->assign('contact_id', $contactID);
339 $this->assign('display_name', CRM_Contact_BAO_Contact
::displayName($contactID));
342 $this->applyFilter('__ALL__', 'trim');
343 if (empty($this->_ccid
)) {
344 $this->add('text', "email-{$this->_bltID}",
346 array('size' => 30, 'maxlength' => 60, 'class' => 'email'),
349 $this->addRule("email-{$this->_bltID}", ts('Email is not valid.'), 'email');
352 $this->addElement('hidden', "email-{$this->_bltID}", 1);
353 $this->add('text', 'total_amount', ts('Total Amount'), array('readonly' => TRUE), FALSE);
356 //@todo - this should be replaced by a check as to whether billing fields are set
357 $onlinePaymentProcessorEnabled = FALSE;
358 if (!empty($this->_paymentProcessors
)) {
359 foreach ($this->_paymentProcessors
as $key => $name) {
360 if ($name['billing_mode'] == 1) {
361 $onlinePaymentProcessorEnabled = TRUE;
363 $pps[$key] = $name['name'];
366 if (!empty($this->_values
['is_pay_later'])) {
367 $pps[0] = $this->_values
['pay_later_text'];
370 if (count($pps) > 1) {
371 $this->addRadio('payment_processor_id', ts('Payment Method'), $pps,
375 elseif (!empty($pps)) {
376 $key = array_keys($pps);
377 $key = array_pop($key);
378 $this->addElement('hidden', 'payment_processor_id', $key);
380 $this->assign('is_pay_later', $this->_values
['is_pay_later']);
381 $this->assign('pay_later_text', $this->_values
['pay_later_text']);
385 $contactID = $this->getContactID();
386 if ($this->getContactID() === 0) {
387 $this->addCidZeroOptions($onlinePaymentProcessorEnabled);
390 //build pledge block.
391 $this->_useForMember
= 0;
392 //don't build membership block when pledge_id is passed
393 if (empty($this->_values
['pledge_id']) && empty($this->_ccid
)) {
394 $this->_separateMembershipPayment
= FALSE;
395 if (in_array('CiviMember', $config->enableComponents
)) {
397 if ($this->_action
& CRM_Core_Action
::PREVIEW
) {
401 if ($this->_priceSetId
&&
402 (CRM_Core_Component
::getComponentID('CiviMember') == CRM_Utils_Array
::value('extends', $this->_priceSet
))
404 $this->_useForMember
= 1;
405 $this->set('useForMember', $this->_useForMember
);
408 $this->_separateMembershipPayment
= $this->buildMembershipBlock(
409 $this->_membershipContactID
,
414 $this->set('separateMembershipPayment', $this->_separateMembershipPayment
);
416 $this->assign('useForMember', $this->_useForMember
);
417 // If we configured price set for contribution page
418 // we are not allow membership signup as well as any
419 // other contribution amount field, CRM-5095
420 if (isset($this->_priceSetId
) && $this->_priceSetId
) {
421 $this->add('hidden', 'priceSetId', $this->_priceSetId
);
422 // build price set form.
423 $this->set('priceSetId', $this->_priceSetId
);
424 if (empty($this->_ccid
)) {
425 CRM_Price_BAO_PriceSet
::buildPriceSet($this);
427 if ($this->_values
['is_monetary'] &&
428 $this->_values
['is_recur'] && empty($this->_values
['pledge_id'])
430 self
::buildRecur($this);
434 if ($this->_priceSetId
&& empty($this->_ccid
)) {
435 $is_quick_config = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet', $this->_priceSetId
, 'is_quick_config');
436 if ($is_quick_config) {
437 $this->_useForMember
= 0;
438 $this->set('useForMember', $this->_useForMember
);
442 //we allow premium for pledge during pledge creation only.
443 if (empty($this->_values
['pledge_id']) && empty($this->_ccid
)) {
444 CRM_Contribute_BAO_Premium
::buildPremiumBlock($this, $this->_id
, TRUE);
447 //don't build pledge block when mid is passed
448 if (!$this->_mid
&& empty($this->_ccid
)) {
449 $config = CRM_Core_Config
::singleton();
450 if (in_array('CiviPledge', $config->enableComponents
) && !empty($this->_values
['pledge_block_id'])) {
451 CRM_Pledge_BAO_PledgeBlock
::buildPledgeBlock($this);
455 //to create an cms user
456 if (!$this->_contactID
&& empty($this->_ccid
)) {
457 $createCMSUser = FALSE;
459 if ($this->_values
['custom_pre_id']) {
460 $profileID = $this->_values
['custom_pre_id'];
461 $createCMSUser = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_UFGroup', $profileID, 'is_cms_user');
464 if (!$createCMSUser &&
465 $this->_values
['custom_post_id']
467 if (!is_array($this->_values
['custom_post_id'])) {
468 $profileIDs = array($this->_values
['custom_post_id']);
471 $profileIDs = $this->_values
['custom_post_id'];
473 foreach ($profileIDs as $pid) {
474 if (CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_UFGroup', $pid, 'is_cms_user')) {
476 $createCMSUser = TRUE;
482 if ($createCMSUser) {
483 CRM_Core_BAO_CMSUser
::buildForm($this, $profileID, TRUE);
486 if ($this->_pcpId
&& empty($this->_ccid
)) {
487 if ($pcpSupporter = CRM_PCP_BAO_PCP
::displayName($this->_pcpId
)) {
488 $pcp_supporter_text = ts('This contribution is being made thanks to the effort of <strong>%1</strong>, who supports our campaign.', array(1 => $pcpSupporter));
489 // Only tell people that can also create a PCP if the contribution page has a non-empty value in the "Create Personal Campaign Page link" field.
490 $text = CRM_PCP_BAO_PCP
::getPcpBlockStatus($this->_id
, 'contribute');
492 $pcp_supporter_text .= ts("You can support it as well - once you complete the donation, you will be able to create your own Personal Campaign Page!");
494 $this->assign('pcpSupporterText', $pcp_supporter_text);
496 $prms = array('id' => $this->_pcpId
);
497 CRM_Core_DAO
::commonRetrieve('CRM_PCP_DAO_PCP', $prms, $pcpInfo);
498 if ($pcpInfo['is_honor_roll']) {
499 $this->assign('isHonor', TRUE);
500 $this->add('checkbox', 'pcp_display_in_roll', ts('Show my contribution in the public honor roll'), NULL, NULL,
501 array('onclick' => "showHideByValue('pcp_display_in_roll','','nameID|nickID|personalNoteID','block','radio',false); pcpAnonymous( );")
503 $extraOption = array('onclick' => "return pcpAnonymous( );");
505 $elements[] = &$this->createElement('radio', NULL, '', ts('Include my name and message'), 0, $extraOption);
506 $elements[] = &$this->createElement('radio', NULL, '', ts('List my contribution anonymously'), 1, $extraOption);
507 $this->addGroup($elements, 'pcp_is_anonymous', NULL, ' ');
509 $this->add('text', 'pcp_roll_nickname', ts('Name'), array('maxlength' => 30));
510 $this->add('textarea', 'pcp_personal_note', ts('Personal Note'), array('style' => 'height: 3em; width: 40em;'));
513 if (empty($this->_values
['fee']) && empty($this->_ccid
)) {
514 CRM_Core_Error
::fatal(ts('This page does not have any price fields configured or you may not have permission for them. Please contact the site administrator for more details.'));
517 //we have to load confirm contribution button in template
518 //when multiple payment processor as the user
519 //can toggle with payment processor selection
520 $billingModePaymentProcessors = 0;
521 if (!empty($this->_paymentProcessors
)) {
522 foreach ($this->_paymentProcessors
as $key => $values) {
523 if ($values['billing_mode'] == CRM_Core_Payment
::BILLING_MODE_BUTTON
) {
524 $billingModePaymentProcessors++
;
529 if ($billingModePaymentProcessors && count($this->_paymentProcessors
) == $billingModePaymentProcessors) {
530 $allAreBillingModeProcessors = TRUE;
533 $allAreBillingModeProcessors = FALSE;
536 if (!($allAreBillingModeProcessors && !$this->_values
['is_pay_later'])) {
537 $submitButton = array(
539 'name' => CRM_Utils_Array
::value('is_confirm_enabled', $this->_values
) ?
ts('Confirm Contribution') : ts('Contribute'),
540 'spacing' => ' ',
543 // Add submit-once behavior when confirm page disabled
544 if (empty($this->_values
['is_confirm_enabled'])) {
545 $submitButton['js'] = array('onclick' => "return submitOnce(this,'" . $this->_name
. "','" . ts('Processing') . "');");
547 //change button name for updating contribution
548 if (!empty($this->_ccid
)) {
549 $submitButton['name'] = ts('Confirm Payment');
551 $this->addButtons(array($submitButton));
554 $this->addFormRule(array('CRM_Contribute_Form_Contribution_Main', 'formRule'), $this);
558 * Build elements to collect information for recurring contributions.
561 * @param CRM_Core_Form $form
563 public static function buildRecur(&$form) {
564 $attributes = CRM_Core_DAO
::getAttribute('CRM_Contribute_DAO_ContributionRecur');
565 $className = get_class($form);
567 $form->assign('is_recur_interval', CRM_Utils_Array
::value('is_recur_interval', $form->_values
));
568 $form->assign('is_recur_installments', CRM_Utils_Array
::value('is_recur_installments', $form->_values
));
570 $form->add('checkbox', 'is_recur', ts('I want to contribute this amount'), NULL);
572 if (!empty($form->_values
['is_recur_interval']) ||
$className == 'CRM_Contribute_Form_Contribution') {
573 $form->add('text', 'frequency_interval', ts('Every'), $attributes['frequency_interval']);
574 $form->addRule('frequency_interval', ts('Frequency must be a whole number (EXAMPLE: Every 3 months).'), 'integer');
577 // make sure frequency_interval is submitted as 1 if given no choice to user.
578 $form->add('hidden', 'frequency_interval', 1);
581 $frUnits = CRM_Utils_Array
::value('recur_frequency_unit', $form->_values
);
582 if (empty($frUnits) &&
583 $className == 'CRM_Contribute_Form_Contribution'
585 $frUnits = implode(CRM_Core_DAO
::VALUE_SEPARATOR
,
586 CRM_Core_OptionGroup
::values('recur_frequency_units')
590 $unitVals = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $frUnits);
592 // CRM 10860, display text instead of a dropdown if there's only 1 frequency unit
593 if (count($unitVals) == 1) {
594 $form->assign('one_frequency_unit', TRUE);
595 $unit = $unitVals[0];
596 $form->add('hidden', 'frequency_unit', $unit);
597 if (!empty($form->_values
['is_recur_interval']) ||
$className == 'CRM_Contribute_Form_Contribution') {
600 $form->assign('frequency_unit', $unit);
603 $form->assign('one_frequency_unit', FALSE);
605 $frequencyUnits = CRM_Core_OptionGroup
::values('recur_frequency_units', FALSE, FALSE, TRUE);
606 foreach ($unitVals as $key => $val) {
607 if (array_key_exists($val, $frequencyUnits)) {
608 $units[$val] = $frequencyUnits[$val];
609 if (!empty($form->_values
['is_recur_interval']) ||
$className == 'CRM_Contribute_Form_Contribution') {
610 $units[$val] = "{$frequencyUnits[$val]}(s)";
614 $frequencyUnit = &$form->add('select', 'frequency_unit', NULL, $units);
617 // FIXME: Ideally we should freeze select box if there is only
618 // one option but looks there is some problem /w QF freeze.
619 //if ( count( $units ) == 1 ) {
620 //$frequencyUnit->freeze( );
623 $form->add('text', 'installments', ts('installments'),
624 $attributes['installments']
626 $form->addRule('installments', ts('Number of installments must be a whole number.'), 'integer');
632 * @param array $fields
633 * The input form values.
634 * @param array $files
635 * The uploaded files if any.
636 * @param CRM_Core_Form $self
639 * true if no errors, else array of errors
641 public static function formRule($fields, $files, $self) {
643 $amount = self
::computeAmount($fields, $self->_values
);
644 if (CRM_Utils_Array
::value('auto_renew', $fields) &&
645 CRM_Utils_Array
::value('payment_processor_id', $fields) == 0
647 $errors['auto_renew'] = ts('You cannot have auto-renewal on if you are paying later.');
650 if ((!empty($fields['selectMembership']) &&
651 $fields['selectMembership'] != 'no_thanks'
653 (!empty($fields['priceSetId']) &&
657 $isTest = ($self->_action
& CRM_Core_Action
::PREVIEW
) ?
TRUE : FALSE;
658 $lifeMember = CRM_Member_BAO_Membership
::getAllContactMembership($self->_membershipContactID
, $isTest, TRUE);
660 $membershipOrgDetails = CRM_Member_BAO_MembershipType
::getMembershipTypeOrganization();
662 $unallowedOrgs = array();
663 foreach (array_keys($lifeMember) as $memTypeId) {
664 $unallowedOrgs[] = $membershipOrgDetails[$memTypeId];
668 //check for atleast one pricefields should be selected
669 if (!empty($fields['priceSetId']) && empty($self->_ccid
)) {
670 $priceField = new CRM_Price_DAO_PriceField();
671 $priceField->price_set_id
= $fields['priceSetId'];
672 $priceField->orderBy('weight');
676 $membershipIsActive = TRUE;
677 $previousId = $otherAmount = FALSE;
678 while ($priceField->fetch()) {
680 if ($self->_quickConfig
&& ($priceField->name
== 'contribution_amount' ||
$priceField->name
== 'membership_amount')) {
681 $previousId = $priceField->id
;
682 if ($priceField->name
== 'membership_amount' && !$priceField->is_active
) {
683 $membershipIsActive = FALSE;
686 if ($priceField->name
== 'other_amount') {
687 if ($self->_quickConfig
&& empty($fields["price_{$priceField->id}"]) &&
688 array_key_exists("price_{$previousId}", $fields) && isset($fields["price_{$previousId}"]) && $self->_values
['fee'][$previousId]['name'] == 'contribution_amount' && empty($fields["price_{$previousId}"])
690 $otherAmount = $priceField->id
;
692 elseif (!empty($fields["price_{$priceField->id}"])) {
693 $otherAmountVal = CRM_Utils_Rule
::cleanMoney($fields["price_{$priceField->id}"]);
694 $min = CRM_Utils_Array
::value('min_amount', $self->_values
);
695 $max = CRM_Utils_Array
::value('max_amount', $self->_values
);
696 if ($min && $otherAmountVal < $min) {
697 $errors["price_{$priceField->id}"] = ts('Contribution amount must be at least %1',
701 if ($max && $otherAmountVal > $max) {
702 $errors["price_{$priceField->id}"] = ts('Contribution amount cannot be more than %1.',
708 if (!empty($fields["price_{$priceField->id}"]) ||
($previousId == $priceField->id
&& isset($fields["price_{$previousId}"])
709 && empty($fields["price_{$previousId}"]))
711 $check[] = $priceField->id
;
715 $currentMemberships = NULL;
716 if ($membershipIsActive) {
717 $is_test = $self->_mode
!= 'live' ?
1 : 0;
718 $memContactID = $self->_membershipContactID
;
720 // For anonymous user check using dedupe rule
721 // if user has Cancelled Membership
722 if (!$memContactID) {
723 $dedupeParams = CRM_Dedupe_Finder
::formatParams($fields, 'Individual');
724 $dedupeParams['check_permission'] = FALSE;
725 $ids = CRM_Dedupe_Finder
::dupesByParams($dedupeParams, 'Individual');
726 // if we find more than one contact, use the first one
727 $memContactID = CRM_Utils_Array
::value(0, $ids);
729 $currentMemberships = CRM_Member_BAO_Membership
::getContactsCancelledMembership($memContactID,
733 $errorText = 'Your %1 membership was previously cancelled and can not be renewed online. Please contact the site administrator for assistance.';
734 foreach ($self->_values
['fee'] as $fieldKey => $fieldValue) {
735 if ($fieldValue['html_type'] != 'Text' && CRM_Utils_Array
::value('price_' . $fieldKey, $fields)) {
736 if (!is_array($fields['price_' . $fieldKey]) && isset($fieldValue['options'][$fields['price_' . $fieldKey]])) {
737 if (array_key_exists('membership_type_id', $fieldValue['options'][$fields['price_' . $fieldKey]])
738 && in_array($fieldValue['options'][$fields['price_' . $fieldKey]]['membership_type_id'], $currentMemberships)
740 $errors['price_' . $fieldKey] = ts($errorText, array(1 => CRM_Member_PseudoConstant
::membershipType($fieldValue['options'][$fields['price_' . $fieldKey]]['membership_type_id'])));
744 if (is_array($fields['price_' . $fieldKey])) {
745 foreach (array_keys($fields['price_' . $fieldKey]) as $key) {
746 if (array_key_exists('membership_type_id', $fieldValue['options'][$key])
747 && in_array($fieldValue['options'][$key]['membership_type_id'], $currentMemberships)
749 $errors['price_' . $fieldKey] = ts($errorText, array(1 => CRM_Member_PseudoConstant
::membershipType($fieldValue['options'][$key]['membership_type_id'])));
759 if ($membershipIsActive && !$self->_membershipBlock
['is_required']
760 && $self->_values
['amount_block_is_active']
762 $membershipFieldId = $contributionFieldId = $errorKey = $otherFieldId = NULL;
763 foreach ($self->_values
['fee'] as $fieldKey => $fieldValue) {
764 // if 'No thank you' membership is selected then set $membershipFieldId
765 if ($fieldValue['name'] == 'membership_amount' && CRM_Utils_Array
::value('price_' . $fieldKey, $fields) == 0) {
766 $membershipFieldId = $fieldKey;
768 elseif ($membershipFieldId) {
769 if ($fieldValue['name'] == 'other_amount') {
770 $otherFieldId = $fieldKey;
772 elseif ($fieldValue['name'] == 'contribution_amount') {
773 $contributionFieldId = $fieldKey;
776 if (!$errorKey || CRM_Utils_Array
::value('price_' . $contributionFieldId, $fields) == '0') {
777 $errorKey = $fieldKey;
781 // $membershipFieldId is set and additional amount is 'No thank you' or NULL then throw error
782 if ($membershipFieldId && !(CRM_Utils_Array
::value('price_' . $contributionFieldId, $fields, -1) > 0) && empty($fields['price_' . $otherFieldId])) {
783 $errors["price_{$errorKey}"] = ts('Additional Contribution is required.');
786 if (empty($check) && empty($self->_ccid
)) {
787 if ($self->_useForMember
== 1 && $membershipIsActive) {
788 $errors['_qf_default'] = ts('Select at least one option from Membership Type(s).');
791 $errors['_qf_default'] = ts('Select at least one option from Contribution(s).');
794 if ($otherAmount && !empty($check)) {
795 $errors["price_{$otherAmount}"] = ts('Amount is required field.');
798 if ($self->_useForMember
== 1 && !empty($check) && $membershipIsActive) {
799 $priceFieldIDS = array();
800 $priceFieldMemTypes = array();
802 foreach ($self->_priceSet
['fields'] as $priceId => $value) {
803 if (!empty($fields['price_' . $priceId]) ||
($self->_quickConfig
&& $value['name'] == 'membership_amount' && empty($self->_membershipBlock
['is_required']))) {
804 if (!empty($fields['price_' . $priceId]) && is_array($fields['price_' . $priceId])) {
805 foreach ($fields['price_' . $priceId] as $priceFldVal => $isSet) {
807 $priceFieldIDS[] = $priceFldVal;
811 elseif (!$value['is_enter_qty'] && !empty($fields['price_' . $priceId])) {
812 // The check for {!$value['is_enter_qty']} is done since, quantity fields allow entering
813 // quantity. And the quantity can't be conisdered as civicrm_price_field_value.id, CRM-9577
814 $priceFieldIDS[] = $fields['price_' . $priceId];
817 if (!empty($value['options'])) {
818 foreach ($value['options'] as $val) {
819 if (!empty($val['membership_type_id']) && (
820 ($fields['price_' . $priceId] == $val['id']) ||
821 (isset($fields['price_' . $priceId]) && !empty($fields['price_' . $priceId][$val['id']]))
824 $priceFieldMemTypes[] = $val['membership_type_id'];
831 if (!empty($lifeMember)) {
832 foreach ($priceFieldIDS as $priceFieldId) {
833 if (($id = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceFieldValue', $priceFieldId, 'membership_type_id')) &&
834 in_array($membershipOrgDetails[$id], $unallowedOrgs)
836 $errors['_qf_default'] = ts('You already have a lifetime membership and cannot select a membership with a shorter term.');
842 if (!empty($priceFieldIDS)) {
843 $ids = implode(',', $priceFieldIDS);
845 $priceFieldIDS['id'] = $fields['priceSetId'];
846 $self->set('memberPriceFieldIDS', $priceFieldIDS);
847 $count = CRM_Price_BAO_PriceSet
::getMembershipCount($ids);
848 foreach ($count as $id => $occurrence) {
849 if ($occurrence > 1) {
850 $errors['_qf_default'] = ts('You have selected multiple memberships for the same organization or entity. Please review your selections and choose only one membership per entity. Contact the site administrator if you need assistance.');
855 if (empty($priceFieldMemTypes) && $self->_membershipBlock
['is_required'] == 1) {
856 $errors['_qf_default'] = ts('Please select at least one membership option.');
860 CRM_Price_BAO_PriceSet
::processAmount($self->_values
['fee'],
864 $minAmt = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet', $fields['priceSetId'], 'min_amount');
865 if ($fields['amount'] < 0) {
866 $errors['_qf_default'] = ts('Contribution can not be less than zero. Please select the options accordingly');
868 elseif (!empty($minAmt) && $fields['amount'] < $minAmt) {
869 $errors['_qf_default'] = ts('A minimum amount of %1 should be selected from Contribution(s).', array(
870 1 => CRM_Utils_Money
::format($minAmt),
874 $amount = $fields['amount'];
877 if (isset($fields['selectProduct']) &&
878 $fields['selectProduct'] != 'no_thanks'
880 $productDAO = new CRM_Contribute_DAO_Product();
881 $productDAO->id
= $fields['selectProduct'];
882 $productDAO->find(TRUE);
883 $min_amount = $productDAO->min_contribution
;
885 if ($amount < $min_amount) {
886 $errors['selectProduct'] = ts('The premium you have selected requires a minimum contribution of %1', array(1 => CRM_Utils_Money
::format($min_amount)));
887 CRM_Core_Session
::setStatus($errors['selectProduct']);
891 //CRM-16285 - Function to handle validation errors on form, for recurring contribution field.
892 CRM_Contribute_BAO_ContributionRecur
::validateRecurContribution($fields, $files, $self, $errors);
894 if (!empty($fields['is_recur']) &&
895 CRM_Utils_Array
::value('payment_processor_id', $fields) == 0
897 $errors['_qf_default'] = ts('You cannot set up a recurring contribution if you are not paying online by credit card.');
900 // validate PCP fields - if not anonymous, we need a nick name value
901 if ($self->_pcpId
&& !empty($fields['pcp_display_in_roll']) &&
902 (CRM_Utils_Array
::value('pcp_is_anonymous', $fields) == 0) &&
903 CRM_Utils_Array
::value('pcp_roll_nickname', $fields) == ''
905 $errors['pcp_roll_nickname'] = ts('Please enter a name to include in the Honor Roll, or select \'contribute anonymously\'.');
908 // return if this is express mode
909 $config = CRM_Core_Config
::singleton();
910 if ($self->_paymentProcessor
&&
911 $self->_paymentProcessor
['billing_mode'] & CRM_Core_Payment
::BILLING_MODE_BUTTON
913 if (!empty($fields[$self->_expressButtonName
. '_x']) ||
!empty($fields[$self->_expressButtonName
. '_y']) ||
914 CRM_Utils_Array
::value($self->_expressButtonName
, $fields)
920 //validate the pledge fields.
921 if (!empty($self->_values
['pledge_block_id'])) {
922 //validation for pledge payment.
923 if (!empty($self->_values
['pledge_id'])) {
924 if (empty($fields['pledge_amount'])) {
925 $errors['pledge_amount'] = ts('At least one payment option needs to be checked.');
928 elseif (!empty($fields['is_pledge'])) {
929 if (CRM_Utils_Rule
::positiveInteger(CRM_Utils_Array
::value('pledge_installments', $fields)) == FALSE) {
930 $errors['pledge_installments'] = ts('Please enter a valid number of pledge installments.');
933 if (CRM_Utils_Array
::value('pledge_installments', $fields) == NULL) {
934 $errors['pledge_installments'] = ts('Pledge Installments is required field.');
936 elseif (CRM_Utils_Array
::value('pledge_installments', $fields) == 1) {
937 $errors['pledge_installments'] = ts('Pledges consist of multiple scheduled payments. Select one-time contribution if you want to make your gift in a single payment.');
939 elseif (CRM_Utils_Array
::value('pledge_installments', $fields) == 0) {
940 $errors['pledge_installments'] = ts('Pledge Installments field must be > 1.');
944 //validation for Pledge Frequency Interval.
945 if (CRM_Utils_Rule
::positiveInteger(CRM_Utils_Array
::value('pledge_frequency_interval', $fields)) == FALSE) {
946 $errors['pledge_frequency_interval'] = ts('Please enter a valid Pledge Frequency Interval.');
949 if (CRM_Utils_Array
::value('pledge_frequency_interval', $fields) == NULL) {
950 $errors['pledge_frequency_interval'] = ts('Pledge Frequency Interval. is required field.');
952 elseif (CRM_Utils_Array
::value('pledge_frequency_interval', $fields) == 0) {
953 $errors['pledge_frequency_interval'] = ts('Pledge frequency interval field must be > 0');
959 // if the user has chosen a free membership or the amount is less than zero
960 // i.e. we don't need to validate payment related fields or profiles.
961 if ((float) $amount <= 0.0) {
965 if (CRM_Utils_Array
::value('payment_processor_id', $fields) == NULL) {
966 $errors['payment_processor_id'] = ts('Payment Method is a required field.');
969 CRM_Core_Payment_Form
::validatePaymentInstrument(
970 $fields['payment_processor_id'],
973 (!$self->_isBillingAddressRequiredForPayLater ?
NULL : 'billing')
977 foreach (CRM_Contact_BAO_Contact
::$_greetingTypes as $greeting) {
978 if ($greetingType = CRM_Utils_Array
::value($greeting, $fields)) {
979 $customizedValue = CRM_Core_OptionGroup
::getValue($greeting, 'Customized', 'name');
980 if ($customizedValue == $greetingType && empty($fielse[$greeting . '_custom'])) {
981 $errors[$greeting . '_custom'] = ts('Custom %1 is a required field if %1 is of type Customized.',
982 array(1 => ucwords(str_replace('_', " ", $greeting)))
988 return empty($errors) ?
TRUE : $errors;
992 * Compute amount to be paid.
994 * @param array $params
995 * @param array $formValues
997 * @return int|mixed|null|string
999 public static function computeAmount($params, $formValues) {
1001 // First clean up the other amount field if present.
1002 if (isset($params['amount_other'])) {
1003 $params['amount_other'] = CRM_Utils_Rule
::cleanMoney($params['amount_other']);
1006 if (CRM_Utils_Array
::value('amount', $params) == 'amount_other_radio' ||
!empty($params['amount_other'])) {
1007 $amount = $params['amount_other'];
1009 elseif (!empty($params['pledge_amount'])) {
1010 foreach ($params['pledge_amount'] as $paymentId => $dontCare) {
1011 $amount +
= CRM_Core_DAO
::getFieldValue('CRM_Pledge_DAO_PledgePayment', $paymentId, 'scheduled_amount');
1015 if (!empty($formValues['amount'])) {
1016 $amountID = CRM_Utils_Array
::value('amount', $params);
1019 // @todo - stop setting amount level in this function & call the CRM_Price_BAO_PriceSet::getAmountLevel
1020 // function to get correct amount level consistently. Remove setting of the amount level in
1021 // CRM_Price_BAO_PriceSet::processAmount. Extend the unit tests in CRM_Price_BAO_PriceSetTest
1022 // to cover all variants.
1023 $params['amount_level'] = CRM_Utils_Array
::value('label', $formValues[$amountID]);
1024 $amount = CRM_Utils_Array
::value('value', $formValues[$amountID]);
1032 * Process the form submission.
1034 public function postProcess() {
1035 // we first reset the confirm page so it accepts new values
1036 $this->controller
->resetPage('Confirm');
1038 // get the submitted form values.
1039 $params = $this->controller
->exportValues($this->_name
);
1040 $this->submit($params);
1042 if (empty($this->_values
['is_confirm_enabled'])) {
1043 $this->skipToThankYouPage();
1051 * This is the guts of the postProcess made also accessible to the test suite.
1053 * @param array $params
1056 public function submit($params) {
1057 //carry campaign from profile.
1058 if (array_key_exists('contribution_campaign_id', $params)) {
1059 $params['campaign_id'] = $params['contribution_campaign_id'];
1062 $params['currencyID'] = CRM_Core_Config
::singleton()->defaultCurrency
;
1064 // @todo refactor this & leverage it from the unit tests.
1065 if (!empty($params['priceSetId'])) {
1066 $is_quick_config = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet', $this->_priceSetId
, 'is_quick_config');
1067 if ($is_quick_config) {
1068 $priceField = new CRM_Price_DAO_PriceField();
1069 $priceField->price_set_id
= $params['priceSetId'];
1070 $priceField->orderBy('weight');
1071 $priceField->find();
1073 $priceOptions = array();
1074 while ($priceField->fetch()) {
1075 CRM_Price_BAO_PriceFieldValue
::getValues($priceField->id
, $priceOptions);
1076 if (($selectedPriceOptionID = CRM_Utils_Array
::value("price_{$priceField->id}", $params)) != FALSE && $selectedPriceOptionID > 0) {
1077 switch ($priceField->name
) {
1078 case 'membership_amount':
1079 $this->_params
['selectMembership'] = $params['selectMembership'] = CRM_Utils_Array
::value('membership_type_id', $priceOptions[$selectedPriceOptionID]);
1080 $this->set('selectMembership', $params['selectMembership']);
1082 case 'contribution_amount':
1083 $params['amount'] = $selectedPriceOptionID;
1084 if ($priceField->name
== 'contribution_amount' ||
1085 ($priceField->name
== 'membership_amount' &&
1086 CRM_Utils_Array
::value('is_separate_payment', $this->_membershipBlock
) == 0)
1088 $this->_values
['amount'] = CRM_Utils_Array
::value('amount', $priceOptions[$selectedPriceOptionID]);
1090 $this->_values
[$selectedPriceOptionID]['value'] = CRM_Utils_Array
::value('amount', $priceOptions[$selectedPriceOptionID]);
1091 $this->_values
[$selectedPriceOptionID]['label'] = CRM_Utils_Array
::value('label', $priceOptions[$selectedPriceOptionID]);
1092 $this->_values
[$selectedPriceOptionID]['amount_id'] = CRM_Utils_Array
::value('id', $priceOptions[$selectedPriceOptionID]);
1093 $this->_values
[$selectedPriceOptionID]['weight'] = CRM_Utils_Array
::value('weight', $priceOptions[$selectedPriceOptionID]);
1096 case 'other_amount':
1097 $params['amount_other'] = $selectedPriceOptionID;
1105 if (!empty($this->_ccid
) && !empty($this->_pendingAmount
)) {
1106 $params['amount'] = $this->_pendingAmount
;
1109 // from here on down, $params['amount'] holds a monetary value (or null) rather than an option ID
1110 $params['amount'] = self
::computeAmount($params, $this->_values
);
1113 $params['separate_amount'] = $params['amount'];
1115 if (!empty($params['selectMembership'])) {
1116 if (empty($this->_membershipTypeValues
)) {
1117 $this->_membershipTypeValues
= CRM_Member_BAO_Membership
::buildMembershipTypeValues($this,
1118 (array) $params['selectMembership']
1121 $membershipTypeValues = $this->_membershipTypeValues
[$params['selectMembership']];
1122 $memFee = $membershipTypeValues['minimum_fee'];
1123 if (!$params['amount'] && !$this->_separateMembershipPayment
) {
1124 $params['amount'] = $memFee ?
$memFee : 0;
1127 //If the membership & contribution is used in contribution page & not separate payment
1128 $memPresent = $membershipLabel = $fieldOption = $is_quick_config = NULL;
1129 $proceFieldAmount = 0;
1130 if (property_exists($this, '_separateMembershipPayment') && $this->_separateMembershipPayment
== 0) {
1131 $is_quick_config = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet', $this->_priceSetId
, 'is_quick_config');
1132 if ($is_quick_config) {
1133 foreach ($this->_priceSet
['fields'] as $fieldKey => $fieldVal) {
1134 if ($fieldVal['name'] == 'membership_amount' && !empty($params['price_' . $fieldKey])) {
1135 $fieldId = $fieldVal['id'];
1136 $fieldOption = $params['price_' . $fieldId];
1137 $proceFieldAmount +
= $fieldVal['options'][$this->_submitValues
['price_' . $fieldId]]['amount'];
1141 if (!empty($params['price_' . $fieldKey]) && $memPresent && ($fieldVal['name'] == 'other_amount' ||
$fieldVal['name'] == 'contribution_amount')) {
1142 $fieldId = $fieldVal['id'];
1143 if ($fieldVal['name'] == 'other_amount') {
1144 $proceFieldAmount +
= $this->_submitValues
['price_' . $fieldId];
1146 elseif ($fieldVal['name'] == 'contribution_amount' && $this->_submitValues
['price_' . $fieldId] > 0) {
1147 $proceFieldAmount +
= $fieldVal['options'][$this->_submitValues
['price_' . $fieldId]]['amount'];
1149 unset($params['price_' . $fieldId]);
1157 if (!isset($params['amount_other'])) {
1158 $this->set('amount_level', CRM_Utils_Array
::value('amount_level', $params));
1161 if (!empty($this->_ccid
)) {
1162 $this->set('lineItem', $this->_lineItem
);
1164 elseif ($priceSetId = CRM_Utils_Array
::value('priceSetId', $params)) {
1165 $lineItem = array();
1166 $is_quick_config = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet', $priceSetId, 'is_quick_config');
1167 if ($is_quick_config) {
1168 foreach ($this->_values
['fee'] as $key => & $val) {
1169 if ($val['name'] == 'other_amount' && $val['html_type'] == 'Text' && !empty($params['price_' . $key])) {
1170 // Clean out any currency symbols.
1171 $params['price_' . $key] = CRM_Utils_Rule
::cleanMoney($params['price_' . $key]);
1172 if ($params['price_' . $key] != 0) {
1173 foreach ($val['options'] as $optionKey => & $options) {
1174 $options['amount'] = CRM_Utils_Array
::value('price_' . $key, $params);
1178 $params['price_' . $key] = 1;
1184 if ($this->_membershipBlock
) {
1185 $component = 'membership';
1188 CRM_Price_BAO_PriceSet
::processAmount($this->_values
['fee'], $params, $lineItem[$priceSetId], $component);
1189 if ($params['tax_amount']) {
1190 $this->set('tax_amount', $params['tax_amount']);
1193 if ($proceFieldAmount) {
1194 $lineItem[$params['priceSetId']][$fieldOption]['unit_price'] = $proceFieldAmount;
1195 $lineItem[$params['priceSetId']][$fieldOption]['line_total'] = $proceFieldAmount;
1196 if (isset($lineItem[$params['priceSetId']][$fieldOption]['tax_amount'])) {
1197 $proceFieldAmount +
= $lineItem[$params['priceSetId']][$fieldOption]['tax_amount'];
1199 if (!$this->_membershipBlock
['is_separate_payment']) {
1200 //require when separate membership not used
1201 $params['amount'] = $proceFieldAmount;
1204 $this->set('lineItem', $lineItem);
1207 if ($params['amount'] != 0 && (($this->_values
['is_pay_later'] &&
1208 empty($this->_paymentProcessor
) &&
1209 !array_key_exists('hidden_processor', $params)) ||
1210 (CRM_Utils_Array
::value('payment_processor_id', $params) == 0))
1212 $params['is_pay_later'] = 1;
1215 $params['is_pay_later'] = 0;
1218 // Would be nice to someday understand the point of this set.
1219 $this->set('is_pay_later', $params['is_pay_later']);
1220 // assign pay later stuff
1221 $this->_params
['is_pay_later'] = CRM_Utils_Array
::value('is_pay_later', $params, FALSE);
1222 $this->assign('is_pay_later', $params['is_pay_later']);
1223 if ($params['is_pay_later']) {
1224 $this->assign('pay_later_text', $this->_values
['pay_later_text']);
1225 $this->assign('pay_later_receipt', CRM_Utils_Array
::value('pay_later_receipt', $this->_values
));
1228 if ($this->_membershipBlock
['is_separate_payment'] && !empty($params['separate_amount'])) {
1229 $this->set('amount', $params['separate_amount']);
1232 $this->set('amount', $params['amount']);
1235 // generate and set an invoiceID for this transaction
1236 $invoiceID = md5(uniqid(rand(), TRUE));
1237 $this->set('invoiceID', $invoiceID);
1238 $params['invoiceID'] = $invoiceID;
1239 $params['description'] = ts('Online Contribution') . ': ' . ((!empty($this->_pcpInfo
['title']) ?
$this->_pcpInfo
['title'] : $this->_values
['title']));
1240 $params['button'] = $this->controller
->getButtonName();
1241 // required only if is_monetary and valid positive amount
1242 // @todo it seems impossible for $memFee to be greater than 0 & $params['amount'] not to
1243 // be & by requiring $memFee down here we make it harder to do a sensible refactoring of the function
1244 // above (ie. extract the amount in a small function).
1245 if ($this->_values
['is_monetary'] &&
1246 !empty($this->_paymentProcessor
) &&
1247 ((float ) $params['amount'] > 0.0 ||
$memFee > 0.0)
1249 // The concept of contributeMode is deprecated - as should be the 'is_monetary' setting.
1250 $this->setContributeMode();
1251 // Really this setting of $this->_params & params within it should be done earlier on in the function
1252 // probably the values determined here should be reused in confirm postProcess as there is no opportunity to alter anything
1253 // on the confirm page. However as we are dealing with a stable release we go as close to where it is used
1255 // In general the form has a lack of clarity of the logic of why things are set on the form in some cases &
1256 // the logic around when $this->_params is used compared to other params arrays.
1257 $this->_params
= array_merge($params, $this->_params
);
1258 $this->setRecurringMembershipParams();
1259 if ($this->_paymentProcessor
&&
1260 $this->_paymentProcessor
['object']->supports('preApproval')
1262 $this->handlePreApproval($this->_params
);
1268 * Assign the billing mode to the template.
1270 * This is required for legacy support for contributeMode in templates.
1272 * The goal is to remove this parameter & use more relevant parameters.
1274 protected function setContributeMode() {
1275 switch ($this->_paymentProcessor
['billing_mode']) {
1276 case CRM_Core_Payment
::BILLING_MODE_FORM
:
1277 $this->set('contributeMode', 'direct');
1280 case CRM_Core_Payment
::BILLING_MODE_BUTTON
:
1281 $this->set('contributeMode', 'express');
1284 case CRM_Core_Payment
::BILLING_MODE_NOTIFY
:
1285 $this->set('contributeMode', 'notify');
1292 * Process confirm function and pass browser to the thank you page.
1294 protected function skipToThankYouPage() {
1295 // call the post process hook for the main page before we switch to confirm
1296 $this->postProcessHook();
1298 // build the confirm page
1299 $confirmForm = &$this->controller
->_pages
['Confirm'];
1300 $confirmForm->preProcess();
1301 $confirmForm->buildQuickForm();
1303 // the confirmation page is valid
1304 $data = &$this->controller
->container();
1305 $data['valid']['Confirm'] = 1;
1307 // confirm the contribution
1308 // mainProcess calls the hook also
1309 $confirmForm->mainProcess();
1310 $qfKey = $this->controller
->_key
;
1312 // redirect to thank you page
1313 CRM_Utils_System
::redirect(CRM_Utils_System
::url('civicrm/contribute/transact', "_qf_ThankYou_display=1&qfKey=$qfKey", TRUE, NULL, FALSE));
1317 * Function for unit tests on the postProcess function.
1319 * @param array $params
1321 public function testSubmit($params) {
1322 $_SERVER['REQUEST_METHOD'] = 'GET';
1323 $this->controller
= new CRM_Contribute_Controller_Contribution();
1324 $this->submit($params);