3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2015 |
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-2015
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 // Make the contributionPageID available to the template
69 $this->assign('contributionPageID', $this->_id
);
70 $this->assign('isShare', CRM_Utils_Array
::value('is_share', $this->_values
));
71 $this->assign('isConfirmEnabled', CRM_Utils_Array
::value('is_confirm_enabled', $this->_values
));
73 $this->assign('reset', CRM_Utils_Request
::retrieve('reset', 'Boolean', CRM_Core_DAO
::$_nullObject));
74 $this->assign('mainDisplay', CRM_Utils_Request
::retrieve('_qf_Main_display', 'Boolean',
75 CRM_Core_DAO
::$_nullObject));
77 if (!empty($this->_pcpInfo
['id']) && !empty($this->_pcpInfo
['intro_text'])) {
78 $this->assign('intro_text', $this->_pcpInfo
['intro_text']);
80 elseif (!empty($this->_values
['intro_text'])) {
81 $this->assign('intro_text', $this->_values
['intro_text']);
84 $qParams = "reset=1&id={$this->_id}";
85 if ($pcpId = CRM_Utils_Array
::value('pcp_id', $this->_pcpInfo
)) {
86 $qParams .= "&pcpId={$pcpId}";
88 $this->assign('qParams', $qParams);
90 if (!empty($this->_values
['footer_text'])) {
91 $this->assign('footer_text', $this->_values
['footer_text']);
96 * Set the default values.
98 public function setDefaultValues() {
99 // check if the user is registered and we have a contact ID
100 $contactID = $this->getContactID();
102 if (!empty($contactID)) {
104 $removeCustomFieldTypes = array('Contribution', 'Membership');
105 $contribFields = CRM_Contribute_BAO_Contribution
::getContributionFields();
107 // remove component related fields
108 foreach ($this->_fields
as $name => $dontCare) {
109 //don't set custom data Used for Contribution (CRM-1344)
110 if (substr($name, 0, 7) == 'custom_') {
111 $id = substr($name, 7);
112 if (!CRM_Core_BAO_CustomGroup
::checkCustomField($id, $removeCustomFieldTypes)) {
115 // ignore component fields
117 elseif (array_key_exists($name, $contribFields) ||
(substr($name, 0, 11) == 'membership_') ||
(substr($name, 0, 13) == 'contribution_')) {
123 if (!empty($fields)) {
124 CRM_Core_BAO_UFGroup
::setProfileDefaults($contactID, $fields, $this->_defaults
);
127 $billingDefaults = $this->getProfileDefaults('Billing', $contactID);
128 $this->_defaults
= array_merge($this->_defaults
, $billingDefaults);
131 //set custom field defaults set by admin if value is not set
132 if (!empty($this->_fields
)) {
133 //load default campaign from page.
134 if (array_key_exists('contribution_campaign_id', $this->_fields
)) {
135 $this->_defaults
['contribution_campaign_id'] = CRM_Utils_Array
::value('campaign_id', $this->_values
);
138 //set custom field defaults
139 foreach ($this->_fields
as $name => $field) {
140 if ($customFieldID = CRM_Core_BAO_CustomField
::getKeyID($name)) {
141 if (!isset($this->_defaults
[$name])) {
142 CRM_Core_BAO_CustomField
::setProfileDefaults($customFieldID, $name, $this->_defaults
,
143 NULL, CRM_Profile_Form
::MODE_REGISTER
151 * hack to simplify credit card entry for testing
153 * $this->_defaults['credit_card_type'] = 'Visa';
154 * $this->_defaults['amount'] = 168;
155 * $this->_defaults['credit_card_number'] = '4111111111111111';
156 * $this->_defaults['cvv2'] = '000';
157 * $this->_defaults['credit_card_exp_date'] = array('Y' => date('Y')+1, 'M' => '05');
158 * // hack to simplify direct debit entry for testing
159 * $this->_defaults['account_holder'] = 'Max Müller';
160 * $this->_defaults['bank_account_number'] = '12345678';
161 * $this->_defaults['bank_identification_number'] = '12030000';
162 * $this->_defaults['bank_name'] = 'Bankname';
165 //build set default for pledge overdue payment.
166 if (!empty($this->_values
['pledge_id'])) {
167 //used to record completed pledge payment ids used later for honor default
168 $completedContributionIds = array();
169 $pledgePayments = CRM_Pledge_BAO_PledgePayment
::getPledgePayments($this->_values
['pledge_id']);
172 foreach ($pledgePayments as $payId => $value) {
173 if ($value['status'] == 'Overdue') {
174 $this->_defaults
['pledge_amount'][$payId] = 1;
176 elseif (!$duePayment && $value['status'] == 'Pending') {
177 $this->_defaults
['pledge_amount'][$payId] = 1;
180 elseif ($value['status'] == 'Completed' && $value['contribution_id']) {
181 $completedContributionIds[] = $value['contribution_id'];
185 if (count($completedContributionIds)) {
186 $softCredit = array();
187 foreach ($completedContributionIds as $id) {
188 $softCredit = CRM_Contribute_BAO_ContributionSoft
::getSoftContribution($id);
190 if (isset($softCredit['soft_credit'])) {
191 $this->_defaults
['soft_credit_type_id'] = $softCredit['soft_credit'][1]['soft_credit_type'];
193 //since honoree profile fieldname of fields are prefixed with 'honor'
194 //we need to reformat the fieldname to append prefix during setting default values
195 CRM_Core_BAO_UFGroup
::setProfileDefaults(
196 $softCredit['soft_credit'][1]['contact_id'],
197 CRM_Core_BAO_UFGroup
::getFields($this->_honoreeProfileId
),
200 foreach ($defaults as $fieldName => $value) {
201 $this->_defaults
['honor[' . $fieldName . ']'] = $value;
206 elseif (!empty($this->_values
['pledge_block_id'])) {
207 //set default to one time contribution.
208 $this->_defaults
['is_pledge'] = 0;
211 // to process Custom data that are appended to URL
212 $getDefaults = CRM_Core_BAO_CustomGroup
::extractGetParams($this, "'Contact', 'Individual', 'Contribution'");
213 $this->_defaults
= array_merge($this->_defaults
, $getDefaults);
215 $config = CRM_Core_Config
::singleton();
216 // set default country from config if no country set
217 if (empty($this->_defaults
["billing_country_id-{$this->_bltID}"])) {
218 $this->_defaults
["billing_country_id-{$this->_bltID}"] = $config->defaultContactCountry
;
221 // set default state/province from config if no state/province set
222 if (empty($this->_defaults
["billing_state_province_id-{$this->_bltID}"])) {
223 $this->_defaults
["billing_state_province_id-{$this->_bltID}"] = $config->defaultContactStateProvince
;
226 if ($this->_priceSetId
) {
227 if (($this->_useForMember
&& !empty($this->_currentMemberships
)) ||
$this->_defaultMemTypeId
) {
228 $selectedCurrentMemTypes = array();
229 foreach ($this->_priceSet
['fields'] as $key => $val) {
230 foreach ($val['options'] as $keys => $values) {
231 $opMemTypeId = CRM_Utils_Array
::value('membership_type_id', $values);
232 $priceFieldName = 'price_' . $values['price_field_id'];
233 $priceFieldValue = CRM_Price_BAO_PriceSet
::getPriceFieldValueFromURL($this, $priceFieldName);
234 if (!empty($priceFieldValue)) {
235 CRM_Price_BAO_PriceSet
::setDefaultPriceSetField($priceFieldName, $priceFieldValue, $val['html_type'], $this->_defaults
);
236 // break here to prevent overwriting of default due to 'is_default'
237 // option configuration or setting of current membership or
238 // membership for related organization.
239 // The value sent via URL get's higher priority.
242 elseif ($opMemTypeId &&
243 in_array($opMemTypeId, $this->_currentMemberships
) &&
244 !in_array($opMemTypeId, $selectedCurrentMemTypes)
246 CRM_Price_BAO_PriceSet
::setDefaultPriceSetField($priceFieldName, $keys, $val['html_type'], $this->_defaults
);
247 $selectedCurrentMemTypes[] = $values['membership_type_id'];
249 elseif (!empty($values['is_default']) &&
251 (!isset($this->_defaults
[$priceFieldName]) ||
252 ($val['html_type'] == 'CheckBox' &&
253 !isset($this->_defaults
[$priceFieldName][$keys]))
255 CRM_Price_BAO_PriceSet
::setDefaultPriceSetField($priceFieldName, $keys, $val['html_type'], $this->_defaults
);
261 CRM_Price_BAO_PriceSet
::setDefaultPriceSet($this, $this->_defaults
);
265 if (!empty($this->_paymentProcessors
)) {
266 foreach ($this->_paymentProcessors
as $pid => $value) {
267 if (!empty($value['is_default'])) {
268 $this->_defaults
['payment_processor_id'] = $pid;
273 return $this->_defaults
;
277 * Build the form object.
279 public function buildQuickForm() {
280 // build profiles first so that we can determine address fields etc
281 // and then show copy address checkbox
282 $this->buildCustom($this->_values
['custom_pre_id'], 'customPre');
283 $this->buildCustom($this->_values
['custom_post_id'], 'customPost');
285 $this->buildComponentForm($this->_id
, $this);
287 if (!empty($this->_fields
) && !empty($this->_values
['custom_pre_id'])) {
288 $profileAddressFields = array();
289 foreach ($this->_fields
as $key => $value) {
290 CRM_Core_BAO_UFField
::assignAddressField($key, $profileAddressFields, array('uf_group_id' => $this->_values
['custom_pre_id']));
292 $this->set('profileAddressFields', $profileAddressFields);
295 // Build payment processor form
296 CRM_Core_Payment_ProcessorForm
::buildQuickForm($this);
298 $config = CRM_Core_Config
::singleton();
300 $contactID = $this->getContactID();
302 $this->assign('contact_id', $contactID);
303 $this->assign('display_name', CRM_Contact_BAO_Contact
::displayName($contactID));
306 $this->applyFilter('__ALL__', 'trim');
307 $this->add('text', "email-{$this->_bltID}",
309 array('size' => 30, 'maxlength' => 60, 'class' => 'email'),
312 $this->addRule("email-{$this->_bltID}", ts('Email is not valid.'), 'email');
314 //@todo - this should be replaced by a check as to whether billing fields are set
315 $onlinePaymentProcessorEnabled = FALSE;
316 if (!empty($this->_paymentProcessors
)) {
317 foreach ($this->_paymentProcessors
as $key => $name) {
318 if ($name['billing_mode'] == 1) {
319 $onlinePaymentProcessorEnabled = TRUE;
321 $pps[$key] = $name['name'];
324 if (!empty($this->_values
['is_pay_later'])) {
325 $pps[0] = $this->_values
['pay_later_text'];
328 if (count($pps) > 1) {
329 $this->addRadio('payment_processor_id', ts('Payment Method'), $pps,
333 elseif (!empty($pps)) {
334 $key = array_keys($pps);
335 $key = array_pop($key);
336 $this->addElement('hidden', 'payment_processor_id', $key);
338 $this->assign('is_pay_later', $this->_values
['is_pay_later']);
339 $this->assign('pay_later_text', $this->_values
['pay_later_text']);
343 $contactID = $this->getContactID();
344 if ($this->getContactID() === 0) {
345 $this->addCidZeroOptions($onlinePaymentProcessorEnabled);
348 //build pledge block.
349 $this->_useForMember
= 0;
350 //don't build membership block when pledge_id is passed
351 if (empty($this->_values
['pledge_id'])) {
352 $this->_separateMembershipPayment
= FALSE;
353 if (in_array('CiviMember', $config->enableComponents
)) {
355 if ($this->_action
& CRM_Core_Action
::PREVIEW
) {
359 if ($this->_priceSetId
&&
360 (CRM_Core_Component
::getComponentID('CiviMember') == CRM_Utils_Array
::value('extends', $this->_priceSet
))
362 $this->_useForMember
= 1;
363 $this->set('useForMember', $this->_useForMember
);
366 $this->_separateMembershipPayment
= $this->buildMembershipBlock(
367 $this->_membershipContactID
,
372 $this->set('separateMembershipPayment', $this->_separateMembershipPayment
);
374 $this->assign('useForMember', $this->_useForMember
);
375 // If we configured price set for contribution page
376 // we are not allow membership signup as well as any
377 // other contribution amount field, CRM-5095
378 if (isset($this->_priceSetId
) && $this->_priceSetId
) {
379 $this->add('hidden', 'priceSetId', $this->_priceSetId
);
380 // build price set form.
381 $this->set('priceSetId', $this->_priceSetId
);
382 CRM_Price_BAO_PriceSet
::buildPriceSet($this);
383 if ($this->_values
['is_monetary'] &&
384 $this->_values
['is_recur'] && empty($this->_values
['pledge_id'])
386 self
::buildRecur($this);
390 if ($this->_priceSetId
) {
391 $is_quick_config = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet', $this->_priceSetId
, 'is_quick_config');
392 if ($is_quick_config) {
393 $this->_useForMember
= 0;
394 $this->set('useForMember', $this->_useForMember
);
398 //we allow premium for pledge during pledge creation only.
399 if (empty($this->_values
['pledge_id'])) {
400 CRM_Contribute_BAO_Premium
::buildPremiumBlock($this, $this->_id
, TRUE);
403 //don't build pledge block when mid is passed
405 $config = CRM_Core_Config
::singleton();
406 if (in_array('CiviPledge', $config->enableComponents
) && !empty($this->_values
['pledge_block_id'])) {
407 CRM_Pledge_BAO_PledgeBlock
::buildPledgeBlock($this);
411 //to create an cms user
412 if (!$this->_contactID
) {
413 $createCMSUser = FALSE;
415 if ($this->_values
['custom_pre_id']) {
416 $profileID = $this->_values
['custom_pre_id'];
417 $createCMSUser = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_UFGroup', $profileID, 'is_cms_user');
420 if (!$createCMSUser &&
421 $this->_values
['custom_post_id']
423 if (!is_array($this->_values
['custom_post_id'])) {
424 $profileIDs = array($this->_values
['custom_post_id']);
427 $profileIDs = $this->_values
['custom_post_id'];
429 foreach ($profileIDs as $pid) {
430 if (CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_UFGroup', $pid, 'is_cms_user')) {
432 $createCMSUser = TRUE;
438 if ($createCMSUser) {
439 CRM_Core_BAO_CMSUser
::buildForm($this, $profileID, TRUE);
443 if ($pcpSupporter = CRM_PCP_BAO_PCP
::displayName($this->_pcpId
)) {
444 $pcp_supporter_text = ts('This contribution is being made thanks to the effort of <strong>%1</strong>, who supports our campaign.', array(1 => $pcpSupporter));
445 // 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.
446 $text = CRM_PCP_BAO_PCP
::getPcpBlockStatus($this->_id
, 'contribute');
448 $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!");
450 $this->assign('pcpSupporterText', $pcp_supporter_text);
452 $prms = array('id' => $this->_pcpId
);
453 CRM_Core_DAO
::commonRetrieve('CRM_PCP_DAO_PCP', $prms, $pcpInfo);
454 if ($pcpInfo['is_honor_roll']) {
455 $this->assign('isHonor', TRUE);
456 $this->add('checkbox', 'pcp_display_in_roll', ts('Show my contribution in the public honor roll'), NULL, NULL,
457 array('onclick' => "showHideByValue('pcp_display_in_roll','','nameID|nickID|personalNoteID','block','radio',false); pcpAnonymous( );")
459 $extraOption = array('onclick' => "return pcpAnonymous( );");
461 $elements[] = &$this->createElement('radio', NULL, '', ts('Include my name and message'), 0, $extraOption);
462 $elements[] = &$this->createElement('radio', NULL, '', ts('List my contribution anonymously'), 1, $extraOption);
463 $this->addGroup($elements, 'pcp_is_anonymous', NULL, ' ');
465 $this->add('text', 'pcp_roll_nickname', ts('Name'), array('maxlength' => 30));
466 $this->add('textarea', 'pcp_personal_note', ts('Personal Note'), array('style' => 'height: 3em; width: 40em;'));
470 //we have to load confirm contribution button in template
471 //when multiple payment processor as the user
472 //can toggle with payment processor selection
473 $billingModePaymentProcessors = 0;
474 if (!empty($this->_paymentProcessors
)) {
475 foreach ($this->_paymentProcessors
as $key => $values) {
476 if ($values['billing_mode'] == CRM_Core_Payment
::BILLING_MODE_BUTTON
) {
477 $billingModePaymentProcessors++
;
482 if ($billingModePaymentProcessors && count($this->_paymentProcessors
) == $billingModePaymentProcessors) {
483 $allAreBillingModeProcessors = TRUE;
486 $allAreBillingModeProcessors = FALSE;
489 if (!($allAreBillingModeProcessors && !$this->_values
['is_pay_later'])) {
490 $submitButton = array(
492 'name' => CRM_Utils_Array
::value('is_confirm_enabled', $this->_values
) ?
ts('Review Contribution') : ts('Contribute'),
493 'spacing' => ' ',
496 // Add submit-once behavior when confirm page disabled
497 if (empty($this->_values
['is_confirm_enabled'])) {
498 $submitButton['js'] = array('onclick' => "return submitOnce(this,'" . $this->_name
. "','" . ts('Processing') . "');");
500 $this->addButtons(array($submitButton));
503 $this->addFormRule(array('CRM_Contribute_Form_Contribution_Main', 'formRule'), $this);
507 * Build elements to collect information for recurring contributions.
510 * @param CRM_Core_Form $form
512 public static function buildRecur(&$form) {
513 $attributes = CRM_Core_DAO
::getAttribute('CRM_Contribute_DAO_ContributionRecur');
514 $className = get_class($form);
516 $form->assign('is_recur_interval', CRM_Utils_Array
::value('is_recur_interval', $form->_values
));
517 $form->assign('is_recur_installments', CRM_Utils_Array
::value('is_recur_installments', $form->_values
));
519 $form->add('checkbox', 'is_recur', ts('I want to contribute this amount'), NULL);
521 if (!empty($form->_values
['is_recur_interval']) ||
$className == 'CRM_Contribute_Form_Contribution') {
522 $form->add('text', 'frequency_interval', ts('Every'), $attributes['frequency_interval']);
523 $form->addRule('frequency_interval', ts('Frequency must be a whole number (EXAMPLE: Every 3 months).'), 'integer');
526 // make sure frequency_interval is submitted as 1 if given no choice to user.
527 $form->add('hidden', 'frequency_interval', 1);
530 $frUnits = CRM_Utils_Array
::value('recur_frequency_unit', $form->_values
);
531 if (empty($frUnits) &&
532 $className == 'CRM_Contribute_Form_Contribution'
534 $frUnits = implode(CRM_Core_DAO
::VALUE_SEPARATOR
,
535 CRM_Core_OptionGroup
::values('recur_frequency_units')
539 $unitVals = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $frUnits);
541 // CRM 10860, display text instead of a dropdown if there's only 1 frequency unit
542 if (count($unitVals) == 1) {
543 $form->assign('one_frequency_unit', TRUE);
544 $unit = $unitVals[0];
545 $form->add('hidden', 'frequency_unit', $unit);
546 if (!empty($form->_values
['is_recur_interval']) ||
$className == 'CRM_Contribute_Form_Contribution') {
549 $form->assign('frequency_unit', $unit);
552 $form->assign('one_frequency_unit', FALSE);
554 $frequencyUnits = CRM_Core_OptionGroup
::values('recur_frequency_units', FALSE, FALSE, TRUE);
555 foreach ($unitVals as $key => $val) {
556 if (array_key_exists($val, $frequencyUnits)) {
557 $units[$val] = $frequencyUnits[$val];
558 if (!empty($form->_values
['is_recur_interval']) ||
$className == 'CRM_Contribute_Form_Contribution') {
559 $units[$val] = "{$frequencyUnits[$val]}(s)";
563 $frequencyUnit = &$form->add('select', 'frequency_unit', NULL, $units);
566 // FIXME: Ideally we should freeze select box if there is only
567 // one option but looks there is some problem /w QF freeze.
568 //if ( count( $units ) == 1 ) {
569 //$frequencyUnit->freeze( );
572 $form->add('text', 'installments', ts('installments'),
573 $attributes['installments']
575 $form->addRule('installments', ts('Number of installments must be a whole number.'), 'integer');
581 * @param array $fields
582 * The input form values.
583 * @param array $files
584 * The uploaded files if any.
585 * @param CRM_Core_Form $self
588 * true if no errors, else array of errors
590 public static function formRule($fields, $files, $self) {
592 $amount = self
::computeAmount($fields, $self->_values
);
594 if ((!empty($fields['selectMembership']) &&
595 $fields['selectMembership'] != 'no_thanks'
597 (!empty($fields['priceSetId']) &&
601 $lifeMember = CRM_Member_BAO_Membership
::getAllContactMembership($self->_membershipContactID
, FALSE, TRUE);
603 $membershipOrgDetails = CRM_Member_BAO_MembershipType
::getMembershipTypeOrganization();
605 $unallowedOrgs = array();
606 foreach (array_keys($lifeMember) as $memTypeId) {
607 $unallowedOrgs[] = $membershipOrgDetails[$memTypeId];
611 //check for atleast one pricefields should be selected
612 if (!empty($fields['priceSetId'])) {
613 $priceField = new CRM_Price_DAO_PriceField();
614 $priceField->price_set_id
= $fields['priceSetId'];
615 $priceField->orderBy('weight');
619 $membershipIsActive = TRUE;
620 $previousId = $otherAmount = FALSE;
621 while ($priceField->fetch()) {
623 if ($self->_quickConfig
&& ($priceField->name
== 'contribution_amount' ||
$priceField->name
== 'membership_amount')) {
624 $previousId = $priceField->id
;
625 if ($priceField->name
== 'membership_amount' && !$priceField->is_active
) {
626 $membershipIsActive = FALSE;
629 if ($priceField->name
== 'other_amount') {
630 if ($self->_quickConfig
&& empty($fields["price_{$priceField->id}"]) &&
631 array_key_exists("price_{$previousId}", $fields) && isset($fields["price_{$previousId}"]) && $self->_values
['fee'][$previousId]['name'] == 'contribution_amount' && empty($fields["price_{$previousId}"])
633 $otherAmount = $priceField->id
;
635 elseif (!empty($fields["price_{$priceField->id}"])) {
636 $otherAmountVal = CRM_Utils_Rule
::cleanMoney($fields["price_{$priceField->id}"]);
637 $min = CRM_Utils_Array
::value('min_amount', $self->_values
);
638 $max = CRM_Utils_Array
::value('max_amount', $self->_values
);
639 if ($min && $otherAmountVal < $min) {
640 $errors["price_{$priceField->id}"] = ts('Contribution amount must be at least %1',
644 if ($max && $otherAmountVal > $max) {
645 $errors["price_{$priceField->id}"] = ts('Contribution amount cannot be more than %1.',
651 if (!empty($fields["price_{$priceField->id}"]) ||
($previousId == $priceField->id
&& isset($fields["price_{$previousId}"])
652 && empty($fields["price_{$previousId}"]))
654 $check[] = $priceField->id
;
658 $currentMemberships = NULL;
659 if ($membershipIsActive) {
660 $is_test = $self->_mode
!= 'live' ?
1 : 0;
661 $memContactID = $self->_membershipContactID
;
663 // For anonymous user check using dedupe rule
664 // if user has Cancelled Membership
665 if (!$memContactID) {
666 $dedupeParams = CRM_Dedupe_Finder
::formatParams($fields, 'Individual');
667 $dedupeParams['check_permission'] = FALSE;
668 $ids = CRM_Dedupe_Finder
::dupesByParams($dedupeParams, 'Individual');
669 // if we find more than one contact, use the first one
670 $memContactID = CRM_Utils_Array
::value(0, $ids);
672 $currentMemberships = CRM_Member_BAO_Membership
::getContactsCancelledMembership($memContactID,
676 $errorText = 'Your %1 membership was previously cancelled and can not be renewed online. Please contact the site administrator for assistance.';
677 foreach ($self->_values
['fee'] as $fieldKey => $fieldValue) {
678 if ($fieldValue['html_type'] != 'Text' && CRM_Utils_Array
::value('price_' . $fieldKey, $fields)) {
679 if (!is_array($fields['price_' . $fieldKey])) {
680 if (array_key_exists('membership_type_id', $fieldValue['options'][$fields['price_' . $fieldKey]])
681 && in_array($fieldValue['options'][$fields['price_' . $fieldKey]]['membership_type_id'], $currentMemberships)
683 $errors['price_' . $fieldKey] = ts($errorText, array(1 => CRM_Member_PseudoConstant
::membershipType($fieldValue['options'][$fields['price_' . $fieldKey]]['membership_type_id'])));
687 foreach ($fields['price_' . $fieldKey] as $key => $ignore) {
688 if (array_key_exists('membership_type_id', $fieldValue['options'][$key])
689 && in_array($fieldValue['options'][$key]['membership_type_id'], $currentMemberships)
691 $errors['price_' . $fieldKey] = ts($errorText, array(1 => CRM_Member_PseudoConstant
::membershipType($fieldValue['options'][$key]['membership_type_id'])));
700 if ($membershipIsActive && !$self->_membershipBlock
['is_required']
701 && $self->_values
['amount_block_is_active']
703 $membershipFieldId = $contributionFieldId = $errorKey = $otherFieldId = NULL;
704 foreach ($self->_values
['fee'] as $fieldKey => $fieldValue) {
705 // if 'No thank you' membership is selected then set $membershipFieldId
706 if ($fieldValue['name'] == 'membership_amount' && CRM_Utils_Array
::value('price_' . $fieldKey, $fields) == 0) {
707 $membershipFieldId = $fieldKey;
709 elseif ($membershipFieldId) {
710 if ($fieldValue['name'] == 'other_amount') {
711 $otherFieldId = $fieldKey;
713 elseif ($fieldValue['name'] == 'contribution_amount') {
714 $contributionFieldId = $fieldKey;
717 if (!$errorKey || CRM_Utils_Array
::value('price_' . $contributionFieldId, $fields) == '0') {
718 $errorKey = $fieldKey;
722 // $membershipFieldId is set and additional amount is 'No thank you' or NULL then throw error
723 if ($membershipFieldId && !(CRM_Utils_Array
::value('price_' . $contributionFieldId, $fields, -1) > 0) && empty($fields['price_' . $otherFieldId])) {
724 $errors["price_{$errorKey}"] = ts('Additional Contribution is required.');
728 if ($self->_useForMember
== 1 && $membershipIsActive) {
729 $errors['_qf_default'] = ts('Select at least one option from Membership Type(s).');
732 $errors['_qf_default'] = ts('Select at least one option from Contribution(s).');
735 if ($otherAmount && !empty($check)) {
736 $errors["price_{$otherAmount}"] = ts('Amount is required field.');
739 if ($self->_useForMember
== 1 && !empty($check) && $membershipIsActive) {
740 $priceFieldIDS = array();
741 $priceFieldMemTypes = array();
743 foreach ($self->_priceSet
['fields'] as $priceId => $value) {
744 if (!empty($fields['price_' . $priceId]) ||
($self->_quickConfig
&& $value['name'] == 'membership_amount' && empty($self->_membershipBlock
['is_required']))) {
745 if (!empty($fields['price_' . $priceId]) && is_array($fields['price_' . $priceId])) {
746 foreach ($fields['price_' . $priceId] as $priceFldVal => $isSet) {
748 $priceFieldIDS[] = $priceFldVal;
752 elseif (!$value['is_enter_qty'] && !empty($fields['price_' . $priceId])) {
753 // The check for {!$value['is_enter_qty']} is done since, quantity fields allow entering
754 // quantity. And the quantity can't be conisdered as civicrm_price_field_value.id, CRM-9577
755 $priceFieldIDS[] = $fields['price_' . $priceId];
758 if (!empty($value['options'])) {
759 foreach ($value['options'] as $val) {
760 if (!empty($val['membership_type_id']) && (
761 ($fields['price_' . $priceId] == $val['id']) ||
762 (isset($fields['price_' . $priceId]) && !empty($fields['price_' . $priceId][$val['id']]))
765 $priceFieldMemTypes[] = $val['membership_type_id'];
772 if (!empty($lifeMember)) {
773 foreach ($priceFieldIDS as $priceFieldId) {
774 if (($id = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceFieldValue', $priceFieldId, 'membership_type_id')) &&
775 in_array($membershipOrgDetails[$id], $unallowedOrgs)
777 $errors['_qf_default'] = ts('You already have a lifetime membership and cannot select a membership with a shorter term.');
783 if (!empty($priceFieldIDS)) {
784 $ids = implode(',', $priceFieldIDS);
786 $priceFieldIDS['id'] = $fields['priceSetId'];
787 $self->set('memberPriceFieldIDS', $priceFieldIDS);
788 $count = CRM_Price_BAO_PriceSet
::getMembershipCount($ids);
789 foreach ($count as $id => $occurrence) {
790 if ($occurrence > 1) {
791 $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.');
796 if (empty($priceFieldMemTypes)) {
797 $errors['_qf_default'] = ts('Please select at least one membership option.');
801 CRM_Price_BAO_PriceSet
::processAmount($self->_values
['fee'],
805 if ($fields['amount'] < 0) {
806 $errors['_qf_default'] = ts('Contribution can not be less than zero. Please select the options accordingly');
808 $amount = $fields['amount'];
811 if (isset($fields['selectProduct']) &&
812 $fields['selectProduct'] != 'no_thanks'
814 $productDAO = new CRM_Contribute_DAO_Product();
815 $productDAO->id
= $fields['selectProduct'];
816 $productDAO->find(TRUE);
817 $min_amount = $productDAO->min_contribution
;
819 if ($amount < $min_amount) {
820 $errors['selectProduct'] = ts('The premium you have selected requires a minimum contribution of %1', array(1 => CRM_Utils_Money
::format($min_amount)));
821 CRM_Core_Session
::setStatus($errors['selectProduct']);
825 //CRM-16285 - Function to handle validation errors on form, for recurring contribution field.
826 CRM_Contribute_BAO_ContributionRecur
::validateRecurContribution($fields, $files, $self, $errors);
828 if (!empty($fields['is_recur']) &&
829 CRM_Utils_Array
::value('payment_processor_id', $fields) == 0
831 $errors['_qf_default'] = ts('You cannot set up a recurring contribution if you are not paying online by credit card.');
834 // validate PCP fields - if not anonymous, we need a nick name value
835 if ($self->_pcpId
&& !empty($fields['pcp_display_in_roll']) &&
836 (CRM_Utils_Array
::value('pcp_is_anonymous', $fields) == 0) &&
837 CRM_Utils_Array
::value('pcp_roll_nickname', $fields) == ''
839 $errors['pcp_roll_nickname'] = ts('Please enter a name to include in the Honor Roll, or select \'contribute anonymously\'.');
842 // return if this is express mode
843 $config = CRM_Core_Config
::singleton();
844 if ($self->_paymentProcessor
&&
845 $self->_paymentProcessor
['billing_mode'] & CRM_Core_Payment
::BILLING_MODE_BUTTON
847 if (!empty($fields[$self->_expressButtonName
. '_x']) ||
!empty($fields[$self->_expressButtonName
. '_y']) ||
848 CRM_Utils_Array
::value($self->_expressButtonName
, $fields)
854 //validate the pledge fields.
855 if (!empty($self->_values
['pledge_block_id'])) {
856 //validation for pledge payment.
857 if (!empty($self->_values
['pledge_id'])) {
858 if (empty($fields['pledge_amount'])) {
859 $errors['pledge_amount'] = ts('At least one payment option needs to be checked.');
862 elseif (!empty($fields['is_pledge'])) {
863 if (CRM_Utils_Rule
::positiveInteger(CRM_Utils_Array
::value('pledge_installments', $fields)) == FALSE) {
864 $errors['pledge_installments'] = ts('Please enter a valid number of pledge installments.');
867 if (CRM_Utils_Array
::value('pledge_installments', $fields) == NULL) {
868 $errors['pledge_installments'] = ts('Pledge Installments is required field.');
870 elseif (CRM_Utils_array
::value('pledge_installments', $fields) == 1) {
871 $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.');
873 elseif (CRM_Utils_array
::value('pledge_installments', $fields) == 0) {
874 $errors['pledge_installments'] = ts('Pledge Installments field must be > 1.');
878 //validation for Pledge Frequency Interval.
879 if (CRM_Utils_Rule
::positiveInteger(CRM_Utils_Array
::value('pledge_frequency_interval', $fields)) == FALSE) {
880 $errors['pledge_frequency_interval'] = ts('Please enter a valid Pledge Frequency Interval.');
883 if (CRM_Utils_Array
::value('pledge_frequency_interval', $fields) == NULL) {
884 $errors['pledge_frequency_interval'] = ts('Pledge Frequency Interval. is required field.');
886 elseif (CRM_Utils_array
::value('pledge_frequency_interval', $fields) == 0) {
887 $errors['pledge_frequency_interval'] = ts('Pledge frequency interval field must be > 0');
893 // also return if paylater mode
894 if (CRM_Utils_Array
::value('payment_processor_id', $fields) == 0 && $self->_isBillingAddressRequiredForPayLater
== 0) {
895 return empty($errors) ?
TRUE : $errors;
898 // if the user has chosen a free membership or the amount is less than zero
899 // i.e. we skip calling the payment processor and hence dont need credit card
901 if ((float) $amount <= 0.0) {
905 if (!empty($self->_paymentFields
)) {
906 CRM_Core_Form
::validateMandatoryFields($self->_paymentFields
, $fields, $errors);
908 CRM_Core_Payment_Form
::validatePaymentInstrument($fields['payment_processor_id'], $fields, $errors, $self);
910 foreach (CRM_Contact_BAO_Contact
::$_greetingTypes as $greeting) {
911 if ($greetingType = CRM_Utils_Array
::value($greeting, $fields)) {
912 $customizedValue = CRM_Core_OptionGroup
::getValue($greeting, 'Customized', 'name');
913 if ($customizedValue == $greetingType && empty($fielse[$greeting . '_custom'])) {
914 $errors[$greeting . '_custom'] = ts('Custom %1 is a required field if %1 is of type Customized.',
915 array(1 => ucwords(str_replace('_', " ", $greeting)))
921 return empty($errors) ?
TRUE : $errors;
925 * Compute amount to be paid.
927 * @param array $params
928 * @param array $formValues
930 * @return int|mixed|null|string
932 public static function computeAmount($params, $formValues) {
934 // First clean up the other amount field if present.
935 if (isset($params['amount_other'])) {
936 $params['amount_other'] = CRM_Utils_Rule
::cleanMoney($params['amount_other']);
939 if (CRM_Utils_Array
::value('amount', $params) == 'amount_other_radio' ||
!empty($params['amount_other'])) {
940 $amount = $params['amount_other'];
942 elseif (!empty($params['pledge_amount'])) {
943 foreach ($params['pledge_amount'] as $paymentId => $dontCare) {
944 $amount +
= CRM_Core_DAO
::getFieldValue('CRM_Pledge_DAO_PledgePayment', $paymentId, 'scheduled_amount');
948 if (!empty($formValues['amount'])) {
949 $amountID = CRM_Utils_Array
::value('amount', $params);
952 $params['amount_level'] = CRM_Utils_Array
::value('label', $formValues[$amountID]);
953 $amount = CRM_Utils_Array
::value('value', $formValues[$amountID]);
961 * Process the form submission.
963 public function postProcess() {
964 $config = CRM_Core_Config
::singleton();
965 // we first reset the confirm page so it accepts new values
966 $this->controller
->resetPage('Confirm');
968 // get the submitted form values.
969 $params = $this->controller
->exportValues($this->_name
);
971 //carry campaign from profile.
972 if (array_key_exists('contribution_campaign_id', $params)) {
973 $params['campaign_id'] = $params['contribution_campaign_id'];
976 $params['currencyID'] = $config->defaultCurrency
;
978 if (!empty($params['priceSetId'])) {
979 $is_quick_config = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet', $this->_priceSetId
, 'is_quick_config');
980 if ($is_quick_config) {
981 $priceField = new CRM_Price_DAO_PriceField();
982 $priceField->price_set_id
= $params['priceSetId'];
983 $priceField->orderBy('weight');
986 $priceOptions = array();
987 while ($priceField->fetch()) {
988 CRM_Price_BAO_PriceFieldValue
::getValues($priceField->id
, $priceOptions);
989 if ($selectedPriceOptionID = CRM_Utils_Array
::value("price_{$priceField->id}", $params)) {
990 switch ($priceField->name
) {
991 case 'membership_amount':
992 $this->_params
['selectMembership'] = $params['selectMembership'] = CRM_Utils_Array
::value('membership_type_id', $priceOptions[$selectedPriceOptionID]);
993 $this->set('selectMembership', $params['selectMembership']);
994 if (CRM_Utils_Array
::value('is_separate_payment', $this->_membershipBlock
) == 0) {
995 $this->_values
['amount'] = CRM_Utils_Array
::value('amount', $priceOptions[$selectedPriceOptionID]);
999 case 'contribution_amount':
1000 $params['amount'] = $selectedPriceOptionID;
1001 $this->_values
['amount'] = CRM_Utils_Array
::value('amount', $priceOptions[$selectedPriceOptionID]);
1002 $this->_values
[$selectedPriceOptionID]['value'] = CRM_Utils_Array
::value('amount', $priceOptions[$selectedPriceOptionID]);
1003 $this->_values
[$selectedPriceOptionID]['label'] = CRM_Utils_Array
::value('label', $priceOptions[$selectedPriceOptionID]);
1004 $this->_values
[$selectedPriceOptionID]['amount_id'] = CRM_Utils_Array
::value('id', $priceOptions[$selectedPriceOptionID]);
1005 $this->_values
[$selectedPriceOptionID]['weight'] = CRM_Utils_Array
::value('weight', $priceOptions[$selectedPriceOptionID]);
1008 case 'other_amount':
1009 $params['amount_other'] = $selectedPriceOptionID;
1017 if (($this->_values
['is_pay_later'] &&
1018 empty($this->_paymentProcessor
) &&
1019 !array_key_exists('hidden_processor', $params)) ||
1020 (!empty($params['payment_processor_id']) && $params['payment_processor_id'] == 0)
1022 $params['is_pay_later'] = 1;
1025 $params['is_pay_later'] = 0;
1028 $this->set('is_pay_later', $params['is_pay_later']);
1029 // assign pay later stuff
1030 $this->_params
['is_pay_later'] = CRM_Utils_Array
::value('is_pay_later', $params, FALSE);
1031 $this->assign('is_pay_later', $params['is_pay_later']);
1032 if ($params['is_pay_later']) {
1033 $this->assign('pay_later_text', $this->_values
['pay_later_text']);
1034 $this->assign('pay_later_receipt', $this->_values
['pay_later_receipt']);
1037 // from here on down, $params['amount'] holds a monetary value (or null) rather than an option ID
1038 $params['amount'] = self
::computeAmount($params, $this->_values
);
1039 $params['separate_amount'] = $params['amount'];
1041 if (!empty($params['selectMembership'])) {
1042 if (!empty($this->_membershipTypeValues
)) {
1043 $membershipTypeValues = $this->_membershipTypeValues
[$params['selectMembership']];
1046 $membershipTypeValues = CRM_Member_BAO_Membership
::buildMembershipTypeValues($this,
1047 (array) $params['selectMembership']
1050 $memFee = $membershipTypeValues['minimum_fee'];
1051 if (!$params['amount'] && !$this->_separateMembershipPayment
) {
1052 $params['amount'] = $memFee ?
$memFee : 0;
1055 //If the membership & contribution is used in contribution page & not separate payment
1056 $fieldId = $memPresent = $membershipLabel = $fieldOption = $is_quick_config = NULL;
1057 $proceFieldAmount = 0;
1058 if (property_exists($this, '_separateMembershipPayment') && $this->_separateMembershipPayment
== 0) {
1059 $is_quick_config = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet', $this->_priceSetId
, 'is_quick_config');
1060 if ($is_quick_config) {
1061 foreach ($this->_priceSet
['fields'] as $fieldKey => $fieldVal) {
1062 if ($fieldVal['name'] == 'membership_amount' && !empty($params['price_' . $fieldKey])) {
1063 $fieldId = $fieldVal['id'];
1064 $fieldOption = $params['price_' . $fieldId];
1065 $proceFieldAmount +
= $fieldVal['options'][$this->_submitValues
['price_' . $fieldId]]['amount'];
1069 if (!empty($params['price_' . $fieldKey]) && $memPresent && ($fieldVal['name'] == 'other_amount' ||
$fieldVal['name'] == 'contribution_amount')) {
1070 $fieldId = $fieldVal['id'];
1071 if ($fieldVal['name'] == 'other_amount') {
1072 $proceFieldAmount +
= $this->_submitValues
['price_' . $fieldId];
1074 elseif ($fieldVal['name'] == 'contribution_amount' && $this->_submitValues
['price_' . $fieldId] > 0) {
1075 $proceFieldAmount +
= $fieldVal['options'][$this->_submitValues
['price_' . $fieldId]]['amount'];
1077 unset($params['price_' . $fieldId]);
1085 if (!isset($params['amount_other'])) {
1086 $this->set('amount_level', CRM_Utils_Array
::value('amount_level', $params));
1089 if ($priceSetId = CRM_Utils_Array
::value('priceSetId', $params)) {
1090 $lineItem = array();
1091 $is_quick_config = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet', $priceSetId, 'is_quick_config');
1092 if ($is_quick_config) {
1093 foreach ($this->_values
['fee'] as $key => & $val) {
1094 if ($val['name'] == 'other_amount' && $val['html_type'] == 'Text' && !empty($params['price_' . $key])) {
1095 // Clean out any currency symbols.
1096 $params['price_' . $key] = CRM_Utils_Rule
::cleanMoney($params['price_' . $key]);
1097 if ($params['price_' . $key] != 0) {
1098 foreach ($val['options'] as $optionKey => & $options) {
1099 $options['amount'] = CRM_Utils_Array
::value('price_' . $key, $params);
1103 $params['price_' . $key] = 1;
1109 if ($this->_membershipBlock
) {
1110 $component = 'membership';
1113 CRM_Price_BAO_PriceSet
::processAmount($this->_values
['fee'], $params, $lineItem[$priceSetId], $component);
1114 if ($params['tax_amount']) {
1115 $this->set('tax_amount', $params['tax_amount']);
1118 if ($proceFieldAmount) {
1119 $lineItem[$params['priceSetId']][$fieldOption]['unit_price'] = $proceFieldAmount;
1120 $lineItem[$params['priceSetId']][$fieldOption]['line_total'] = $proceFieldAmount;
1121 if (isset($lineItem[$params['priceSetId']][$fieldOption]['tax_amount'])) {
1122 $proceFieldAmount +
= $lineItem[$params['priceSetId']][$fieldOption]['tax_amount'];
1124 if (!$this->_membershipBlock
['is_separate_payment']) {
1125 //require when separate membership not used
1126 $params['amount'] = $proceFieldAmount;
1129 $this->set('lineItem', $lineItem);
1132 if ($this->_membershipBlock
['is_separate_payment'] && !empty($params['separate_amount'])) {
1133 $this->set('amount', $params['separate_amount']);
1136 $this->set('amount', $params['amount']);
1139 // generate and set an invoiceID for this transaction
1140 $invoiceID = md5(uniqid(rand(), TRUE));
1141 $this->set('invoiceID', $invoiceID);
1142 $params['invoiceID'] = $invoiceID;
1143 $params['description'] = ts('Online Contribution') . ': ' . (($this->_pcpInfo
['title']) ?
$this->_pcpInfo
['title'] : $this->_values
['title']);
1144 $params['button'] = $this->controller
->getButtonName();
1145 // required only if is_monetary and valid positive amount
1146 if ($this->_values
['is_monetary'] &&
1147 is_array($this->_paymentProcessor
) &&
1148 ((float ) $params['amount'] > 0.0 ||
$memFee > 0.0)
1150 $this->setContributeMode();
1151 // Really this setting of $this->_params & params within it should be done earlier on in the function
1152 // probably the values determined here should be reused in confirm postProcess as there is no opportunity to alter anything
1153 // on the confirm page. However as we are dealing with a stable release we go as close to where it is used
1155 // In general the form has a lack of clarity of the logic of why things are set on the form in some cases &
1156 // the logic around when $this->_params is used compared to other params arrays.
1157 $this->_params
= array_merge($params, $this->_params
);
1158 $this->setRecurringMembershipParams();
1159 if ($this->_paymentProcessor
&&
1160 $this->_paymentProcessor
['object']->supports('preApproval')
1162 $this->handlePreApproval($this->_params
);
1166 if (empty($this->_values
['is_confirm_enabled'])) {
1167 $this->skipToThankYouPage();
1173 * Assign the billing mode to the template.
1175 * This is required for legacy support for contributeMode in templates.
1177 * The goal is to remove this parameter & use more relevant parameters.
1179 protected function setContributeMode() {
1180 switch ($this->_paymentProcessor
['billing_mode']) {
1181 case CRM_Core_Payment
::BILLING_MODE_FORM
:
1182 $this->set('contributeMode', 'direct');
1185 case CRM_Core_Payment
::BILLING_MODE_BUTTON
:
1186 $this->set('contributeMode', 'express');
1189 case CRM_Core_Payment
::BILLING_MODE_NOTIFY
:
1190 $this->set('contributeMode', 'notify');
1197 * Process confirm function and pass browser to the thank you page.
1199 protected function skipToThankYouPage() {
1200 // call the post process hook for the main page before we switch to confirm
1201 $this->postProcessHook();
1203 // build the confirm page
1204 $confirmForm = &$this->controller
->_pages
['Confirm'];
1205 $confirmForm->preProcess();
1206 $confirmForm->buildQuickForm();
1208 // the confirmation page is valid
1209 $data = &$this->controller
->container();
1210 $data['valid']['Confirm'] = 1;
1212 // confirm the contribution
1213 // mainProcess calls the hook also
1214 $confirmForm->mainProcess();
1215 $qfKey = $this->controller
->_key
;
1217 // redirect to thank you page
1218 CRM_Utils_System
::redirect(CRM_Utils_System
::url('civicrm/contribute/transact', "_qf_ThankYou_display=1&qfKey=$qfKey", TRUE, NULL, FALSE));