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
159 * In general we are trying to deprecate this parameter but some templates and processors still
160 * require it to denote whether the processor redirects offsite (notify) or not.
162 * The intent is that this knowledge should not be required and all contributions should
163 * be created in a pending state and updated based on the payment result without needing to be
164 * aware of the processor workings.
170 public $_contributeMode;
173 * Contribution page supports memberships
176 public $_useForMember;
182 public $_isBillingAddressRequiredForPayLater;
185 * Flag if email field exists in embedded profile
189 public $_emailExists = FALSE;
192 * Is this a backoffice form.
194 * Processors may display different options to backoffice users.
198 public $isBackOffice = FALSE;
201 * Payment instrument if for the transaction.
203 * This will generally be drawn from the payment processor and is ignored for
208 public $paymentInstrumentID;
211 * The contribution ID - is an option in the URL if you are making a payment against an existing contribution (an
212 * "invoice payment").
219 * Is the price set quick config.
222 public function isQuickConfig() {
223 return self
::$_quickConfig ??
FALSE;
227 * Set variables up before form is built.
229 * @throws \CRM_Contribute_Exception_InactiveContributionPageException
232 public function preProcess() {
234 // current contribution page id
235 $this->_id
= CRM_Utils_Request
::retrieve('id', 'Positive', $this);
236 $this->_ccid
= CRM_Utils_Request
::retrieve('ccid', 'Positive', $this);
238 // seems like the session is corrupted and/or we lost the id trail
239 // lets just bump this to a regular session error and redirect user to main page
240 $this->controller
->invalidKeyRedirect();
242 $this->_emailExists
= $this->get('emailExists');
244 // this was used prior to the cleverer this_>getContactID - unsure now
245 $this->_userID
= CRM_Core_Session
::getLoggedInContactID();
247 $this->_contactID
= $this->_membershipContactID
= $this->getContactID();
249 if ($this->_contactID
) {
250 $this->_mid
= CRM_Utils_Request
::retrieve('mid', 'Positive', $this);
252 $membership = new CRM_Member_DAO_Membership();
253 $membership->id
= $this->_mid
;
255 if ($membership->find(TRUE)) {
256 $this->_defaultMemTypeId
= $membership->membership_type_id
;
257 if ($membership->contact_id
!= $this->_contactID
) {
258 $validMembership = FALSE;
259 $organizations = CRM_Contact_BAO_Relationship
::getPermissionedContacts($this->_userID
, NULL, NULL, 'Organization');
260 if (!empty($organizations) && array_key_exists($membership->contact_id
, $organizations)) {
261 $this->_membershipContactID
= $membership->contact_id
;
262 $this->assign('membershipContactID', $this->_membershipContactID
);
263 $this->assign('membershipContactName', $organizations[$this->_membershipContactID
]['name']);
264 $validMembership = TRUE;
267 $membershipType = new CRM_Member_BAO_MembershipType();
268 $membershipType->id
= $membership->membership_type_id
;
269 if ($membershipType->find(TRUE)) {
270 // CRM-14051 - membership_type.relationship_type_id is a CTRL-A padded string w one or more ID values.
271 // Convert to comma separated list.
272 $inheritedRelTypes = implode(CRM_Utils_Array
::explodePadded($membershipType->relationship_type_id
), ',');
273 $permContacts = CRM_Contact_BAO_Relationship
::getPermissionedContacts($this->_userID
, $membershipType->relationship_type_id
);
274 if (array_key_exists($membership->contact_id
, $permContacts)) {
275 $this->_membershipContactID
= $membership->contact_id
;
276 $validMembership = TRUE;
280 if (!$validMembership) {
281 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');
286 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');
292 // we do not want to display recently viewed items, so turn off
293 $this->assign('displayRecent', FALSE);
296 $this->_action
= CRM_Utils_Request
::retrieve('action', 'String', $this, FALSE, 'add');
297 $this->assign('action', $this->_action
);
300 $this->_mode
= ($this->_action
== 1024) ?
'test' : 'live';
302 $this->_values
= $this->get('values');
303 $this->_fields
= $this->get('fields');
304 $this->_bltID
= $this->get('bltID');
305 $this->_paymentProcessor
= $this->get('paymentProcessor');
307 $this->_priceSetId
= $this->get('priceSetId');
308 $this->_priceSet
= $this->get('priceSet');
310 if (!$this->_values
) {
311 // get all the values from the dao object
315 CRM_Contribute_BAO_ContributionPage
::setValues($this->_id
, $this->_values
);
316 if (CRM_Financial_BAO_FinancialType
::isACLFinancialTypeStatus()
317 && !CRM_Core_Permission
::check('add contributions of type ' . CRM_Contribute_PseudoConstant
::financialType($this->_values
['financial_type_id']))
319 CRM_Core_Error
::statusBounce(ts('You do not have permission to access this page.'));
321 if (empty($this->_values
['is_active'])) {
322 throw new CRM_Contribute_Exception_InactiveContributionPageException(ts('The page you requested is currently unavailable.'), $this->_id
);
325 $endDate = CRM_Utils_Date
::processDate(CRM_Utils_Array
::value('end_date', $this->_values
));
326 $now = date('YmdHis');
327 if ($endDate && $endDate < $now) {
328 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
);
331 $startDate = CRM_Utils_Date
::processDate(CRM_Utils_Array
::value('start_date', $this->_values
));
332 if ($startDate && $startDate > $now) {
333 throw new CRM_Contribute_Exception_FutureContributionPageException(ts('The page you requested will be active from %1', [1 => CRM_Utils_Date
::customFormat($startDate)]), $this->_id
);
336 $this->assignBillingType();
338 // check for is_monetary status
339 $isPayLater = $this->_values
['is_pay_later'] ??
NULL;
340 if (!empty($this->_ccid
)) {
341 $this->_values
['financial_type_id'] = CRM_Core_DAO
::getFieldValue('CRM_Contribute_DAO_Contribution',
347 $this->_values
['is_pay_later'] = FALSE;
351 $this->setPayLaterLabel($this->_values
['pay_later_text']);
354 $this->_paymentProcessorIDs
= array_filter(explode(
355 CRM_Core_DAO
::VALUE_SEPARATOR
,
356 CRM_Utils_Array
::value('payment_processor', $this->_values
)
359 $this->assignPaymentProcessor($isPayLater);
363 $priceSetId = CRM_Price_BAO_PriceSet
::getFor('civicrm_contribution_page', $this->_id
);
364 CRM_Price_BAO_PriceSet
::initSet($this, 'civicrm_contribution_page', FALSE, $priceSetId);
366 // this avoids getting E_NOTICE errors in php
368 'amount_block_is_active',
369 'is_allow_other_amount',
372 foreach ($setNullFields as $f) {
373 if (!isset($this->_values
[$f])) {
374 $this->_values
[$f] = NULL;
378 //check if Membership Block is enabled, if Membership Fields are included in profile
379 //get membership section for this contribution page
380 $this->_membershipBlock
= CRM_Member_BAO_Membership
::getMembershipBlock($this->_id
);
381 $this->set('membershipBlock', $this->_membershipBlock
);
383 if (!empty($this->_values
['custom_pre_id'])) {
384 $preProfileType = CRM_Core_BAO_UFField
::getProfileType($this->_values
['custom_pre_id']);
387 if (!empty($this->_values
['custom_post_id'])) {
388 $postProfileType = CRM_Core_BAO_UFField
::getProfileType($this->_values
['custom_post_id']);
391 if (((isset($postProfileType) && $postProfileType === 'Membership') ||
392 (isset($preProfileType) && $preProfileType === 'Membership')
394 !$this->_membershipBlock
['is_active']
396 CRM_Core_Error
::statusBounce(ts('This page includes a Profile with Membership fields - but the Membership Block is NOT enabled. Please notify the site administrator.'));
399 $pledgeBlock = CRM_Pledge_BAO_PledgeBlock
::getPledgeBlock($this->_id
);
402 $this->_values
['pledge_block_id'] = $pledgeBlock['id'] ??
NULL;
403 $this->_values
['max_reminders'] = $pledgeBlock['max_reminders'] ??
NULL;
404 $this->_values
['initial_reminder_day'] = $pledgeBlock['initial_reminder_day'] ??
NULL;
405 $this->_values
['additional_reminder_day'] = $pledgeBlock['additional_reminder_day'] ??
NULL;
407 //set pledge id in values
408 $pledgeId = CRM_Utils_Request
::retrieve('pledgeId', 'Positive', $this);
410 //authenticate pledge user for pledge payment.
412 $this->_values
['pledge_id'] = $pledgeId;
414 //lets override w/ pledge campaign.
415 $this->_values
['campaign_id'] = CRM_Core_DAO
::getFieldValue('CRM_Pledge_DAO_Pledge',
419 self
::authenticatePledgeUser();
422 $this->set('values', $this->_values
);
423 $this->set('fields', $this->_fields
);
427 $pcpId = CRM_Utils_Request
::retrieve('pcpId', 'Positive', $this);
429 $pcp = CRM_PCP_BAO_PCP
::handlePcp($pcpId, 'contribute', $this->_values
);
430 $this->_pcpId
= $pcp['pcpId'];
431 $this->_pcpBlock
= $pcp['pcpBlock'];
432 $this->_pcpInfo
= $pcp['pcpInfo'];
435 // Link (button) for users to create their own Personal Campaign page
436 if ($linkText = CRM_PCP_BAO_PCP
::getPcpBlockStatus($this->_id
, 'contribute')) {
437 $linkTextUrl = CRM_Utils_System
::url('civicrm/contribute/campaign',
438 "action=add&reset=1&pageId={$this->_id}&component=contribute",
441 $this->assign('linkTextUrl', $linkTextUrl);
442 $this->assign('linkText', $linkText);
445 //set pledge block if block id is set
446 if (!empty($this->_values
['pledge_block_id'])) {
447 $this->assign('pledgeBlock', TRUE);
450 // check if one of the (amount , membership) blocks is active or not.
451 $this->_membershipBlock
= $this->get('membershipBlock');
453 if (!$this->_values
['amount_block_is_active'] &&
454 !$this->_membershipBlock
['is_active'] &&
457 CRM_Core_Error
::statusBounce(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.'));
460 if ($this->_values
['amount_block_is_active']) {
461 $this->set('amount_block_is_active', $this->_values
['amount_block_is_active']);
464 $this->_contributeMode
= $this->get('contributeMode');
465 $this->assign('contributeMode', $this->_contributeMode
);
467 //assigning is_monetary and is_email_receipt to template
468 $this->assign('is_monetary', $this->_values
['is_monetary']);
469 $this->assign('is_email_receipt', $this->_values
['is_email_receipt']);
470 $this->assign('bltID', $this->_bltID
);
472 //assign cancelSubscription URL to templates
473 $this->assign('cancelSubscriptionUrl',
474 CRM_Utils_Array
::value('cancelSubscriptionUrl', $this->_values
)
477 $title = !empty($this->_values
['frontend_title']) ?
$this->_values
['frontend_title'] : $this->_values
['title'];
479 $this->setTitle(($this->_pcpId ?
$this->_pcpInfo
['title'] : $title));
480 $this->_defaults
= [];
482 $this->_amount
= $this->get('amount');
483 // Assigning this to the template means it will be passed through to the payment form.
484 // This can, for example, by used by payment processors using client side encryption
485 $this->assign('currency', $this->getCurrency());
487 CRM_Contribute_BAO_Contribution_Utils
::overrideDefaultCurrency($this->_values
);
489 //lets allow user to override campaign.
490 $campID = CRM_Utils_Request
::retrieve('campID', 'Positive', $this);
491 if ($campID && CRM_Core_DAO
::getFieldValue('CRM_Campaign_DAO_Campaign', $campID)) {
492 $this->_values
['campaign_id'] = $campID;
495 //do check for cancel recurring and clean db, CRM-7696
496 if (CRM_Utils_Request
::retrieve('cancel', 'Boolean')) {
497 self
::cancelRecurring();
500 // check if billing block is required for pay later
501 if (!empty($this->_values
['is_pay_later'])) {
502 $this->_isBillingAddressRequiredForPayLater
= $this->_values
['is_billing_required'] ??
NULL;
503 $this->assign('isBillingAddressRequiredForPayLater', $this->_isBillingAddressRequiredForPayLater
);
508 * Set the default values.
510 public function setDefaultValues() {
511 return $this->_defaults
;
515 * Assign the minimal set of variables to the template.
517 public function assignToTemplate() {
518 $this->set('name', $this->assignBillingName($this->_params
));
520 $this->assign('paymentProcessor', $this->_paymentProcessor
);
529 $config = CRM_Core_Config
::singleton();
530 if (isset($this->_values
['is_recur']) && !empty($this->_paymentProcessor
['is_recur'])) {
531 $this->assign('is_recur_enabled', 1);
532 $vars = array_merge($vars, [
534 'frequency_interval',
540 if (in_array('CiviPledge', $config->enableComponents
) &&
541 CRM_Utils_Array
::value('is_pledge', $this->_params
) == 1
543 $this->assign('pledge_enabled', 1);
545 $vars = array_merge($vars, [
547 'pledge_frequency_interval',
548 'pledge_frequency_unit',
549 'pledge_installments',
553 // @todo - stop setting amount level in this function & call the CRM_Price_BAO_PriceSet::getAmountLevel
554 // function to get correct amount level consistently. Remove setting of the amount level in
555 // CRM_Price_BAO_PriceSet::processAmount. Extend the unit tests in CRM_Price_BAO_PriceSetTest
556 // to cover all variants.
557 if (isset($this->_params
['amount_other']) ||
isset($this->_params
['selectMembership'])) {
558 $this->_params
['amount_level'] = '';
561 foreach ($vars as $v) {
562 if (isset($this->_params
[$v])) {
563 if ($v == "amount" && $this->_params
[$v] === 0) {
564 $this->_params
[$v] = CRM_Utils_Money
::format($this->_params
[$v], NULL, NULL, TRUE);
566 $this->assign($v, $this->_params
[$v]);
570 $this->assign('address', CRM_Utils_Address
::getFormattedBillingAddressFieldsFromParameters(
575 if (!empty($this->_params
['onbehalf_profile_id']) && !empty($this->_params
['onbehalf'])) {
576 $this->assign('onBehalfName', $this->_params
['organization_name']);
577 $locTypeId = array_keys($this->_params
['onbehalf_location']['email']);
578 $this->assign('onBehalfEmail', $this->_params
['onbehalf_location']['email'][$locTypeId[0]]['email']);
580 $this->assignPaymentFields();
581 $this->assignEmailField();
583 // also assign the receipt_text
584 if (isset($this->_values
['receipt_text'])) {
585 $this->assign('receipt_text', $this->_values
['receipt_text']);
590 * Assign email variable in the template.
592 public function assignEmailField() {
593 //If email exist in a profile, the default billing email field is not loaded on the page.
594 //Hence, assign the existing location type email by iterating through the params.
595 if ($this->_emailExists
&& empty($this->_params
["email-{$this->_bltID}"])) {
596 foreach ($this->_params
as $key => $val) {
597 if (substr($key, 0, 6) === 'email-') {
598 $this->assign('email', $this->_params
[$key]);
604 $this->assign('email', CRM_Utils_Array
::value("email-{$this->_bltID}", $this->_params
));
609 * Add the custom fields.
612 * @param string $name
613 * @param bool $viewOnly
614 * @param null $profileContactType
615 * @param array $fieldTypes
617 public function buildCustom($id, $name, $viewOnly = FALSE, $profileContactType = NULL, $fieldTypes = NULL) {
619 $contactID = $this->getContactID();
621 // we don't allow conflicting fields to be
622 // configured via profile - CRM 2100
629 'non_deductible_amount' => 1,
632 'contribution_status_id' => 1,
633 // @todo replace payment_instrument with payment instrument id.
634 // both are available now but the id field is the most consistent.
635 'payment_instrument' => 1,
636 'payment_instrument_id' => 1,
637 'contribution_check_number' => 1,
638 'financial_type' => 1,
641 $fields = CRM_Core_BAO_UFGroup
::getFields($id, FALSE, CRM_Core_Action
::ADD
, NULL, NULL, FALSE,
642 NULL, FALSE, NULL, CRM_Core_Permission
::CREATE
, NULL
646 // determine if email exists in profile so we know if we need to manually insert CRM-2888, CRM-15067
647 foreach ($fields as $key => $field) {
648 if (substr($key, 0, 6) == 'email-' &&
649 !in_array($profileContactType, ['honor', 'onbehalf'])
651 $this->_emailExists
= TRUE;
652 $this->set('emailExists', TRUE);
656 if (array_intersect_key($fields, $fieldsToIgnore)) {
657 $fields = array_diff_key($fields, $fieldsToIgnore);
658 CRM_Core_Session
::setStatus(ts('Some of the profile fields cannot be configured for this page.'), ts('Warning'), 'alert');
661 //remove common fields only if profile is not configured for onbehalf/honor
662 if (!in_array($profileContactType, ['honor', 'onbehalf'])) {
663 $fields = array_diff_key($fields, $this->_fields
);
666 CRM_Core_BAO_Address
::checkContactSharedAddressFields($fields, $contactID);
668 // fetch file preview when not submitted yet, like in online contribution Confirm and ThankYou page
669 $viewOnlyFileValues = empty($profileContactType) ?
[] : [$profileContactType => []];
670 foreach ($fields as $key => $field) {
672 isset($field['data_type']) &&
673 $field['data_type'] == 'File' ||
($viewOnly && $field['name'] == 'image_URL')
675 //retrieve file value from submitted values on basis of $profileContactType
676 $fileValue = $this->_params
[$key] ??
NULL;
677 if (!empty($profileContactType) && !empty($this->_params
[$profileContactType])) {
678 $fileValue = $this->_params
[$profileContactType][$key] ??
NULL;
682 $path = $fileValue['name'] ??
NULL;
683 $fileType = $fileValue['type'] ??
NULL;
684 $fileValue = CRM_Utils_File
::getFileURL($path, $fileType);
687 // format custom file value fetched from submitted value
688 if ($profileContactType) {
689 $viewOnlyFileValues[$profileContactType][$key] = $fileValue;
692 $viewOnlyFileValues[$key] = $fileValue;
695 // On viewOnly use-case (as in online contribution Confirm page) we no longer need to set
696 // required property because being required file is already uploaded while registration
697 $field['is_required'] = FALSE;
699 if ($profileContactType) {
700 //Since we are showing honoree name separately so we are removing it from honoree profile just for display
701 if ($profileContactType == 'honor') {
702 $honoreeNamefields = [
710 if (in_array($field['name'], $honoreeNamefields)) {
711 unset($fields[$field['name']]);
715 if (!empty($fieldTypes) && in_array($field['field_type'], $fieldTypes)) {
716 CRM_Core_BAO_UFGroup
::buildProfile(
719 CRM_Profile_Form
::MODE_CREATE
,
724 $this->_fields
[$profileContactType][$key] = $field;
727 unset($fields[$key]);
731 CRM_Core_BAO_UFGroup
::buildProfile(
734 CRM_Profile_Form
::MODE_CREATE
,
738 $this->_fields
[$key] = $field;
740 // CRM-11316 Is ReCAPTCHA enabled for this profile AND is this an anonymous visitor
741 if ($field['add_captcha'] && !$this->_userID
) {
746 $this->assign($name, $fields);
748 if ($profileContactType && count($viewOnlyFileValues[$profileContactType])) {
749 $this->assign('viewOnlyPrefixFileValues', $viewOnlyFileValues);
751 elseif (count($viewOnlyFileValues)) {
752 $this->assign('viewOnlyFileValues', $viewOnlyFileValues);
755 if ($addCaptcha && !$viewOnly) {
756 CRM_Utils_ReCAPTCHA
::enableCaptchaOnForm($this);
763 * Assign payment field information to the template.
765 * @throws \CRM_Core_Exception
766 * @throws \CiviCRM_API3_Exception
768 public function assignPaymentFields() {
771 if ($this->_amount
> 0.0) {
774 elseif (!empty($this->_params
['selectMembership'])) {
775 $memFee = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType', $this->_params
['selectMembership'], 'minimum_fee');
781 // The concept of contributeMode is deprecated.
782 // The payment processor object can provide info about the fields it shows.
783 if ($isMonetary && is_a($this->_paymentProcessor
['object'], 'CRM_Core_Payment')) {
784 /** @var \CRM_Core_Payment $paymentProcessorObject */
785 $paymentProcessorObject = $this->_paymentProcessor
['object'];
787 $paymentFields = $paymentProcessorObject->getPaymentFormFields();
788 foreach ($paymentFields as $index => $paymentField) {
789 if (!isset($this->_params
[$paymentField])) {
790 unset($paymentFields[$index]);
793 if ($paymentField === 'credit_card_exp_date') {
794 $date = CRM_Utils_Date
::format(CRM_Utils_Array
::value('credit_card_exp_date', $this->_params
));
795 $date = CRM_Utils_Date
::mysqlToIso($date);
796 $this->assign('credit_card_exp_date', $date);
798 elseif ($paymentField === 'credit_card_number') {
799 $this->assign('credit_card_number',
800 CRM_Utils_System
::mungeCreditCard(CRM_Utils_Array
::value('credit_card_number', $this->_params
))
803 elseif ($paymentField === 'credit_card_type') {
804 $this->assign('credit_card_type', CRM_Core_PseudoConstant
::getLabel(
805 'CRM_Core_BAO_FinancialTrxn',
807 CRM_Core_PseudoConstant
::getKey('CRM_Core_BAO_FinancialTrxn', 'card_type_id', $this->_params
['credit_card_type'])
811 $this->assign($paymentField, $this->_params
[$paymentField]);
814 $this->assign('paymentFieldsetLabel', CRM_Core_Payment_Form
::getPaymentLabel($paymentProcessorObject));
815 $this->assign('paymentFields', $paymentFields);
821 * Add onbehalf/honoree profile fields and native module fields.
824 * @param CRM_Core_Form $form
826 * @throws \API_Exception
827 * @throws \CRM_Core_Exception
828 * @throws \CiviCRM_API3_Exception
830 public function buildComponentForm($id, $form): void
{
835 $contactID = $this->getContactID();
837 foreach (['soft_credit', 'on_behalf'] as $module) {
838 if ($module === 'soft_credit') {
839 if (empty($form->_values
['honoree_profile_id'])) {
843 if (!CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_UFGroup', $form->_values
['honoree_profile_id'], 'is_active')) {
844 CRM_Core_Error
::statusBounce(ts('This contribution page has been configured for contribution on behalf of honoree and the selected honoree profile is either disabled or not found.'));
847 $profileContactType = CRM_Core_BAO_UFGroup
::getContactType($form->_values
['honoree_profile_id']);
848 $requiredProfileFields = [
849 'Individual' => ['first_name', 'last_name'],
850 'Organization' => ['organization_name', 'email'],
851 'Household' => ['household_name', 'email'],
853 $validProfile = CRM_Core_BAO_UFGroup
::checkValidProfile($form->_values
['honoree_profile_id'], $requiredProfileFields[$profileContactType]);
854 if (!$validProfile) {
855 CRM_Core_Error
::statusBounce(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.'));
858 foreach (['honor_block_title', 'honor_block_text'] as $name) {
859 $form->assign($name, $form->_values
[$name]);
862 $softCreditTypes = CRM_Core_OptionGroup
::values("soft_credit_type", FALSE);
864 // radio button for Honor Type
865 foreach ($form->_values
['soft_credit_types'] as $value) {
866 $honorTypes[$value] = $softCreditTypes[$value];
868 $form->addRadio('soft_credit_type_id', NULL, $honorTypes, ['allowClear' => TRUE]);
870 $honoreeProfileFields = CRM_Core_BAO_UFGroup
::getFields(
871 $this->_values
['honoree_profile_id'], FALSE,
875 NULL, CRM_Core_Permission
::CREATE
877 $form->assign('honoreeProfileFields', $honoreeProfileFields);
879 // add the form elements
880 foreach ($honoreeProfileFields as $name => $field) {
881 // If soft credit type is not chosen then make omit requiredness from honoree profile fields
882 if (count($form->_submitValues
) &&
883 empty($form->_submitValues
['soft_credit_type_id']) &&
884 !empty($field['is_required'])
886 $field['is_required'] = FALSE;
888 CRM_Core_BAO_UFGroup
::buildProfile($form, $field, CRM_Profile_Form
::MODE_CREATE
, NULL, FALSE, FALSE, NULL, 'honor');
892 if (empty($form->_values
['onbehalf_profile_id'])) {
896 if (!CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_UFGroup', $form->_values
['onbehalf_profile_id'], 'is_active')) {
897 CRM_Core_Error
::statusBounce(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.'));
900 $member = CRM_Member_BAO_Membership
::getMembershipBlock($form->_id
);
901 if (empty($member['is_active'])) {
902 $msg = ts('Mixed profile not allowed for on behalf of registration/sign up.');
903 $onBehalfProfile = CRM_Core_BAO_UFGroup
::profileGroups($form->_values
['onbehalf_profile_id']);
911 if (in_array($contactType, $onBehalfProfile) &&
912 (in_array('Membership', $onBehalfProfile) ||
913 in_array('Contribution', $onBehalfProfile)
916 CRM_Core_Error
::statusBounce($msg);
922 // retrieve all permissioned organizations of contact $contactID
923 $organizations = CRM_Contact_BAO_Relationship
::getPermissionedContacts($contactID, NULL, NULL, 'Organization');
925 if (count($organizations)) {
926 // Related org url - pass checksum if needed
928 'ufId' => $form->_values
['onbehalf_profile_id'],
931 if (!empty($_GET['cs'])) {
933 'ufId' => $form->_values
['onbehalf_profile_id'],
934 'uid' => $this->_contactID
,
939 $locDataURL = CRM_Utils_System
::url('civicrm/ajax/permlocation', $args, FALSE, NULL, FALSE);
940 $form->assign('locDataURL', $locDataURL);
942 if (count($organizations) > 0) {
943 $form->add('select', 'onbehalfof_id', '', CRM_Utils_Array
::collect('name', $organizations));
946 0 => ts('Select an existing organization'),
947 1 => ts('Enter a new organization'),
949 $form->addRadio('org_option', ts('options'), $orgOptions);
950 $form->setDefaults(['org_option' => 0]);
954 $form->assign('fieldSetTitle', CRM_Core_BAO_UFGroup
::getFrontEndTitle($form->_values
['onbehalf_profile_id']));
956 if (!empty($form->_values
['is_for_organization'])) {
957 if ($form->_values
['is_for_organization'] == 2) {
958 $form->assign('onBehalfRequired', TRUE);
961 $form->addElement('checkbox', 'is_for_organization',
962 $form->_values
['for_organization'],
968 $profileFields = CRM_Core_BAO_UFGroup
::getFields(
969 $form->_values
['onbehalf_profile_id'],
970 FALSE, CRM_Core_Action
::VIEW
, NULL,
971 NULL, FALSE, NULL, FALSE, NULL,
972 CRM_Core_Permission
::CREATE
, NULL
975 $form->assign('onBehalfOfFields', $profileFields);
976 if (!empty($form->_submitValues
['onbehalf'])) {
977 if (!empty($form->_submitValues
['onbehalfof_id'])) {
978 $form->assign('submittedOnBehalf', $form->_submitValues
['onbehalfof_id']);
980 $form->assign('submittedOnBehalfInfo', json_encode(str_replace('"', '\"', $form->_submitValues
['onbehalf']), JSON_HEX_APOS
));
983 $fieldTypes = ['Contact', 'Organization'];
984 if (!empty($form->_membershipBlock
)) {
985 $fieldTypes = array_merge($fieldTypes, ['Membership']);
987 $contactSubType = CRM_Contact_BAO_ContactType
::subTypes('Organization');
988 $fieldTypes = array_merge($fieldTypes, $contactSubType);
990 foreach ($profileFields as $name => $field) {
991 if (in_array($field['field_type'], $fieldTypes)) {
992 [$prefixName, $index] = CRM_Utils_System
::explode('-', $name, 2);
993 if (in_array($prefixName, ['organization_name', 'email']) && empty($field['is_required'])) {
994 $field['is_required'] = 1;
996 if (count($form->_submitValues
) &&
997 empty($form->_submitValues
['is_for_organization']) &&
998 $form->_values
['is_for_organization'] == 1 &&
999 !empty($field['is_required'])
1001 $field['is_required'] = FALSE;
1003 CRM_Core_BAO_UFGroup
::buildProfile($form, $field, NULL, NULL, FALSE, 'onbehalf', NULL, 'onbehalf');
1012 * Check template file exists.
1014 * @param string $suffix
1016 * @return null|string
1018 public function checkTemplateFileExists($suffix = NULL) {
1020 $templateFile = "CRM/Contribute/Form/Contribution/{$this->_id}/{$this->_name}.{$suffix}tpl";
1021 $template = CRM_Core_Form
::getTemplate();
1022 if ($template->template_exists($templateFile)) {
1023 return $templateFile;
1030 * Use the form name to create the tpl file name.
1034 public function getTemplateFileName() {
1035 $fileName = $this->checkTemplateFileExists();
1036 return $fileName ?
: parent
::getTemplateFileName();
1040 * Add the extra.tpl in.
1042 * Default extra tpl file basically just replaces .tpl with .extra.tpl
1043 * i.e. we do not override - why isn't this done at the CRM_Core_Form level?
1047 public function overrideExtraTemplateFileName() {
1048 $fileName = $this->checkTemplateFileExists('extra.');
1049 return $fileName ?
$fileName : parent
::overrideExtraTemplateFileName();
1053 * Authenticate pledge user during online payment.
1055 * @throws \CRM_Core_Exception
1057 public function authenticatePledgeUser() {
1058 //get the userChecksum and contact id
1059 $userChecksum = CRM_Utils_Request
::retrieve('cs', 'String', $this);
1060 $contactID = CRM_Utils_Request
::retrieve('cid', 'Positive', $this);
1062 //get pledge status and contact id
1064 $pledgeParams = ['id' => $this->_values
['pledge_id']];
1065 $returnProperties = ['contact_id', 'status_id'];
1066 CRM_Core_DAO
::commonRetrieve('CRM_Pledge_DAO_Pledge', $pledgeParams, $pledgeValues, $returnProperties);
1069 $allStatus = CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name');
1071 array_search('Pending', $allStatus),
1072 array_search('In Progress', $allStatus),
1073 array_search('Overdue', $allStatus),
1077 if ($this->_userID
&&
1078 $this->_userID
== $pledgeValues['contact_id']
1080 //check for authenticated user.
1083 elseif ($userChecksum && $pledgeValues['contact_id']) {
1084 //check for anonymous user.
1085 $validUser = CRM_Contact_BAO_Contact_Utils
::validChecksum($pledgeValues['contact_id'], $userChecksum);
1087 //make sure cid is same as pledge contact id
1088 if ($validUser && ($pledgeValues['contact_id'] != $contactID)) {
1094 CRM_Core_Error
::statusBounce(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."));
1097 //check for valid pledge status.
1098 if (!in_array($pledgeValues['status_id'], $validStatus)) {
1099 CRM_Core_Error
::statusBounce(ts('Oops. You cannot make a payment for this pledge - pledge status is %1.', [1 => CRM_Utils_Array
::value($pledgeValues['status_id'], $allStatus)]));
1104 * Cancel recurring contributions.
1106 * In case user cancel recurring contribution,
1107 * When we get the control back from payment gate way
1108 * lets delete the recurring and related contribution.
1110 * @throws \CRM_Core_Exception
1112 public function cancelRecurring() {
1113 $isCancel = CRM_Utils_Request
::retrieve('cancel', 'Boolean');
1115 $isRecur = CRM_Utils_Request
::retrieve('isRecur', 'Boolean');
1116 $recurId = CRM_Utils_Request
::retrieve('recurId', 'Positive');
1117 //clean db for recurring contribution.
1118 if ($isRecur && $recurId) {
1119 CRM_Contribute_BAO_ContributionRecur
::deleteRecurContribution($recurId);
1121 $contribId = CRM_Utils_Request
::retrieve('contribId', 'Positive');
1123 CRM_Contribute_BAO_Contribution
::deleteContribution($contribId);
1129 * Determine if recurring parameters need to be added to the form parameters.
1132 * - frequency_interval
1135 * For membership this is based on the membership type.
1137 * This needs to be done before processing the pre-approval redirect where relevant on the main page or before any payment processing.
1139 * Arguably the form should start to build $this->_params in the pre-process main page & use that array consistently throughout.
1141 protected function setRecurringMembershipParams() {
1142 $selectedMembershipTypeID = $this->_params
['selectMembership'] ??
NULL;
1143 if ($selectedMembershipTypeID) {
1144 // @todo the price_x fields will ALWAYS allow us to determine the membership - so we should ignore
1145 // 'selectMembership' and calculate from the price_x fields so we have one method that always works
1146 // this is lazy & only catches when selectMembership is set, but the worst of all worlds would be to fix
1147 // this with an else (calculate for price set).
1148 $membershipTypes = CRM_Price_BAO_PriceSet
::getMembershipTypesFromPriceSet($this->_priceSetId
);
1149 if (in_array($selectedMembershipTypeID, $membershipTypes['autorenew_required'])
1150 ||
(in_array($selectedMembershipTypeID, $membershipTypes['autorenew_optional']) &&
1151 !empty($this->_params
['is_recur']))
1153 $this->_params
['auto_renew'] = TRUE;
1156 if ((!empty($this->_params
['selectMembership']) ||
!empty($this->_params
['priceSetId']))
1157 && !empty($this->_paymentProcessor
['is_recur']) &&
1158 !empty($this->_params
['auto_renew'])
1159 && empty($this->_params
['is_recur']) && empty($this->_params
['frequency_interval'])
1162 $this->_params
['is_recur'] = $this->_values
['is_recur'] = 1;
1163 // check if price set is not quick config
1164 if (!empty($this->_params
['priceSetId']) && !CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet', $this->_params
['priceSetId'], 'is_quick_config')) {
1165 list($this->_params
['frequency_interval'], $this->_params
['frequency_unit']) = CRM_Price_BAO_PriceSet
::getRecurDetails($this->_params
['priceSetId']);
1168 // FIXME: set interval and unit based on selected membership type
1169 $this->_params
['frequency_interval'] = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType',
1170 $this->_params
['selectMembership'], 'duration_interval'
1172 $this->_params
['frequency_unit'] = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType',
1173 $this->_params
['selectMembership'], 'duration_unit'
1180 * Get the payment processor object for the submission, returning the manual one for offline payments.
1182 * @return CRM_Core_Payment
1184 protected function getPaymentProcessorObject() {
1185 if (!empty($this->_paymentProcessor
)) {
1186 return $this->_paymentProcessor
['object'];
1188 return new CRM_Core_Payment_Manual();
1192 * Get the amount for the main contribution.
1194 * The goal is to expand this function so that all the argy-bargy of figuring out the amount
1195 * winds up here as the main spaghetti shrinks.
1197 * If there is a separate membership contribution this is the 'other one'. Otherwise there
1204 * @throws \CiviCRM_API3_Exception
1206 protected function getMainContributionAmount($params) {
1207 if (!empty($params['selectMembership'])) {
1208 if (empty($params['amount']) && !$this->_separateMembershipPayment
) {
1209 return CRM_Member_BAO_MembershipType
::getMembershipType($params['selectMembership'])['minimum_fee'] ??
0;
1212 return $params['amount'] ??
0;
1216 * Wrapper for processAmount that also sets autorenew.
1219 * This is the output of the function CRM_Price_BAO_PriceSet::getSetDetail($priceSetID, FALSE, FALSE);
1220 * And, it would make sense to introduce caching into that function and call it from here rather than
1221 * require the $fields array which is passed from pillar to post around the form in order to pass it in here.
1222 * @param array $params
1223 * Params reflecting form input e.g with fields 'price_5' => 7, 'price_8' => array(7, 8)
1225 * Line item array to be altered.
1226 * @param int $priceSetID
1228 public function processAmountAndGetAutoRenew($fields, &$params, &$lineItems, $priceSetID = NULL) {
1229 CRM_Price_BAO_PriceSet
::processAmount($fields, $params, $lineItems, $priceSetID);
1231 $autoRenew[0] = $autoRenew[1] = $autoRenew[2] = 0;
1232 foreach ($lineItems as $lineItem) {
1233 if (!empty($lineItem['auto_renew']) &&
1234 is_numeric($lineItem['auto_renew'])
1236 $autoRenew[$lineItem['auto_renew']] +
= $lineItem['line_total'];
1239 if (count($autoRenew) > 1) {
1240 $params['autoRenew'] = $autoRenew;