3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
6 | This work is published under the GNU AGPLv3 license with some |
7 | permitted exceptions and without any warranty. For full license |
8 | and copyright information, see https://civicrm.org/licensing |
9 +--------------------------------------------------------------------+
15 * @copyright CiviCRM LLC https://civicrm.org/licensing
19 * This class generates form components for processing a contribution.
21 class CRM_Contribute_Form_ContributionBase
extends CRM_Core_Form
{
22 use CRM_Financial_Form_FrontEndPaymentFormTrait
;
25 * The id of the contribution page that we are processing.
32 * The mode that we are in
40 * The contact id related to a membership
44 public $_membershipContactID;
47 * The values for the contribution db object
54 * The paymentProcessor attributes for this page
58 public $_paymentProcessor;
60 public $_paymentObject = NULL;
63 * The membership block for this page
67 public $_membershipBlock = NULL;
70 * Does this form support a separate membership payment
73 protected $_separateMembershipPayment;
76 * The params submitted by the form and computed by the app
83 * The fields involved in this contribution page
90 * The billing location id for this contribution page.
97 * Cache the amount to make things easier
125 * The contact id of the person for whom membership is being added or renewed based on the cid in the url,
126 * checksum, or session
134 * The Membership ID for membership renewal
138 public $_membershipId;
141 * Price Set ID, if the new price set method is used
148 * Array of fields for the price set
157 * Contribution mode e.g express for payment express, notify for off-site + notification back to CiviCRM
160 public $_contributeMode;
163 * Contribution page supports memberships
166 public $_useForMember;
172 public $_isBillingAddressRequiredForPayLater;
175 * Flag if email field exists in embedded profile
179 public $_emailExists = FALSE;
182 * Is this a backoffice form
183 * (this will affect whether paypal express code is displayed)
186 public $isBackOffice = FALSE;
189 * Payment instrument if for the transaction.
191 * This will generally be drawn from the payment processor and is ignored for
196 public $paymentInstrumentID;
199 * Is the price set quick config.
202 public function isQuickConfig() {
203 return self
::$_quickConfig ??
FALSE;
207 * Set variables up before form is built.
209 * @throws \CRM_Contribute_Exception_InactiveContributionPageException
212 public function preProcess() {
214 // current contribution page id
215 $this->_id
= CRM_Utils_Request
::retrieve('id', 'Positive', $this);
216 $this->_ccid
= CRM_Utils_Request
::retrieve('ccid', 'Positive', $this);
218 // seems like the session is corrupted and/or we lost the id trail
219 // lets just bump this to a regular session error and redirect user to main page
220 $this->controller
->invalidKeyRedirect();
222 $this->_emailExists
= $this->get('emailExists');
224 // this was used prior to the cleverer this_>getContactID - unsure now
225 $this->_userID
= CRM_Core_Session
::singleton()->getLoggedInContactID();
227 $this->_contactID
= $this->_membershipContactID
= $this->getContactID();
229 if ($this->_contactID
) {
230 $this->_mid
= CRM_Utils_Request
::retrieve('mid', 'Positive', $this);
232 $membership = new CRM_Member_DAO_Membership();
233 $membership->id
= $this->_mid
;
235 if ($membership->find(TRUE)) {
236 $this->_defaultMemTypeId
= $membership->membership_type_id
;
237 if ($membership->contact_id
!= $this->_contactID
) {
238 $validMembership = FALSE;
239 $organizations = CRM_Contact_BAO_Relationship
::getPermissionedContacts($this->_userID
, NULL, NULL, 'Organization');
240 if (!empty($organizations) && array_key_exists($membership->contact_id
, $organizations)) {
241 $this->_membershipContactID
= $membership->contact_id
;
242 $this->assign('membershipContactID', $this->_membershipContactID
);
243 $this->assign('membershipContactName', $organizations[$this->_membershipContactID
]['name']);
244 $validMembership = TRUE;
247 $membershipType = new CRM_Member_BAO_MembershipType();
248 $membershipType->id
= $membership->membership_type_id
;
249 if ($membershipType->find(TRUE)) {
250 // CRM-14051 - membership_type.relationship_type_id is a CTRL-A padded string w one or more ID values.
251 // Convert to comma separated list.
252 $inheritedRelTypes = implode(CRM_Utils_Array
::explodePadded($membershipType->relationship_type_id
), ',');
253 $permContacts = CRM_Contact_BAO_Relationship
::getPermissionedContacts($this->_userID
, $membershipType->relationship_type_id
);
254 if (array_key_exists($membership->contact_id
, $permContacts)) {
255 $this->_membershipContactID
= $membership->contact_id
;
256 $validMembership = TRUE;
260 if (!$validMembership) {
261 CRM_Core_Session
::setStatus(ts("Oops. The membership you're trying to renew appears to be invalid. Contact your site administrator if you need assistance. If you continue, you will be issued a new membership."), ts('Membership Invalid'), 'alert');
266 CRM_Core_Session
::setStatus(ts("Oops. The membership you're trying to renew appears to be invalid. Contact your site administrator if you need assistance. If you continue, you will be issued a new membership."), ts('Membership Invalid'), 'alert');
272 // we do not want to display recently viewed items, so turn off
273 $this->assign('displayRecent', FALSE);
276 $this->_action
= CRM_Utils_Request
::retrieve('action', 'String', $this, FALSE, 'add');
277 $this->assign('action', $this->_action
);
280 $this->_mode
= ($this->_action
== 1024) ?
'test' : 'live';
282 $this->_values
= $this->get('values');
283 $this->_fields
= $this->get('fields');
284 $this->_bltID
= $this->get('bltID');
285 $this->_paymentProcessor
= $this->get('paymentProcessor');
287 $this->_priceSetId
= $this->get('priceSetId');
288 $this->_priceSet
= $this->get('priceSet');
290 if (!$this->_values
) {
291 // get all the values from the dao object
295 CRM_Contribute_BAO_ContributionPage
::setValues($this->_id
, $this->_values
);
296 if (CRM_Financial_BAO_FinancialType
::isACLFinancialTypeStatus()
297 && !CRM_Core_Permission
::check('add contributions of type ' . CRM_Contribute_PseudoConstant
::financialType($this->_values
['financial_type_id']))
299 CRM_Core_Error
::statusBounce(ts('You do not have permission to access this page.'));
301 if (empty($this->_values
['is_active'])) {
302 throw new CRM_Contribute_Exception_InactiveContributionPageException(ts('The page you requested is currently unavailable.'), $this->_id
);
305 $endDate = CRM_Utils_Date
::processDate(CRM_Utils_Array
::value('end_date', $this->_values
));
306 $now = date('YmdHis');
307 if ($endDate && $endDate < $now) {
308 throw new CRM_Contribute_Exception_PastContributionPageException(ts('The page you requested has past its end date on %1', [1 => CRM_Utils_Date
::customFormat($endDate)]), $this->_id
);
311 $startDate = CRM_Utils_Date
::processDate(CRM_Utils_Array
::value('start_date', $this->_values
));
312 if ($startDate && $startDate > $now) {
313 throw new CRM_Contribute_Exception_FutureContributionPageException(ts('The page you requested will be active from %1', [1 => CRM_Utils_Date
::customFormat($startDate)]), $this->_id
);
316 $this->assignBillingType();
318 // check for is_monetary status
319 $isMonetary = $this->_values
['is_monetary'] ??
NULL;
320 $isPayLater = $this->_values
['is_pay_later'] ??
NULL;
321 if (!empty($this->_ccid
)) {
322 $this->_values
['financial_type_id'] = CRM_Core_DAO
::getFieldValue('CRM_Contribute_DAO_Contribution',
328 $this->_values
['is_pay_later'] = FALSE;
332 $this->setPayLaterLabel($this->_values
['pay_later_text']);
336 $this->_paymentProcessorIDs
= array_filter(explode(
337 CRM_Core_DAO
::VALUE_SEPARATOR
,
338 CRM_Utils_Array
::value('payment_processor', $this->_values
)
341 $this->assignPaymentProcessor($isPayLater);
346 $priceSetId = CRM_Price_BAO_PriceSet
::getFor('civicrm_contribution_page', $this->_id
);
347 CRM_Price_BAO_PriceSet
::initSet($this, 'civicrm_contribution_page', FALSE, $priceSetId);
349 // this avoids getting E_NOTICE errors in php
351 'amount_block_is_active',
352 'is_allow_other_amount',
355 foreach ($setNullFields as $f) {
356 if (!isset($this->_values
[$f])) {
357 $this->_values
[$f] = NULL;
361 //check if Membership Block is enabled, if Membership Fields are included in profile
362 //get membership section for this contribution page
363 $this->_membershipBlock
= CRM_Member_BAO_Membership
::getMembershipBlock($this->_id
);
364 $this->set('membershipBlock', $this->_membershipBlock
);
366 if (!empty($this->_values
['custom_pre_id'])) {
367 $preProfileType = CRM_Core_BAO_UFField
::getProfileType($this->_values
['custom_pre_id']);
370 if (!empty($this->_values
['custom_post_id'])) {
371 $postProfileType = CRM_Core_BAO_UFField
::getProfileType($this->_values
['custom_post_id']);
374 if (((isset($postProfileType) && $postProfileType == 'Membership') ||
375 (isset($preProfileType) && $preProfileType == 'Membership')
377 !$this->_membershipBlock
['is_active']
379 CRM_Core_Error
::fatal(ts('This page includes a Profile with Membership fields - but the Membership Block is NOT enabled. Please notify the site administrator.'));
382 $pledgeBlock = CRM_Pledge_BAO_PledgeBlock
::getPledgeBlock($this->_id
);
385 $this->_values
['pledge_block_id'] = $pledgeBlock['id'] ??
NULL;
386 $this->_values
['max_reminders'] = $pledgeBlock['max_reminders'] ??
NULL;
387 $this->_values
['initial_reminder_day'] = $pledgeBlock['initial_reminder_day'] ??
NULL;
388 $this->_values
['additional_reminder_day'] = $pledgeBlock['additional_reminder_day'] ??
NULL;
390 //set pledge id in values
391 $pledgeId = CRM_Utils_Request
::retrieve('pledgeId', 'Positive', $this);
393 //authenticate pledge user for pledge payment.
395 $this->_values
['pledge_id'] = $pledgeId;
397 //lets override w/ pledge campaign.
398 $this->_values
['campaign_id'] = CRM_Core_DAO
::getFieldValue('CRM_Pledge_DAO_Pledge',
402 self
::authenticatePledgeUser();
405 $this->set('values', $this->_values
);
406 $this->set('fields', $this->_fields
);
410 $pcpId = CRM_Utils_Request
::retrieve('pcpId', 'Positive', $this);
412 $pcp = CRM_PCP_BAO_PCP
::handlePcp($pcpId, 'contribute', $this->_values
);
413 $this->_pcpId
= $pcp['pcpId'];
414 $this->_pcpBlock
= $pcp['pcpBlock'];
415 $this->_pcpInfo
= $pcp['pcpInfo'];
418 // Link (button) for users to create their own Personal Campaign page
419 if ($linkText = CRM_PCP_BAO_PCP
::getPcpBlockStatus($this->_id
, 'contribute')) {
420 $linkTextUrl = CRM_Utils_System
::url('civicrm/contribute/campaign',
421 "action=add&reset=1&pageId={$this->_id}&component=contribute",
424 $this->assign('linkTextUrl', $linkTextUrl);
425 $this->assign('linkText', $linkText);
428 //set pledge block if block id is set
429 if (!empty($this->_values
['pledge_block_id'])) {
430 $this->assign('pledgeBlock', TRUE);
433 // check if one of the (amount , membership) blocks is active or not.
434 $this->_membershipBlock
= $this->get('membershipBlock');
436 if (!$this->_values
['amount_block_is_active'] &&
437 !$this->_membershipBlock
['is_active'] &&
440 CRM_Core_Error
::fatal(ts('The requested online contribution page is missing a required Contribution Amount section or Membership section or Price Set. Please check with the site administrator for assistance.'));
443 if ($this->_values
['amount_block_is_active']) {
444 $this->set('amount_block_is_active', $this->_values
['amount_block_is_active']);
447 $this->_contributeMode
= $this->get('contributeMode');
448 $this->assign('contributeMode', $this->_contributeMode
);
450 //assigning is_monetary and is_email_receipt to template
451 $this->assign('is_monetary', $this->_values
['is_monetary']);
452 $this->assign('is_email_receipt', $this->_values
['is_email_receipt']);
453 $this->assign('bltID', $this->_bltID
);
455 //assign cancelSubscription URL to templates
456 $this->assign('cancelSubscriptionUrl',
457 CRM_Utils_Array
::value('cancelSubscriptionUrl', $this->_values
)
460 $title = !empty($this->_values
['frontend_title']) ?
$this->_values
['frontend_title'] : $this->_values
['title'];
462 $this->setTitle(($this->_pcpId ?
$this->_pcpInfo
['title'] : $title));
463 $this->_defaults
= [];
465 $this->_amount
= $this->get('amount');
466 // Assigning this to the template means it will be passed through to the payment form.
467 // This can, for example, by used by payment processors using client side encryption
468 $this->assign('currency', $this->getCurrency());
470 CRM_Contribute_BAO_Contribution_Utils
::overrideDefaultCurrency($this->_values
);
472 //lets allow user to override campaign.
473 $campID = CRM_Utils_Request
::retrieve('campID', 'Positive', $this);
474 if ($campID && CRM_Core_DAO
::getFieldValue('CRM_Campaign_DAO_Campaign', $campID)) {
475 $this->_values
['campaign_id'] = $campID;
478 //do check for cancel recurring and clean db, CRM-7696
479 if (CRM_Utils_Request
::retrieve('cancel', 'Boolean')) {
480 self
::cancelRecurring();
483 // check if billing block is required for pay later
484 if (!empty($this->_values
['is_pay_later'])) {
485 $this->_isBillingAddressRequiredForPayLater
= $this->_values
['is_billing_required'] ??
NULL;
486 $this->assign('isBillingAddressRequiredForPayLater', $this->_isBillingAddressRequiredForPayLater
);
491 * Set the default values.
493 public function setDefaultValues() {
494 return $this->_defaults
;
498 * Assign the minimal set of variables to the template.
500 public function assignToTemplate() {
501 $this->set('name', $this->assignBillingName($this->_params
));
503 $this->assign('paymentProcessor', $this->_paymentProcessor
);
512 $config = CRM_Core_Config
::singleton();
513 if (isset($this->_values
['is_recur']) && !empty($this->_paymentProcessor
['is_recur'])) {
514 $this->assign('is_recur_enabled', 1);
515 $vars = array_merge($vars, [
517 'frequency_interval',
523 if (in_array('CiviPledge', $config->enableComponents
) &&
524 CRM_Utils_Array
::value('is_pledge', $this->_params
) == 1
526 $this->assign('pledge_enabled', 1);
528 $vars = array_merge($vars, [
530 'pledge_frequency_interval',
531 'pledge_frequency_unit',
532 'pledge_installments',
536 // @todo - stop setting amount level in this function & call the CRM_Price_BAO_PriceSet::getAmountLevel
537 // function to get correct amount level consistently. Remove setting of the amount level in
538 // CRM_Price_BAO_PriceSet::processAmount. Extend the unit tests in CRM_Price_BAO_PriceSetTest
539 // to cover all variants.
540 if (isset($this->_params
['amount_other']) ||
isset($this->_params
['selectMembership'])) {
541 $this->_params
['amount_level'] = '';
544 foreach ($vars as $v) {
545 if (isset($this->_params
[$v])) {
546 if ($v == "amount" && $this->_params
[$v] === 0) {
547 $this->_params
[$v] = CRM_Utils_Money
::format($this->_params
[$v], NULL, NULL, TRUE);
549 $this->assign($v, $this->_params
[$v]);
553 $this->assign('address', CRM_Utils_Address
::getFormattedBillingAddressFieldsFromParameters(
558 if (!empty($this->_params
['onbehalf_profile_id']) && !empty($this->_params
['onbehalf'])) {
559 $this->assign('onBehalfName', $this->_params
['organization_name']);
560 $locTypeId = array_keys($this->_params
['onbehalf_location']['email']);
561 $this->assign('onBehalfEmail', $this->_params
['onbehalf_location']['email'][$locTypeId[0]]['email']);
563 $this->assignPaymentFields();
564 $this->assignEmailField();
566 // also assign the receipt_text
567 if (isset($this->_values
['receipt_text'])) {
568 $this->assign('receipt_text', $this->_values
['receipt_text']);
573 * Assign email variable in the template.
575 public function assignEmailField() {
576 //If email exist in a profile, the default billing email field is not loaded on the page.
577 //Hence, assign the existing location type email by iterating through the params.
578 if ($this->_emailExists
&& empty($this->_params
["email-{$this->_bltID}"])) {
579 foreach ($this->_params
as $key => $val) {
580 if (substr($key, 0, 6) == 'email-') {
581 $this->assign('email', $this->_params
[$key]);
587 $this->assign('email', CRM_Utils_Array
::value("email-{$this->_bltID}", $this->_params
));
592 * Add the custom fields.
595 * @param string $name
596 * @param bool $viewOnly
597 * @param null $profileContactType
598 * @param array $fieldTypes
600 public function buildCustom($id, $name, $viewOnly = FALSE, $profileContactType = NULL, $fieldTypes = NULL) {
602 $contactID = $this->getContactID();
604 // we don't allow conflicting fields to be
605 // configured via profile - CRM 2100
612 'non_deductible_amount' => 1,
615 'contribution_status_id' => 1,
616 // @todo replace payment_instrument with payment instrument id.
617 // both are available now but the id field is the most consistent.
618 'payment_instrument' => 1,
619 'payment_instrument_id' => 1,
620 'contribution_check_number' => 1,
621 'financial_type' => 1,
624 $fields = CRM_Core_BAO_UFGroup
::getFields($id, FALSE, CRM_Core_Action
::ADD
, NULL, NULL, FALSE,
625 NULL, FALSE, NULL, CRM_Core_Permission
::CREATE
, NULL
629 // determine if email exists in profile so we know if we need to manually insert CRM-2888, CRM-15067
630 foreach ($fields as $key => $field) {
631 if (substr($key, 0, 6) == 'email-' &&
632 !in_array($profileContactType, ['honor', 'onbehalf'])
634 $this->_emailExists
= TRUE;
635 $this->set('emailExists', TRUE);
639 if (array_intersect_key($fields, $fieldsToIgnore)) {
640 $fields = array_diff_key($fields, $fieldsToIgnore);
641 CRM_Core_Session
::setStatus(ts('Some of the profile fields cannot be configured for this page.'), ts('Warning'), 'alert');
644 //remove common fields only if profile is not configured for onbehalf/honor
645 if (!in_array($profileContactType, ['honor', 'onbehalf'])) {
646 $fields = array_diff_key($fields, $this->_fields
);
649 CRM_Core_BAO_Address
::checkContactSharedAddressFields($fields, $contactID);
651 // fetch file preview when not submitted yet, like in online contribution Confirm and ThankYou page
652 $viewOnlyFileValues = empty($profileContactType) ?
[] : [$profileContactType => []];
653 foreach ($fields as $key => $field) {
655 isset($field['data_type']) &&
656 $field['data_type'] == 'File' ||
($viewOnly && $field['name'] == 'image_URL')
658 //retrieve file value from submitted values on basis of $profileContactType
659 $fileValue = $this->_params
[$key] ??
NULL;
660 if (!empty($profileContactType) && !empty($this->_params
[$profileContactType])) {
661 $fileValue = $this->_params
[$profileContactType][$key] ??
NULL;
665 $path = $fileValue['name'] ??
NULL;
666 $fileType = $fileValue['type'] ??
NULL;
667 $fileValue = CRM_Utils_File
::getFileURL($path, $fileType);
670 // format custom file value fetched from submitted value
671 if ($profileContactType) {
672 $viewOnlyFileValues[$profileContactType][$key] = $fileValue;
675 $viewOnlyFileValues[$key] = $fileValue;
678 // On viewOnly use-case (as in online contribution Confirm page) we no longer need to set
679 // required property because being required file is already uploaded while registration
680 $field['is_required'] = FALSE;
682 if ($profileContactType) {
683 //Since we are showing honoree name separately so we are removing it from honoree profile just for display
684 if ($profileContactType == 'honor') {
685 $honoreeNamefields = [
693 if (in_array($field['name'], $honoreeNamefields)) {
694 unset($fields[$field['name']]);
698 if (!empty($fieldTypes) && in_array($field['field_type'], $fieldTypes)) {
699 CRM_Core_BAO_UFGroup
::buildProfile(
702 CRM_Profile_Form
::MODE_CREATE
,
707 $this->_fields
[$profileContactType][$key] = $field;
710 unset($fields[$key]);
714 CRM_Core_BAO_UFGroup
::buildProfile(
717 CRM_Profile_Form
::MODE_CREATE
,
721 $this->_fields
[$key] = $field;
723 // CRM-11316 Is ReCAPTCHA enabled for this profile AND is this an anonymous visitor
724 if ($field['add_captcha'] && !$this->_userID
) {
729 $this->assign($name, $fields);
731 if ($profileContactType && count($viewOnlyFileValues[$profileContactType])) {
732 $this->assign('viewOnlyPrefixFileValues', $viewOnlyFileValues);
734 elseif (count($viewOnlyFileValues)) {
735 $this->assign('viewOnlyFileValues', $viewOnlyFileValues);
738 if ($addCaptcha && !$viewOnly) {
739 $this->enableCaptchaOnForm();
746 * Enable ReCAPTCHA on Contribution form
748 protected function enableCaptchaOnForm() {
749 CRM_Utils_ReCAPTCHA
::enableCaptchaOnForm($this);
752 public function assignPaymentFields() {
755 if ($this->_amount
> 0.0) {
758 elseif (!empty($this->_params
['selectMembership'])) {
759 $memFee = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType', $this->_params
['selectMembership'], 'minimum_fee');
765 // The concept of contributeMode is deprecated.
766 // The payment processor object can provide info about the fields it shows.
767 if ($isMonetary && is_a($this->_paymentProcessor
['object'], 'CRM_Core_Payment')) {
768 /** @var $paymentProcessorObject \CRM_Core_Payment */
769 $paymentProcessorObject = $this->_paymentProcessor
['object'];
771 $paymentFields = $paymentProcessorObject->getPaymentFormFields();
772 foreach ($paymentFields as $index => $paymentField) {
773 if (!isset($this->_params
[$paymentField])) {
774 unset($paymentFields[$index]);
777 if ($paymentField === 'credit_card_exp_date') {
778 $date = CRM_Utils_Date
::format(CRM_Utils_Array
::value('credit_card_exp_date', $this->_params
));
779 $date = CRM_Utils_Date
::mysqlToIso($date);
780 $this->assign('credit_card_exp_date', $date);
782 elseif ($paymentField === 'credit_card_number') {
783 $this->assign('credit_card_number',
784 CRM_Utils_System
::mungeCreditCard(CRM_Utils_Array
::value('credit_card_number', $this->_params
))
787 elseif ($paymentField === 'credit_card_type') {
788 $this->assign('credit_card_type', CRM_Core_PseudoConstant
::getLabel(
789 'CRM_Core_BAO_FinancialTrxn',
791 CRM_Core_PseudoConstant
::getKey('CRM_Core_BAO_FinancialTrxn', 'card_type_id', $this->_params
['credit_card_type'])
795 $this->assign($paymentField, $this->_params
[$paymentField]);
798 $this->assign('paymentFieldsetLabel', CRM_Core_Payment_Form
::getPaymentLabel($paymentProcessorObject));
799 $this->assign('paymentFields', $paymentFields);
805 * Display ReCAPTCHA warning on Contribution form
807 protected function displayCaptchaWarning() {
808 if (CRM_Core_Permission
::check("administer CiviCRM")) {
809 if (!CRM_Utils_ReCAPTCHA
::hasSettingsAvailable()) {
810 $this->assign('displayCaptchaWarning', TRUE);
816 * Check if ReCAPTCHA has to be added on Contribution form forcefully.
818 protected function hasToAddForcefully() {
819 return CRM_Utils_ReCAPTCHA
::hasToAddForcefully();
823 * Add onbehalf/honoree profile fields and native module fields.
826 * @param CRM_Core_Form $form
828 public function buildComponentForm($id, $form) {
833 $contactID = $this->getContactID();
835 foreach (['soft_credit', 'on_behalf'] as $module) {
836 if ($module == 'soft_credit') {
837 if (empty($form->_values
['honoree_profile_id'])) {
841 if (!CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_UFGroup', $form->_values
['honoree_profile_id'], 'is_active')) {
842 CRM_Core_Error
::fatal(ts('This contribution page has been configured for contribution on behalf of honoree and the selected honoree profile is either disabled or not found.'));
845 $profileContactType = CRM_Core_BAO_UFGroup
::getContactType($form->_values
['honoree_profile_id']);
846 $requiredProfileFields = [
847 'Individual' => ['first_name', 'last_name'],
848 'Organization' => ['organization_name', 'email'],
849 'Household' => ['household_name', 'email'],
851 $validProfile = CRM_Core_BAO_UFGroup
::checkValidProfile($form->_values
['honoree_profile_id'], $requiredProfileFields[$profileContactType]);
852 if (!$validProfile) {
853 CRM_Core_Error
::fatal(ts('This contribution page has been configured for contribution on behalf of honoree and the required fields of the selected honoree profile are disabled or doesn\'t exist.'));
856 foreach (['honor_block_title', 'honor_block_text'] as $name) {
857 $form->assign($name, $form->_values
[$name]);
860 $softCreditTypes = CRM_Core_OptionGroup
::values("soft_credit_type", FALSE);
862 // radio button for Honor Type
863 foreach ($form->_values
['soft_credit_types'] as $value) {
864 $honorTypes[$value] = $form->createElement('radio', NULL, NULL, $softCreditTypes[$value], $value);
866 $form->addGroup($honorTypes, 'soft_credit_type_id', NULL)->setAttribute('allowClear', TRUE);
868 $honoreeProfileFields = CRM_Core_BAO_UFGroup
::getFields(
869 $this->_values
['honoree_profile_id'], FALSE,
873 NULL, CRM_Core_Permission
::CREATE
875 $form->assign('honoreeProfileFields', $honoreeProfileFields);
877 // add the form elements
878 foreach ($honoreeProfileFields as $name => $field) {
879 // If soft credit type is not chosen then make omit requiredness from honoree profile fields
880 if (count($form->_submitValues
) &&
881 empty($form->_submitValues
['soft_credit_type_id']) &&
882 !empty($field['is_required'])
884 $field['is_required'] = FALSE;
886 CRM_Core_BAO_UFGroup
::buildProfile($form, $field, CRM_Profile_Form
::MODE_CREATE
, NULL, FALSE, FALSE, NULL, 'honor');
890 if (empty($form->_values
['onbehalf_profile_id'])) {
894 if (!CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_UFGroup', $form->_values
['onbehalf_profile_id'], 'is_active')) {
895 CRM_Core_Error
::fatal(ts('This contribution page has been configured for contribution on behalf of an organization and the selected onbehalf profile is either disabled or not found.'));
898 $member = CRM_Member_BAO_Membership
::getMembershipBlock($form->_id
);
899 if (empty($member['is_active'])) {
900 $msg = ts('Mixed profile not allowed for on behalf of registration/sign up.');
901 $onBehalfProfile = CRM_Core_BAO_UFGroup
::profileGroups($form->_values
['onbehalf_profile_id']);
909 if (in_array($contactType, $onBehalfProfile) &&
910 (in_array('Membership', $onBehalfProfile) ||
911 in_array('Contribution', $onBehalfProfile)
914 CRM_Core_Error
::fatal($msg);
920 // retrieve all permissioned organizations of contact $contactID
921 $organizations = CRM_Contact_BAO_Relationship
::getPermissionedContacts($contactID, NULL, NULL, 'Organization');
923 if (count($organizations)) {
924 // Related org url - pass checksum if needed
926 'ufId' => $form->_values
['onbehalf_profile_id'],
929 if (!empty($_GET['cs'])) {
931 'ufId' => $form->_values
['onbehalf_profile_id'],
932 'uid' => $this->_contactID
,
937 $locDataURL = CRM_Utils_System
::url('civicrm/ajax/permlocation', $args, FALSE, NULL, FALSE);
938 $form->assign('locDataURL', $locDataURL);
940 if (count($organizations) > 0) {
941 $form->add('select', 'onbehalfof_id', '', CRM_Utils_Array
::collect('name', $organizations));
944 0 => ts('Select an existing organization'),
945 1 => ts('Enter a new organization'),
947 $form->addRadio('org_option', ts('options'), $orgOptions);
948 $form->setDefaults(['org_option' => 0]);
952 $form->assign('fieldSetTitle', CRM_Core_BAO_UFGroup
::getTitle($form->_values
['onbehalf_profile_id']));
954 if (!empty($form->_values
['is_for_organization'])) {
955 if ($form->_values
['is_for_organization'] == 2) {
956 $form->assign('onBehalfRequired', TRUE);
959 $form->addElement('checkbox', 'is_for_organization',
960 $form->_values
['for_organization'],
966 $profileFields = CRM_Core_BAO_UFGroup
::getFields(
967 $form->_values
['onbehalf_profile_id'],
968 FALSE, CRM_Core_Action
::VIEW
, NULL,
969 NULL, FALSE, NULL, FALSE, NULL,
970 CRM_Core_Permission
::CREATE
, NULL
973 $form->assign('onBehalfOfFields', $profileFields);
974 if (!empty($form->_submitValues
['onbehalf'])) {
975 if (!empty($form->_submitValues
['onbehalfof_id'])) {
976 $form->assign('submittedOnBehalf', $form->_submitValues
['onbehalfof_id']);
978 $form->assign('submittedOnBehalfInfo', json_encode(str_replace('"', '\"', $form->_submitValues
['onbehalf']), JSON_HEX_APOS
));
981 $fieldTypes = ['Contact', 'Organization'];
982 if (!empty($form->_membershipBlock
)) {
983 $fieldTypes = array_merge($fieldTypes, ['Membership']);
985 $contactSubType = CRM_Contact_BAO_ContactType
::subTypes('Organization');
986 $fieldTypes = array_merge($fieldTypes, $contactSubType);
988 foreach ($profileFields as $name => $field) {
989 if (in_array($field['field_type'], $fieldTypes)) {
990 list($prefixName, $index) = CRM_Utils_System
::explode('-', $name, 2);
991 if (in_array($prefixName, ['organization_name', 'email']) && empty($field['is_required'])) {
992 $field['is_required'] = 1;
994 if (count($form->_submitValues
) &&
995 empty($form->_submitValues
['is_for_organization']) &&
996 $form->_values
['is_for_organization'] == 1 &&
997 !empty($field['is_required'])
999 $field['is_required'] = FALSE;
1001 CRM_Core_BAO_UFGroup
::buildProfile($form, $field, NULL, NULL, FALSE, 'onbehalf', NULL, 'onbehalf');
1010 * Check template file exists.
1012 * @param string $suffix
1014 * @return null|string
1016 public function checkTemplateFileExists($suffix = NULL) {
1018 $templateFile = "CRM/Contribute/Form/Contribution/{$this->_id}/{$this->_name}.{$suffix}tpl";
1019 $template = CRM_Core_Form
::getTemplate();
1020 if ($template->template_exists($templateFile)) {
1021 return $templateFile;
1028 * Use the form name to create the tpl file name.
1032 public function getTemplateFileName() {
1033 $fileName = $this->checkTemplateFileExists();
1034 return $fileName ?
$fileName : parent
::getTemplateFileName();
1038 * Add the extra.tpl in.
1040 * Default extra tpl file basically just replaces .tpl with .extra.tpl
1041 * i.e. we do not override - why isn't this done at the CRM_Core_Form level?
1045 public function overrideExtraTemplateFileName() {
1046 $fileName = $this->checkTemplateFileExists('extra.');
1047 return $fileName ?
$fileName : parent
::overrideExtraTemplateFileName();
1051 * Authenticate pledge user during online payment.
1053 public function authenticatePledgeUser() {
1054 //get the userChecksum and contact id
1055 $userChecksum = CRM_Utils_Request
::retrieve('cs', 'String', $this);
1056 $contactID = CRM_Utils_Request
::retrieve('cid', 'Positive', $this);
1058 //get pledge status and contact id
1060 $pledgeParams = ['id' => $this->_values
['pledge_id']];
1061 $returnProperties = ['contact_id', 'status_id'];
1062 CRM_Core_DAO
::commonRetrieve('CRM_Pledge_DAO_Pledge', $pledgeParams, $pledgeValues, $returnProperties);
1065 $allStatus = CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name');
1067 array_search('Pending', $allStatus),
1068 array_search('In Progress', $allStatus),
1069 array_search('Overdue', $allStatus),
1073 if ($this->_userID
&&
1074 $this->_userID
== $pledgeValues['contact_id']
1076 //check for authenticated user.
1079 elseif ($userChecksum && $pledgeValues['contact_id']) {
1080 //check for anonymous user.
1081 $validUser = CRM_Contact_BAO_Contact_Utils
::validChecksum($pledgeValues['contact_id'], $userChecksum);
1083 //make sure cid is same as pledge contact id
1084 if ($validUser && ($pledgeValues['contact_id'] != $contactID)) {
1090 CRM_Core_Error
::fatal(ts("Oops. It looks like you have an incorrect or incomplete link (URL). Please make sure you've copied the entire link, and try again. Contact the site administrator if this error persists."));
1093 //check for valid pledge status.
1094 if (!in_array($pledgeValues['status_id'], $validStatus)) {
1095 CRM_Core_Error
::fatal(ts('Oops. You cannot make a payment for this pledge - pledge status is %1.', [1 => CRM_Utils_Array
::value($pledgeValues['status_id'], $allStatus)]));
1100 * Cancel recurring contributions.
1102 * In case user cancel recurring contribution,
1103 * When we get the control back from payment gate way
1104 * lets delete the recurring and related contribution.
1106 public function cancelRecurring() {
1107 $isCancel = CRM_Utils_Request
::retrieve('cancel', 'Boolean');
1109 $isRecur = CRM_Utils_Request
::retrieve('isRecur', 'Boolean');
1110 $recurId = CRM_Utils_Request
::retrieve('recurId', 'Positive');
1111 //clean db for recurring contribution.
1112 if ($isRecur && $recurId) {
1113 CRM_Contribute_BAO_ContributionRecur
::deleteRecurContribution($recurId);
1115 $contribId = CRM_Utils_Request
::retrieve('contribId', 'Positive');
1117 CRM_Contribute_BAO_Contribution
::deleteContribution($contribId);
1123 * Build Membership Block in Contribution Pages.
1126 * Contact checked for having a current membership for a particular membership.
1127 * @param bool $isContributionMainPage
1128 * Is this the main page? If so add form input fields.
1129 * (or better yet don't have this functionality in a function shared with forms that don't share it).
1130 * @param int|array $selectedMembershipTypeID
1131 * Selected membership id.
1132 * @param bool $thankPage
1134 * @param null $isTest
1137 * Is this a separate membership payment
1139 protected function buildMembershipBlock(
1141 $isContributionMainPage = FALSE,
1142 $selectedMembershipTypeID = NULL,
1147 $separateMembershipPayment = FALSE;
1148 if ($this->_membershipBlock
) {
1149 $this->_currentMemberships
= [];
1151 $membershipTypeIds = $membershipTypes = $radio = [];
1152 $membershipPriceset = (!empty($this->_priceSetId
) && $this->_useForMember
);
1154 $allowAutoRenewMembership = $autoRenewOption = FALSE;
1155 $autoRenewMembershipTypeOptions = [];
1157 $separateMembershipPayment = $this->_membershipBlock
['is_separate_payment'] ??
NULL;
1159 if ($membershipPriceset) {
1160 foreach ($this->_priceSet
['fields'] as $pField) {
1161 if (empty($pField['options'])) {
1164 foreach ($pField['options'] as $opId => $opValues) {
1165 if (empty($opValues['membership_type_id'])) {
1168 $membershipTypeIds[$opValues['membership_type_id']] = $opValues['membership_type_id'];
1172 elseif (!empty($this->_membershipBlock
['membership_types'])) {
1173 $membershipTypeIds = explode(',', $this->_membershipBlock
['membership_types']);
1176 if (!empty($membershipTypeIds)) {
1177 //set status message if wrong membershipType is included in membershipBlock
1178 if (isset($this->_mid
) && !$membershipPriceset) {
1179 $membershipTypeID = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership',
1181 'membership_type_id'
1183 if (!in_array($membershipTypeID, $membershipTypeIds)) {
1184 CRM_Core_Session
::setStatus(ts("Oops. The membership you're trying to renew appears to be invalid. Contact your site administrator if you need assistance. If you continue, you will be issued a new membership."), ts('Invalid Membership'), 'error');
1188 $membershipTypeValues = CRM_Member_BAO_Membership
::buildMembershipTypeValues($this, $membershipTypeIds);
1189 $this->_membershipTypeValues
= $membershipTypeValues;
1192 // Check if we support auto-renew on this contribution page
1193 // FIXME: If any of the payment processors do NOT support recurring you cannot setup an
1194 // auto-renew payment even if that processor is not selected.
1195 $allowAutoRenewOpt = TRUE;
1196 if (is_array($this->_paymentProcessors
)) {
1197 foreach ($this->_paymentProcessors
as $id => $val) {
1198 if ($id && !$val['is_recur']) {
1199 $allowAutoRenewOpt = FALSE;
1203 foreach ($membershipTypeIds as $value) {
1204 $memType = $membershipTypeValues[$value];
1205 if ($selectedMembershipTypeID != NULL) {
1206 if ($memType['id'] == $selectedMembershipTypeID) {
1207 $this->assign('minimum_fee',
1208 CRM_Utils_Array
::value('minimum_fee', $memType)
1210 $this->assign('membership_name', $memType['name']);
1211 if (!$thankPage && $cid) {
1212 $membership = new CRM_Member_DAO_Membership();
1213 $membership->contact_id
= $cid;
1214 $membership->membership_type_id
= $memType['id'];
1215 if ($membership->find(TRUE)) {
1216 $this->assign('renewal_mode', TRUE);
1217 $memType['current_membership'] = $membership->end_date
;
1218 $this->_currentMemberships
[$membership->membership_type_id
] = $membership->membership_type_id
;
1221 $membershipTypes[] = $memType;
1224 elseif ($memType['is_active']) {
1226 if ($allowAutoRenewOpt) {
1227 $javascriptMethod = ['onclick' => "return showHideAutoRenew( this.value );"];
1228 $isAvailableAutoRenew = $this->_membershipBlock
['auto_renew'][$value] ??
1;
1229 $autoRenewMembershipTypeOptions["autoRenewMembershipType_{$value}"] = (int) $memType['auto_renew'] * $isAvailableAutoRenew;
1230 $allowAutoRenewMembership = TRUE;
1233 $javascriptMethod = NULL;
1234 $autoRenewMembershipTypeOptions["autoRenewMembershipType_{$value}"] = 0;
1237 //add membership type.
1238 $radio[$memType['id']] = $this->createElement('radio', NULL, NULL, NULL,
1239 $memType['id'], $javascriptMethod
1242 $membership = new CRM_Member_DAO_Membership();
1243 $membership->contact_id
= $cid;
1244 $membership->membership_type_id
= $memType['id'];
1246 //show current membership, skip pending and cancelled membership records,
1247 //because we take first membership record id for renewal
1248 $membership->whereAdd('status_id != 5 AND status_id !=6');
1250 if (!is_null($isTest)) {
1251 $membership->is_test
= $isTest;
1255 $membership->orderBy('end_date DESC');
1257 if ($membership->find(TRUE)) {
1258 if (!$membership->end_date
) {
1259 unset($radio[$memType['id']]);
1260 $this->assign('islifetime', TRUE);
1263 $this->assign('renewal_mode', TRUE);
1264 $this->_currentMemberships
[$membership->membership_type_id
] = $membership->membership_type_id
;
1265 $memType['current_membership'] = $membership->end_date
;
1267 $endDate = $memType['current_membership'];
1268 $this->_defaultMemTypeId
= $memType['id'];
1270 if ($memType['current_membership'] < $endDate) {
1271 $endDate = $memType['current_membership'];
1272 $this->_defaultMemTypeId
= $memType['id'];
1276 $membershipTypes[] = $memType;
1281 $this->assign('membershipBlock', $this->_membershipBlock
);
1282 $this->assign('showRadio', $isContributionMainPage);
1283 $this->assign('membershipTypes', $membershipTypes);
1284 $this->assign('allowAutoRenewMembership', $allowAutoRenewMembership);
1285 $this->assign('autoRenewMembershipTypeOptions', json_encode($autoRenewMembershipTypeOptions));
1286 //give preference to user submitted auto_renew value.
1287 $takeUserSubmittedAutoRenew = (!empty($_POST) ||
$this->isSubmitted());
1288 $this->assign('takeUserSubmittedAutoRenew', $takeUserSubmittedAutoRenew);
1290 // Assign autorenew option (0:hide,1:optional,2:required) so we can use it in confirmation etc.
1291 $autoRenewOption = CRM_Price_BAO_PriceSet
::checkAutoRenewForPriceSet($this->_priceSetId
);
1292 //$selectedMembershipTypeID is retrieved as an array for membership priceset if multiple
1293 //options for different organisation is selected on the contribution page.
1294 if (is_numeric($selectedMembershipTypeID) && isset($membershipTypeValues[$selectedMembershipTypeID]['auto_renew'])) {
1295 $this->assign('autoRenewOption', $membershipTypeValues[$selectedMembershipTypeID]['auto_renew']);
1298 $this->assign('autoRenewOption', $autoRenewOption);
1301 if ($isContributionMainPage) {
1302 if (!$membershipPriceset) {
1303 if (!$this->_membershipBlock
['is_required']) {
1304 $this->assign('showRadioNoThanks', TRUE);
1305 $radio[''] = $this->createElement('radio', NULL, NULL, NULL, 'no_thanks', NULL);
1306 $this->addGroup($radio, 'selectMembership', NULL);
1308 elseif ($this->_membershipBlock
['is_required'] && count($radio) == 1) {
1309 $temp = array_keys($radio);
1310 $this->add('hidden', 'selectMembership', $temp[0], ['id' => 'selectMembership']);
1311 $this->assign('singleMembership', TRUE);
1312 $this->assign('showRadio', FALSE);
1315 $this->addGroup($radio, 'selectMembership', NULL);
1318 $this->addRule('selectMembership', ts('Please select one of the memberships.'), 'required');
1321 if ((!$this->_values
['is_pay_later'] ||
is_array($this->_paymentProcessors
)) && ($allowAutoRenewMembership ||
$autoRenewOption)) {
1322 if ($autoRenewOption == 2) {
1323 $this->addElement('hidden', 'auto_renew', ts('Please renew my membership automatically.'));
1326 $this->addElement('checkbox', 'auto_renew', ts('Please renew my membership automatically.'));
1333 return $separateMembershipPayment;
1337 * Determine if recurring parameters need to be added to the form parameters.
1340 * - frequency_interval
1343 * For membership this is based on the membership type.
1345 * This needs to be done before processing the pre-approval redirect where relevant on the main page or before any payment processing.
1347 * Arguably the form should start to build $this->_params in the pre-process main page & use that array consistently throughout.
1349 protected function setRecurringMembershipParams() {
1350 $selectedMembershipTypeID = $this->_params
['selectMembership'] ??
NULL;
1351 if ($selectedMembershipTypeID) {
1352 // @todo the price_x fields will ALWAYS allow us to determine the membership - so we should ignore
1353 // 'selectMembership' and calculate from the price_x fields so we have one method that always works
1354 // this is lazy & only catches when selectMembership is set, but the worst of all worlds would be to fix
1355 // this with an else (calculate for price set).
1356 $membershipTypes = CRM_Price_BAO_PriceSet
::getMembershipTypesFromPriceSet($this->_priceSetId
);
1357 if (in_array($selectedMembershipTypeID, $membershipTypes['autorenew_required'])
1358 ||
(in_array($selectedMembershipTypeID, $membershipTypes['autorenew_optional']) &&
1359 !empty($this->_params
['is_recur']))
1361 $this->_params
['auto_renew'] = TRUE;
1364 if ((!empty($this->_params
['selectMembership']) ||
!empty($this->_params
['priceSetId']))
1365 && !empty($this->_paymentProcessor
['is_recur']) &&
1366 !empty($this->_params
['auto_renew'])
1367 && empty($this->_params
['is_recur']) && empty($this->_params
['frequency_interval'])
1370 $this->_params
['is_recur'] = $this->_values
['is_recur'] = 1;
1371 // check if price set is not quick config
1372 if (!empty($this->_params
['priceSetId']) && !CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet', $this->_params
['priceSetId'], 'is_quick_config')) {
1373 list($this->_params
['frequency_interval'], $this->_params
['frequency_unit']) = CRM_Price_BAO_PriceSet
::getRecurDetails($this->_params
['priceSetId']);
1376 // FIXME: set interval and unit based on selected membership type
1377 $this->_params
['frequency_interval'] = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType',
1378 $this->_params
['selectMembership'], 'duration_interval'
1380 $this->_params
['frequency_unit'] = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType',
1381 $this->_params
['selectMembership'], 'duration_unit'
1388 * Get the payment processor object for the submission, returning the manual one for offline payments.
1390 * @return CRM_Core_Payment
1392 protected function getPaymentProcessorObject() {
1393 if (!empty($this->_paymentProcessor
)) {
1394 return $this->_paymentProcessor
['object'];
1396 return new CRM_Core_Payment_Manual();
1400 * Get the amount for the main contribution.
1402 * The goal is to expand this function so that all the argy-bargy of figuring out the amount
1403 * winds up here as the main spaghetti shrinks.
1405 * If there is a separate membership contribution this is the 'other one'. Otherwise there
1412 * @throws \CiviCRM_API3_Exception
1414 protected function getMainContributionAmount($params) {
1415 if (!empty($params['selectMembership'])) {
1416 if (empty($params['amount']) && !$this->_separateMembershipPayment
) {
1417 return CRM_Member_BAO_MembershipType
::getMembershipType($params['selectMembership'])['minimum_fee'] ??
0;
1420 return $params['amount'] ??
0;
1424 * Wrapper for processAmount that also sets autorenew.
1427 * This is the output of the function CRM_Price_BAO_PriceSet::getSetDetail($priceSetID, FALSE, FALSE);
1428 * And, it would make sense to introduce caching into that function and call it from here rather than
1429 * require the $fields array which is passed from pillar to post around the form in order to pass it in here.
1430 * @param array $params
1431 * Params reflecting form input e.g with fields 'price_5' => 7, 'price_8' => array(7, 8)
1433 * Line item array to be altered.
1434 * @param int $priceSetID
1436 public function processAmountAndGetAutoRenew($fields, &$params, &$lineItems, $priceSetID = NULL) {
1437 CRM_Price_BAO_PriceSet
::processAmount($fields, $params, $lineItems, $priceSetID);
1439 $autoRenew[0] = $autoRenew[1] = $autoRenew[2] = 0;
1440 foreach ($lineItems as $lineItem) {
1441 if (!empty($lineItem['auto_renew']) &&
1442 is_numeric($lineItem['auto_renew'])
1444 $autoRenew[$lineItem['auto_renew']] +
= $lineItem['line_total'];
1447 if (count($autoRenew) > 1) {
1448 $params['autoRenew'] = $autoRenew;