3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2018 |
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-2018
35 * This class generates form components for processing a contribution.
37 class CRM_Contribute_Form_ContributionBase
extends CRM_Core_Form
{
40 * The id of the contribution page that we are processing.
47 * The mode that we are in
55 * The contact id related to a membership
59 public $_membershipContactID;
62 * The values for the contribution db object
69 * The paymentProcessor attributes for this page
73 public $_paymentProcessor;
75 public $_paymentObject = NULL;
78 * The membership block for this page
82 public $_membershipBlock = NULL;
85 * Does this form support a separate membership payment
88 protected $_separateMembershipPayment;
91 * The params submitted by the form and computed by the app
95 public $_params = array();
98 * The fields involved in this contribution page
102 public $_fields = array();
105 * The billing location id for this contribution page.
112 * Cache the amount to make things easier
140 * The contact id of the person for whom membership is being added or renewed based on the cid in the url,
141 * checksum, or session
149 * The Membership ID for membership renewal
153 public $_membershipId;
156 * Price Set ID, if the new price set method is used
163 * Array of fields for the price set
172 * Contribution mode e.g express for payment express, notify for off-site + notification back to CiviCRM
175 public $_contributeMode;
178 * Contribution page supports memberships
181 public $_useForMember;
188 public $_isBillingAddressRequiredForPayLater;
191 * Flag if email field exists in embedded profile
195 public $_emailExists = FALSE;
198 * Is this a backoffice form
199 * (this will affect whether paypal express code is displayed)
202 public $isBackOffice = FALSE;
205 * Payment instrument if for the transaction.
207 * This will generally be drawn from the payment processor and is ignored for
212 public $paymentInstrumentID;
215 * Set variables up before form is built.
217 * @throws \CRM_Contribute_Exception_InactiveContributionPageException
220 public function preProcess() {
222 // current contribution page id
223 $this->_id
= CRM_Utils_Request
::retrieve('id', 'Positive', $this);
224 $this->_ccid
= CRM_Utils_Request
::retrieve('ccid', 'Positive', $this);
226 // seems like the session is corrupted and/or we lost the id trail
227 // lets just bump this to a regular session error and redirect user to main page
228 $this->controller
->invalidKeyRedirect();
230 $this->_emailExists
= $this->get('emailExists');
232 // this was used prior to the cleverer this_>getContactID - unsure now
233 $this->_userID
= CRM_Core_Session
::singleton()->getLoggedInContactID();
235 $this->_contactID
= $this->_membershipContactID
= $this->getContactID();
237 if ($this->_contactID
) {
238 $this->_mid
= CRM_Utils_Request
::retrieve('mid', 'Positive', $this);
240 $membership = new CRM_Member_DAO_Membership();
241 $membership->id
= $this->_mid
;
243 if ($membership->find(TRUE)) {
244 $this->_defaultMemTypeId
= $membership->membership_type_id
;
245 if ($membership->contact_id
!= $this->_contactID
) {
246 $validMembership = FALSE;
247 $organizations = CRM_Contact_BAO_Relationship
::getPermissionedContacts($this->_userID
, NULL, NULL, 'Organization');
248 if (!empty($organizations) && array_key_exists($membership->contact_id
, $organizations)) {
249 $this->_membershipContactID
= $membership->contact_id
;
250 $this->assign('membershipContactID', $this->_membershipContactID
);
251 $this->assign('membershipContactName', $organizations[$this->_membershipContactID
]['name']);
252 $validMembership = TRUE;
255 $membershipType = new CRM_Member_BAO_MembershipType();
256 $membershipType->id
= $membership->membership_type_id
;
257 if ($membershipType->find(TRUE)) {
258 // CRM-14051 - membership_type.relationship_type_id is a CTRL-A padded string w one or more ID values.
259 // Convert to comma separated list.
260 $inheritedRelTypes = implode(CRM_Utils_Array
::explodePadded($membershipType->relationship_type_id
), ',');
261 $permContacts = CRM_Contact_BAO_Relationship
::getPermissionedContacts($this->_userID
, $membershipType->relationship_type_id
);
262 if (array_key_exists($membership->contact_id
, $permContacts)) {
263 $this->_membershipContactID
= $membership->contact_id
;
264 $validMembership = TRUE;
268 if (!$validMembership) {
269 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');
274 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');
280 // we do not want to display recently viewed items, so turn off
281 $this->assign('displayRecent', FALSE);
282 // Contribution page values are cleared from session, so can't use normal Printer Friendly view.
283 // Use Browser Print instead.
284 $this->assign('browserPrint', TRUE);
287 $this->_action
= CRM_Utils_Request
::retrieve('action', 'String', $this, FALSE, 'add');
288 $this->assign('action', $this->_action
);
291 $this->_mode
= ($this->_action
== 1024) ?
'test' : 'live';
293 $this->_values
= $this->get('values');
294 $this->_fields
= $this->get('fields');
295 $this->_bltID
= $this->get('bltID');
296 $this->_paymentProcessor
= $this->get('paymentProcessor');
298 $this->_priceSetId
= $this->get('priceSetId');
299 $this->_priceSet
= $this->get('priceSet');
301 if (!$this->_values
) {
302 // get all the values from the dao object
303 $this->_values
= array();
304 $this->_fields
= array();
306 CRM_Contribute_BAO_ContributionPage
::setValues($this->_id
, $this->_values
);
307 if (CRM_Financial_BAO_FinancialType
::isACLFinancialTypeStatus()
308 && !CRM_Core_Permission
::check('add contributions of type ' . CRM_Contribute_PseudoConstant
::financialType($this->_values
['financial_type_id']))
310 CRM_Core_Error
::fatal(ts('You do not have permission to access this page.'));
312 if (empty($this->_values
['is_active'])) {
313 throw new CRM_Contribute_Exception_InactiveContributionPageException(ts('The page you requested is currently unavailable.'), $this->_id
);
316 $endDate = CRM_Utils_Date
::processDate(CRM_Utils_Array
::value('end_date', $this->_values
));
317 $now = date('YmdHis');
318 if ($endDate && $endDate < $now) {
319 throw new CRM_Contribute_Exception_PastContributionPageException(ts('The page you requested has past its end date on ' . CRM_Utils_Date
::customFormat($endDate)), $this->_id
);
322 $startDate = CRM_Utils_Date
::processDate(CRM_Utils_Array
::value('start_date', $this->_values
));
323 if ($startDate && $startDate > $now) {
324 throw new CRM_Contribute_Exception_FutureContributionPageException(ts('The page you requested will be active from ' . CRM_Utils_Date
::customFormat($startDate)), $this->_id
);
327 $this->assignBillingType();
329 // check for is_monetary status
330 $isMonetary = CRM_Utils_Array
::value('is_monetary', $this->_values
);
331 $isPayLater = CRM_Utils_Array
::value('is_pay_later', $this->_values
);
332 if (!empty($this->_ccid
)) {
333 $this->_values
['financial_type_id'] = CRM_Core_DAO
::getFieldValue('CRM_Contribute_DAO_Contribution',
339 $this->_values
['is_pay_later'] = FALSE;
344 $this->_paymentProcessorIDs
= array_filter(explode(
345 CRM_Core_DAO
::VALUE_SEPARATOR
,
346 CRM_Utils_Array
::value('payment_processor', $this->_values
)
349 $this->assignPaymentProcessor($isPayLater);
354 CRM_Price_BAO_PriceSet
::initSet($this, $this->_id
, 'civicrm_contribution_page');
356 // this avoids getting E_NOTICE errors in php
357 $setNullFields = array(
358 'amount_block_is_active',
359 'is_allow_other_amount',
362 foreach ($setNullFields as $f) {
363 if (!isset($this->_values
[$f])) {
364 $this->_values
[$f] = NULL;
368 //check if Membership Block is enabled, if Membership Fields are included in profile
369 //get membership section for this contribution page
370 $this->_membershipBlock
= CRM_Member_BAO_Membership
::getMembershipBlock($this->_id
);
371 $this->set('membershipBlock', $this->_membershipBlock
);
373 if (!empty($this->_values
['custom_pre_id'])) {
374 $preProfileType = CRM_Core_BAO_UFField
::getProfileType($this->_values
['custom_pre_id']);
377 if (!empty($this->_values
['custom_post_id'])) {
378 $postProfileType = CRM_Core_BAO_UFField
::getProfileType($this->_values
['custom_post_id']);
381 if (((isset($postProfileType) && $postProfileType == 'Membership') ||
382 (isset($preProfileType) && $preProfileType == 'Membership')
384 !$this->_membershipBlock
['is_active']
386 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.'));
389 $pledgeBlock = CRM_Pledge_BAO_PledgeBlock
::getPledgeBlock($this->_id
);
392 $this->_values
['pledge_block_id'] = CRM_Utils_Array
::value('id', $pledgeBlock);
393 $this->_values
['max_reminders'] = CRM_Utils_Array
::value('max_reminders', $pledgeBlock);
394 $this->_values
['initial_reminder_day'] = CRM_Utils_Array
::value('initial_reminder_day', $pledgeBlock);
395 $this->_values
['additional_reminder_day'] = CRM_Utils_Array
::value('additional_reminder_day', $pledgeBlock);
397 //set pledge id in values
398 $pledgeId = CRM_Utils_Request
::retrieve('pledgeId', 'Positive', $this);
400 //authenticate pledge user for pledge payment.
402 $this->_values
['pledge_id'] = $pledgeId;
404 //lets override w/ pledge campaign.
405 $this->_values
['campaign_id'] = CRM_Core_DAO
::getFieldValue('CRM_Pledge_DAO_Pledge',
409 self
::authenticatePledgeUser();
412 $this->set('values', $this->_values
);
413 $this->set('fields', $this->_fields
);
417 $pcpId = CRM_Utils_Request
::retrieve('pcpId', 'Positive', $this);
419 $pcp = CRM_PCP_BAO_PCP
::handlePcp($pcpId, 'contribute', $this->_values
);
420 $this->_pcpId
= $pcp['pcpId'];
421 $this->_pcpBlock
= $pcp['pcpBlock'];
422 $this->_pcpInfo
= $pcp['pcpInfo'];
425 // Link (button) for users to create their own Personal Campaign page
426 if ($linkText = CRM_PCP_BAO_PCP
::getPcpBlockStatus($this->_id
, 'contribute')) {
427 $linkTextUrl = CRM_Utils_System
::url('civicrm/contribute/campaign',
428 "action=add&reset=1&pageId={$this->_id}&component=contribute",
431 $this->assign('linkTextUrl', $linkTextUrl);
432 $this->assign('linkText', $linkText);
435 //set pledge block if block id is set
436 if (!empty($this->_values
['pledge_block_id'])) {
437 $this->assign('pledgeBlock', TRUE);
440 // check if one of the (amount , membership) blocks is active or not.
441 $this->_membershipBlock
= $this->get('membershipBlock');
443 if (!$this->_values
['amount_block_is_active'] &&
444 !$this->_membershipBlock
['is_active'] &&
447 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.'));
450 if ($this->_values
['amount_block_is_active']) {
451 $this->set('amount_block_is_active', $this->_values
['amount_block_is_active']);
454 $this->_contributeMode
= $this->get('contributeMode');
455 $this->assign('contributeMode', $this->_contributeMode
);
457 //assigning is_monetary and is_email_receipt to template
458 $this->assign('is_monetary', $this->_values
['is_monetary']);
459 $this->assign('is_email_receipt', $this->_values
['is_email_receipt']);
460 $this->assign('bltID', $this->_bltID
);
462 //assign cancelSubscription URL to templates
463 $this->assign('cancelSubscriptionUrl',
464 CRM_Utils_Array
::value('cancelSubscriptionUrl', $this->_values
)
467 // assigning title to template in case someone wants to use it, also setting CMS page title
469 $this->assign('title', $this->_pcpInfo
['title']);
470 CRM_Utils_System
::setTitle($this->_pcpInfo
['title']);
473 $this->assign('title', $this->_values
['title']);
474 CRM_Utils_System
::setTitle($this->_values
['title']);
476 $this->_defaults
= array();
478 $this->_amount
= $this->get('amount');
481 $config = CRM_Core_Config
::singleton();
482 $config->defaultCurrency
= CRM_Utils_Array
::value('currency',
484 $config->defaultCurrency
487 //lets allow user to override campaign.
488 $campID = CRM_Utils_Request
::retrieve('campID', 'Positive', $this);
489 if ($campID && CRM_Core_DAO
::getFieldValue('CRM_Campaign_DAO_Campaign', $campID)) {
490 $this->_values
['campaign_id'] = $campID;
493 //do check for cancel recurring and clean db, CRM-7696
494 if (CRM_Utils_Request
::retrieve('cancel', 'Boolean')) {
495 self
::cancelRecurring();
498 // check if billing block is required for pay later
499 if (CRM_Utils_Array
::value('is_pay_later', $this->_values
)) {
500 $this->_isBillingAddressRequiredForPayLater
= CRM_Utils_Array
::value('is_billing_required', $this->_values
);
501 $this->assign('isBillingAddressRequiredForPayLater', $this->_isBillingAddressRequiredForPayLater
);
506 * Set the default values.
508 public function setDefaultValues() {
509 return $this->_defaults
;
513 * Assign the minimal set of variables to the template.
515 public function assignToTemplate() {
516 $this->set('name', $this->assignBillingName($this->_params
));
518 $this->assign('paymentProcessor', $this->_paymentProcessor
);
527 $config = CRM_Core_Config
::singleton();
528 if (isset($this->_values
['is_recur']) && !empty($this->_paymentProcessor
['is_recur'])) {
529 $this->assign('is_recur_enabled', 1);
530 $vars = array_merge($vars, array(
532 'frequency_interval',
538 if (in_array('CiviPledge', $config->enableComponents
) &&
539 CRM_Utils_Array
::value('is_pledge', $this->_params
) == 1
541 $this->assign('pledge_enabled', 1);
543 $vars = array_merge($vars, array(
545 'pledge_frequency_interval',
546 'pledge_frequency_unit',
547 'pledge_installments',
551 // @todo - stop setting amount level in this function & call the CRM_Price_BAO_PriceSet::getAmountLevel
552 // function to get correct amount level consistently. Remove setting of the amount level in
553 // CRM_Price_BAO_PriceSet::processAmount. Extend the unit tests in CRM_Price_BAO_PriceSetTest
554 // to cover all variants.
555 if (isset($this->_params
['amount_other']) ||
isset($this->_params
['selectMembership'])) {
556 $this->_params
['amount_level'] = '';
559 foreach ($vars as $v) {
560 if (isset($this->_params
[$v])) {
561 if ($v == "amount" && $this->_params
[$v] === 0) {
562 $this->_params
[$v] = CRM_Utils_Money
::format($this->_params
[$v], NULL, NULL, TRUE);
564 $this->assign($v, $this->_params
[$v]);
568 $this->assign('address', CRM_Utils_Address
::getFormattedBillingAddressFieldsFromParameters(
573 if (!empty($this->_params
['onbehalf_profile_id']) && !empty($this->_params
['onbehalf'])) {
574 $this->assign('onBehalfName', $this->_params
['organization_name']);
575 $locTypeId = array_keys($this->_params
['onbehalf_location']['email']);
576 $this->assign('onBehalfEmail', $this->_params
['onbehalf_location']['email'][$locTypeId[0]]['email']);
581 if ($this->_amount
> 0.0) {
584 elseif (!empty($this->_params
['selectMembership'])) {
585 $memFee = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType', $this->_params
['selectMembership'], 'minimum_fee');
591 // The concept of contributeMode is deprecated.
592 // The payment processor object can provide info about the fields it shows.
593 if ($isMonetary && is_a($this->_paymentProcessor
['object'], 'CRM_Core_Payment')) {
594 /** @var $paymentProcessorObject \CRM_Core_Payment */
595 $paymentProcessorObject = $this->_paymentProcessor
['object'];
597 $paymentFields = $paymentProcessorObject->getPaymentFormFields();
598 foreach ($paymentFields as $index => $paymentField) {
599 if (!isset($this->_params
[$paymentField])) {
600 unset($paymentFields[$index]);
603 if ($paymentField === 'credit_card_exp_date') {
604 $date = CRM_Utils_Date
::format(CRM_Utils_Array
::value('credit_card_exp_date', $this->_params
));
605 $date = CRM_Utils_Date
::mysqlToIso($date);
606 $this->assign('credit_card_exp_date', $date);
608 elseif ($paymentField === 'credit_card_number') {
609 $this->assign('credit_card_number',
610 CRM_Utils_System
::mungeCreditCard(CRM_Utils_Array
::value('credit_card_number', $this->_params
))
614 $this->assign($paymentField, $this->_params
[$paymentField]);
617 $paymentFieldsetLabel = ts('%1 Information', array($paymentProcessorObject->getPaymentTypeLabel()));
618 if (empty($paymentFields)) {
619 $paymentFieldsetLabel = '';
621 $this->assign('paymentFieldsetLabel', $paymentFieldsetLabel);
622 $this->assign('paymentFields', $paymentFields);
626 $this->assign('email',
627 $this->controller
->exportValue('Main', "email-{$this->_bltID}")
630 // also assign the receipt_text
631 if (isset($this->_values
['receipt_text'])) {
632 $this->assign('receipt_text', $this->_values
['receipt_text']);
637 * Add the custom fields.
640 * @param string $name
641 * @param bool $viewOnly
642 * @param null $profileContactType
643 * @param array $fieldTypes
645 public function buildCustom($id, $name, $viewOnly = FALSE, $profileContactType = NULL, $fieldTypes = NULL) {
647 $contactID = $this->getContactID();
649 // we don't allow conflicting fields to be
650 // configured via profile - CRM 2100
651 $fieldsToIgnore = array(
657 'non_deductible_amount' => 1,
660 'contribution_status_id' => 1,
661 // @todo replace payment_instrument with payment instrument id.
662 // both are available now but the id field is the most consistent.
663 'payment_instrument' => 1,
664 'payment_instrument_id' => 1,
665 'contribution_check_number' => 1,
666 'financial_type' => 1,
669 $fields = CRM_Core_BAO_UFGroup
::getFields($id, FALSE, CRM_Core_Action
::ADD
, NULL, NULL, FALSE,
670 NULL, FALSE, NULL, CRM_Core_Permission
::CREATE
, NULL
674 // determine if email exists in profile so we know if we need to manually insert CRM-2888, CRM-15067
675 foreach ($fields as $key => $field) {
676 if (substr($key, 0, 6) == 'email-' &&
677 !in_array($profileContactType, array('honor', 'onbehalf'))
679 $this->_emailExists
= TRUE;
680 $this->set('emailExists', TRUE);
684 if (array_intersect_key($fields, $fieldsToIgnore)) {
685 $fields = array_diff_key($fields, $fieldsToIgnore);
686 CRM_Core_Session
::setStatus(ts('Some of the profile fields cannot be configured for this page.'), ts('Warning'), 'alert');
689 //remove common fields only if profile is not configured for onbehalf/honor
690 if (!in_array($profileContactType, array('honor', 'onbehalf'))) {
691 $fields = array_diff_key($fields, $this->_fields
);
694 CRM_Core_BAO_Address
::checkContactSharedAddressFields($fields, $contactID);
696 // fetch file preview when not submitted yet, like in online contribution Confirm and ThankYou page
697 $viewOnlyFileValues = empty($profileContactType) ?
array() : array($profileContactType => array());
698 foreach ($fields as $key => $field) {
700 isset($field['data_type']) &&
701 $field['data_type'] == 'File' ||
($viewOnly && $field['name'] == 'image_URL')
703 //retrieve file value from submitted values on basis of $profileContactType
704 $fileValue = CRM_Utils_Array
::value($key, $this->_params
);
705 if (!empty($profileContactType) && !empty($this->_params
[$profileContactType])) {
706 $fileValue = CRM_Utils_Array
::value($key, $this->_params
[$profileContactType]);
710 $path = CRM_Utils_Array
::value('name', $fileValue);
711 $fileType = CRM_Utils_Array
::value('type', $fileValue);
712 $fileValue = CRM_Utils_File
::getFileURL($path, $fileType);
715 // format custom file value fetched from submitted value
716 if ($profileContactType) {
717 $viewOnlyFileValues[$profileContactType][$key] = $fileValue;
720 $viewOnlyFileValues[$key] = $fileValue;
723 // On viewOnly use-case (as in online contribution Confirm page) we no longer need to set
724 // required property because being required file is already uploaded while registration
725 $field['is_required'] = FALSE;
727 if ($profileContactType) {
728 //Since we are showing honoree name separately so we are removing it from honoree profile just for display
729 if ($profileContactType == 'honor') {
730 $honoreeNamefields = array(
738 if (in_array($field['name'], $honoreeNamefields)) {
739 unset($fields[$field['name']]);
743 if (!empty($fieldTypes) && in_array($field['field_type'], $fieldTypes)) {
744 CRM_Core_BAO_UFGroup
::buildProfile(
747 CRM_Profile_Form
::MODE_CREATE
,
752 $this->_fields
[$profileContactType][$key] = $field;
755 unset($fields[$key]);
759 CRM_Core_BAO_UFGroup
::buildProfile(
762 CRM_Profile_Form
::MODE_CREATE
,
766 $this->_fields
[$key] = $field;
768 // CRM-11316 Is ReCAPTCHA enabled for this profile AND is this an anonymous visitor
769 if ($field['add_captcha'] && !$this->_userID
) {
774 $this->assign($name, $fields);
776 if ($profileContactType && count($viewOnlyFileValues[$profileContactType])) {
777 $this->assign('viewOnlyPrefixFileValues', $viewOnlyFileValues);
779 elseif (count($viewOnlyFileValues)) {
780 $this->assign('viewOnlyFileValues', $viewOnlyFileValues);
783 if ($addCaptcha && !$viewOnly) {
784 $captcha = CRM_Utils_ReCAPTCHA
::singleton();
785 $captcha->add($this);
786 $this->assign('isCaptcha', TRUE);
793 * Add onbehalf/honoree profile fields and native module fields.
796 * @param CRM_Core_Form $form
798 public function buildComponentForm($id, $form) {
803 $contactID = $this->getContactID();
805 foreach (array('soft_credit', 'on_behalf') as $module) {
806 if ($module == 'soft_credit') {
807 if (empty($form->_values
['honoree_profile_id'])) {
811 if (!CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_UFGroup', $form->_values
['honoree_profile_id'], 'is_active')) {
812 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.'));
815 $profileContactType = CRM_Core_BAO_UFGroup
::getContactType($form->_values
['honoree_profile_id']);
816 $requiredProfileFields = array(
817 'Individual' => array('first_name', 'last_name'),
818 'Organization' => array('organization_name', 'email'),
819 'Household' => array('household_name', 'email'),
821 $validProfile = CRM_Core_BAO_UFGroup
::checkValidProfile($form->_values
['honoree_profile_id'], $requiredProfileFields[$profileContactType]);
822 if (!$validProfile) {
823 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.'));
826 foreach (array('honor_block_title', 'honor_block_text') as $name) {
827 $form->assign($name, $form->_values
[$name]);
830 $softCreditTypes = CRM_Core_OptionGroup
::values("soft_credit_type", FALSE);
832 // radio button for Honor Type
833 foreach ($form->_values
['soft_credit_types'] as $value) {
834 $honorTypes[$value] = $form->createElement('radio', NULL, NULL, $softCreditTypes[$value], $value);
836 $form->addGroup($honorTypes, 'soft_credit_type_id', NULL)->setAttribute('allowClear', TRUE);
838 $honoreeProfileFields = CRM_Core_BAO_UFGroup
::getFields(
839 $this->_values
['honoree_profile_id'], FALSE,
843 NULL, CRM_Core_Permission
::CREATE
845 $form->assign('honoreeProfileFields', $honoreeProfileFields);
847 // add the form elements
848 foreach ($honoreeProfileFields as $name => $field) {
849 // If soft credit type is not chosen then make omit requiredness from honoree profile fields
850 if (count($form->_submitValues
) &&
851 empty($form->_submitValues
['soft_credit_type_id']) &&
852 !empty($field['is_required'])
854 $field['is_required'] = FALSE;
856 CRM_Core_BAO_UFGroup
::buildProfile($form, $field, CRM_Profile_Form
::MODE_CREATE
, NULL, FALSE, FALSE, NULL, 'honor');
860 if (empty($form->_values
['onbehalf_profile_id'])) {
864 if (!CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_UFGroup', $form->_values
['onbehalf_profile_id'], 'is_active')) {
865 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.'));
868 $member = CRM_Member_BAO_Membership
::getMembershipBlock($form->_id
);
869 if (empty($member['is_active'])) {
870 $msg = ts('Mixed profile not allowed for on behalf of registration/sign up.');
871 $onBehalfProfile = CRM_Core_BAO_UFGroup
::profileGroups($form->_values
['onbehalf_profile_id']);
879 if (in_array($contactType, $onBehalfProfile) &&
880 (in_array('Membership', $onBehalfProfile) ||
881 in_array('Contribution', $onBehalfProfile)
884 CRM_Core_Error
::fatal($msg);
890 // retrieve all permissioned organizations of contact $contactID
891 $organizations = CRM_Contact_BAO_Relationship
::getPermissionedContacts($contactID, NULL, NULL, 'Organization');
893 if (count($organizations)) {
894 // Related org url - pass checksum if needed
896 'ufId' => $form->_values
['onbehalf_profile_id'],
899 if (!empty($_GET['cs'])) {
901 'ufId' => $form->_values
['onbehalf_profile_id'],
902 'uid' => $this->_contactID
,
907 $locDataURL = CRM_Utils_System
::url('civicrm/ajax/permlocation', $args, FALSE, NULL, FALSE);
908 $form->assign('locDataURL', $locDataURL);
910 if (count($organizations) > 0) {
911 $form->add('select', 'onbehalfof_id', '', CRM_Utils_Array
::collect('name', $organizations));
914 0 => ts('Select an existing organization'),
915 1 => ts('Enter a new organization'),
917 $form->addRadio('org_option', ts('options'), $orgOptions);
918 $form->setDefaults(array('org_option' => 0));
922 $form->assign('fieldSetTitle', ts(CRM_Core_BAO_UFGroup
::getTitle($form->_values
['onbehalf_profile_id'])));
924 if (CRM_Utils_Array
::value('is_for_organization', $form->_values
)) {
925 if ($form->_values
['is_for_organization'] == 2) {
926 $form->assign('onBehalfRequired', TRUE);
929 $form->addElement('checkbox', 'is_for_organization',
930 $form->_values
['for_organization'],
936 $profileFields = CRM_Core_BAO_UFGroup
::getFields(
937 $form->_values
['onbehalf_profile_id'],
938 FALSE, CRM_Core_Action
::VIEW
, NULL,
939 NULL, FALSE, NULL, FALSE, NULL,
940 CRM_Core_Permission
::CREATE
, NULL
943 $form->assign('onBehalfOfFields', $profileFields);
944 if (!empty($form->_submitValues
['onbehalf'])) {
945 if (!empty($form->_submitValues
['onbehalfof_id'])) {
946 $form->assign('submittedOnBehalf', $form->_submitValues
['onbehalfof_id']);
948 $form->assign('submittedOnBehalfInfo', json_encode(str_replace('"', '\"', $form->_submitValues
['onbehalf']), JSON_HEX_APOS
));
951 $fieldTypes = array('Contact', 'Organization');
952 if (!empty($form->_membershipBlock
)) {
953 $fieldTypes = array_merge($fieldTypes, array('Membership'));
955 $contactSubType = CRM_Contact_BAO_ContactType
::subTypes('Organization');
956 $fieldTypes = array_merge($fieldTypes, $contactSubType);
958 foreach ($profileFields as $name => $field) {
959 if (in_array($field['field_type'], $fieldTypes)) {
960 list($prefixName, $index) = CRM_Utils_System
::explode('-', $name, 2);
961 if (in_array($prefixName, array('organization_name', 'email')) && empty($field['is_required'])) {
962 $field['is_required'] = 1;
964 if (count($form->_submitValues
) &&
965 empty($form->_submitValues
['is_for_organization']) &&
966 $form->_values
['is_for_organization'] == 1 &&
967 !empty($field['is_required'])
969 $field['is_required'] = FALSE;
971 CRM_Core_BAO_UFGroup
::buildProfile($form, $field, NULL, NULL, FALSE, 'onbehalf', NULL, 'onbehalf');
980 * Check template file exists.
982 * @param string $suffix
984 * @return null|string
986 public function checkTemplateFileExists($suffix = NULL) {
988 $templateFile = "CRM/Contribute/Form/Contribution/{$this->_id}/{$this->_name}.{$suffix}tpl";
989 $template = CRM_Core_Form
::getTemplate();
990 if ($template->template_exists($templateFile)) {
991 return $templateFile;
998 * Use the form name to create the tpl file name.
1002 public function getTemplateFileName() {
1003 $fileName = $this->checkTemplateFileExists();
1004 return $fileName ?
$fileName : parent
::getTemplateFileName();
1008 * Add the extra.tpl in.
1010 * Default extra tpl file basically just replaces .tpl with .extra.tpl
1011 * i.e. we do not override - why isn't this done at the CRM_Core_Form level?
1015 public function overrideExtraTemplateFileName() {
1016 $fileName = $this->checkTemplateFileExists('extra.');
1017 return $fileName ?
$fileName : parent
::overrideExtraTemplateFileName();
1021 * Authenticate pledge user during online payment.
1023 public function authenticatePledgeUser() {
1024 //get the userChecksum and contact id
1025 $userChecksum = CRM_Utils_Request
::retrieve('cs', 'String', $this);
1026 $contactID = CRM_Utils_Request
::retrieve('cid', 'Positive', $this);
1028 //get pledge status and contact id
1029 $pledgeValues = array();
1030 $pledgeParams = array('id' => $this->_values
['pledge_id']);
1031 $returnProperties = array('contact_id', 'status_id');
1032 CRM_Core_DAO
::commonRetrieve('CRM_Pledge_DAO_Pledge', $pledgeParams, $pledgeValues, $returnProperties);
1035 $allStatus = CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name');
1036 $validStatus = array(
1037 array_search('Pending', $allStatus),
1038 array_search('In Progress', $allStatus),
1039 array_search('Overdue', $allStatus),
1043 if ($this->_userID
&&
1044 $this->_userID
== $pledgeValues['contact_id']
1046 //check for authenticated user.
1049 elseif ($userChecksum && $pledgeValues['contact_id']) {
1050 //check for anonymous user.
1051 $validUser = CRM_Contact_BAO_Contact_Utils
::validChecksum($pledgeValues['contact_id'], $userChecksum);
1053 //make sure cid is same as pledge contact id
1054 if ($validUser && ($pledgeValues['contact_id'] != $contactID)) {
1060 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."));
1063 //check for valid pledge status.
1064 if (!in_array($pledgeValues['status_id'], $validStatus)) {
1065 CRM_Core_Error
::fatal(ts('Oops. You cannot make a payment for this pledge - pledge status is %1.', array(1 => CRM_Utils_Array
::value($pledgeValues['status_id'], $allStatus))));
1070 * Cancel recurring contributions.
1072 * In case user cancel recurring contribution,
1073 * When we get the control back from payment gate way
1074 * lets delete the recurring and related contribution.
1076 public function cancelRecurring() {
1077 $isCancel = CRM_Utils_Request
::retrieve('cancel', 'Boolean');
1079 $isRecur = CRM_Utils_Request
::retrieve('isRecur', 'Boolean');
1080 $recurId = CRM_Utils_Request
::retrieve('recurId', 'Positive');
1081 //clean db for recurring contribution.
1082 if ($isRecur && $recurId) {
1083 CRM_Contribute_BAO_ContributionRecur
::deleteRecurContribution($recurId);
1085 $contribId = CRM_Utils_Request
::retrieve('contribId', 'Positive');
1087 CRM_Contribute_BAO_Contribution
::deleteContribution($contribId);
1093 * Build Membership Block in Contribution Pages.
1096 * Contact checked for having a current membership for a particular membership.
1097 * @param bool $isContributionMainPage
1098 * Is this the main page? If so add form input fields.
1099 * (or better yet don't have this functionality in a function shared with forms that don't share it).
1100 * @param int|array $selectedMembershipTypeID
1101 * Selected membership id.
1102 * @param bool $thankPage
1104 * @param null $isTest
1107 * Is this a separate membership payment
1109 protected function buildMembershipBlock(
1111 $isContributionMainPage = FALSE,
1112 $selectedMembershipTypeID = NULL,
1117 $separateMembershipPayment = FALSE;
1118 if ($this->_membershipBlock
) {
1119 $this->_currentMemberships
= array();
1121 $membershipTypeIds = $membershipTypes = $radio = array();
1122 $membershipPriceset = (!empty($this->_priceSetId
) && $this->_useForMember
) ?
TRUE : FALSE;
1124 $allowAutoRenewMembership = $autoRenewOption = FALSE;
1125 $autoRenewMembershipTypeOptions = array();
1127 $separateMembershipPayment = CRM_Utils_Array
::value('is_separate_payment', $this->_membershipBlock
);
1129 if ($membershipPriceset) {
1130 foreach ($this->_priceSet
['fields'] as $pField) {
1131 if (empty($pField['options'])) {
1134 foreach ($pField['options'] as $opId => $opValues) {
1135 if (empty($opValues['membership_type_id'])) {
1138 $membershipTypeIds[$opValues['membership_type_id']] = $opValues['membership_type_id'];
1142 elseif (!empty($this->_membershipBlock
['membership_types'])) {
1143 $membershipTypeIds = explode(',', $this->_membershipBlock
['membership_types']);
1146 if (!empty($membershipTypeIds)) {
1147 //set status message if wrong membershipType is included in membershipBlock
1148 if (isset($this->_mid
) && !$membershipPriceset) {
1149 $membershipTypeID = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership',
1151 'membership_type_id'
1153 if (!in_array($membershipTypeID, $membershipTypeIds)) {
1154 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');
1158 $membershipTypeValues = CRM_Member_BAO_Membership
::buildMembershipTypeValues($this, $membershipTypeIds);
1159 $this->_membershipTypeValues
= $membershipTypeValues;
1161 foreach ($membershipTypeIds as $value) {
1162 $memType = $membershipTypeValues[$value];
1163 if ($selectedMembershipTypeID != NULL) {
1164 if ($memType['id'] == $selectedMembershipTypeID) {
1165 $this->assign('minimum_fee',
1166 CRM_Utils_Array
::value('minimum_fee', $memType)
1168 $this->assign('membership_name', $memType['name']);
1169 if (!$thankPage && $cid) {
1170 $membership = new CRM_Member_DAO_Membership();
1171 $membership->contact_id
= $cid;
1172 $membership->membership_type_id
= $memType['id'];
1173 if ($membership->find(TRUE)) {
1174 $this->assign('renewal_mode', TRUE);
1175 $memType['current_membership'] = $membership->end_date
;
1176 $this->_currentMemberships
[$membership->membership_type_id
] = $membership->membership_type_id
;
1179 $membershipTypes[] = $memType;
1182 elseif ($memType['is_active']) {
1183 $javascriptMethod = NULL;
1184 $allowAutoRenewOpt = (int) $memType['auto_renew'];
1185 if (is_array($this->_paymentProcessors
)) {
1186 foreach ($this->_paymentProcessors
as $id => $val) {
1187 if ($id && !$val['is_recur']) {
1188 $allowAutoRenewOpt = 0;
1194 $javascriptMethod = array('onclick' => "return showHideAutoRenew( this.value );");
1195 $autoRenewMembershipTypeOptions["autoRenewMembershipType_{$value}"] = (int) $allowAutoRenewOpt * CRM_Utils_Array
::value($value, CRM_Utils_Array
::value('auto_renew', $this->_membershipBlock
));;
1197 if ($allowAutoRenewOpt) {
1198 $allowAutoRenewMembership = TRUE;
1201 //add membership type.
1202 $radio[$memType['id']] = $this->createElement('radio', NULL, NULL, NULL,
1203 $memType['id'], $javascriptMethod
1206 $membership = new CRM_Member_DAO_Membership();
1207 $membership->contact_id
= $cid;
1208 $membership->membership_type_id
= $memType['id'];
1210 //show current membership, skip pending and cancelled membership records,
1211 //because we take first membership record id for renewal
1212 $membership->whereAdd('status_id != 5 AND status_id !=6');
1214 if (!is_null($isTest)) {
1215 $membership->is_test
= $isTest;
1219 $membership->orderBy('end_date DESC');
1221 if ($membership->find(TRUE)) {
1222 if (!$membership->end_date
) {
1223 unset($radio[$memType['id']]);
1224 $this->assign('islifetime', TRUE);
1227 $this->assign('renewal_mode', TRUE);
1228 $this->_currentMemberships
[$membership->membership_type_id
] = $membership->membership_type_id
;
1229 $memType['current_membership'] = $membership->end_date
;
1231 $endDate = $memType['current_membership'];
1232 $this->_defaultMemTypeId
= $memType['id'];
1234 if ($memType['current_membership'] < $endDate) {
1235 $endDate = $memType['current_membership'];
1236 $this->_defaultMemTypeId
= $memType['id'];
1240 $membershipTypes[] = $memType;
1245 $this->assign('membershipBlock', $this->_membershipBlock
);
1246 $this->assign('showRadio', $isContributionMainPage);
1247 $this->assign('membershipTypes', $membershipTypes);
1248 $this->assign('allowAutoRenewMembership', $allowAutoRenewMembership);
1249 $this->assign('autoRenewMembershipTypeOptions', json_encode($autoRenewMembershipTypeOptions));
1250 //give preference to user submitted auto_renew value.
1251 $takeUserSubmittedAutoRenew = (!empty($_POST) ||
$this->isSubmitted()) ?
TRUE : FALSE;
1252 $this->assign('takeUserSubmittedAutoRenew', $takeUserSubmittedAutoRenew);
1254 // Assign autorenew option (0:hide,1:optional,2:required) so we can use it in confirmation etc.
1255 $autoRenewOption = CRM_Price_BAO_PriceSet
::checkAutoRenewForPriceSet($this->_priceSetId
);
1256 //$selectedMembershipTypeID is retrieved as an array for membership priceset if multiple
1257 //options for different organisation is selected on the contribution page.
1258 if (is_numeric($selectedMembershipTypeID) && isset($membershipTypeValues[$selectedMembershipTypeID]['auto_renew'])) {
1259 $this->assign('autoRenewOption', $membershipTypeValues[$selectedMembershipTypeID]['auto_renew']);
1262 $this->assign('autoRenewOption', $autoRenewOption);
1265 if ($isContributionMainPage) {
1266 if (!$membershipPriceset) {
1267 if (!$this->_membershipBlock
['is_required']) {
1268 $this->assign('showRadioNoThanks', TRUE);
1269 $radio[''] = $this->createElement('radio', NULL, NULL, NULL, 'no_thanks', NULL);
1270 $this->addGroup($radio, 'selectMembership', NULL);
1272 elseif ($this->_membershipBlock
['is_required'] && count($radio) == 1) {
1273 $temp = array_keys($radio);
1274 $this->add('hidden', 'selectMembership', $temp[0], array('id' => 'selectMembership'));
1275 $this->assign('singleMembership', TRUE);
1276 $this->assign('showRadio', FALSE);
1279 $this->addGroup($radio, 'selectMembership', NULL);
1282 $this->addRule('selectMembership', ts('Please select one of the memberships.'), 'required');
1285 if ((!$this->_values
['is_pay_later'] ||
is_array($this->_paymentProcessors
)) && ($allowAutoRenewMembership ||
$autoRenewOption)) {
1286 if ($autoRenewOption == 2) {
1287 $this->addElement('hidden', 'auto_renew', ts('Please renew my membership automatically.'));
1290 $this->addElement('checkbox', 'auto_renew', ts('Please renew my membership automatically.'));
1297 return $separateMembershipPayment;
1301 * Determine if recurring parameters need to be added to the form parameters.
1304 * - frequency_interval
1307 * For membership this is based on the membership type.
1309 * This needs to be done before processing the pre-approval redirect where relevant on the main page or before any payment processing.
1311 * Arguably the form should start to build $this->_params in the pre-process main page & use that array consistently throughout.
1313 protected function setRecurringMembershipParams() {
1314 $selectedMembershipTypeID = CRM_Utils_Array
::value('selectMembership', $this->_params
);
1315 if ($selectedMembershipTypeID) {
1316 // @todo the price_x fields will ALWAYS allow us to determine the membership - so we should ignore
1317 // 'selectMembership' and calculate from the price_x fields so we have one method that always works
1318 // this is lazy & only catches when selectMembership is set, but the worst of all worlds would be to fix
1319 // this with an else (calculate for price set).
1320 $membershipTypes = CRM_Price_BAO_PriceSet
::getMembershipTypesFromPriceSet($this->_priceSetId
);
1321 if (in_array($selectedMembershipTypeID, $membershipTypes['autorenew_required'])
1322 ||
(in_array($selectedMembershipTypeID, $membershipTypes['autorenew_optional']) &&
1323 !empty($this->_params
['is_recur']))
1325 $this->_params
['auto_renew'] = TRUE;
1328 if ((!empty($this->_params
['selectMembership']) ||
!empty($this->_params
['priceSetId']))
1329 && !empty($this->_paymentProcessor
['is_recur']) &&
1330 CRM_Utils_Array
::value('auto_renew', $this->_params
)
1331 && empty($this->_params
['is_recur']) && empty($this->_params
['frequency_interval'])
1334 $this->_params
['is_recur'] = $this->_values
['is_recur'] = 1;
1335 // check if price set is not quick config
1336 if (!empty($this->_params
['priceSetId']) && !CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet', $this->_params
['priceSetId'], 'is_quick_config')) {
1337 list($this->_params
['frequency_interval'], $this->_params
['frequency_unit']) = CRM_Price_BAO_PriceSet
::getRecurDetails($this->_params
['priceSetId']);
1340 // FIXME: set interval and unit based on selected membership type
1341 $this->_params
['frequency_interval'] = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType',
1342 $this->_params
['selectMembership'], 'duration_interval'
1344 $this->_params
['frequency_unit'] = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType',
1345 $this->_params
['selectMembership'], 'duration_unit'