Merge pull request #13700 from colemanw/CRM-21008
[civicrm-core.git] / CRM / Contribute / Form / ContributionBase.php
CommitLineData
6a488035
TO
1<?php
2/*
3 +--------------------------------------------------------------------+
fee14197 4 | CiviCRM version 5 |
6a488035 5 +--------------------------------------------------------------------+
6b83d5bd 6 | Copyright CiviCRM LLC (c) 2004-2019 |
6a488035
TO
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
9 | |
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. |
13 | |
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. |
18 | |
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 +--------------------------------------------------------------------+
d25dd0ee 26 */
6a488035
TO
27
28/**
29 *
30 * @package CRM
6b83d5bd 31 * @copyright CiviCRM LLC (c) 2004-2019
6a488035
TO
32 */
33
34/**
f92d1e2a 35 * This class generates form components for processing a contribution.
6a488035
TO
36 */
37class CRM_Contribute_Form_ContributionBase extends CRM_Core_Form {
38
39 /**
f92d1e2a 40 * The id of the contribution page that we are processing.
6a488035
TO
41 *
42 * @var int
6a488035
TO
43 */
44 public $_id;
45
46 /**
100fef9d 47 * The mode that we are in
6a488035
TO
48 *
49 * @var string
50 * @protect
51 */
52 public $_mode;
53
54 /**
100fef9d 55 * The contact id related to a membership
6a488035
TO
56 *
57 * @var int
6a488035
TO
58 */
59 public $_membershipContactID;
60
61 /**
100fef9d 62 * The values for the contribution db object
6a488035
TO
63 *
64 * @var array
6a488035
TO
65 */
66 public $_values;
67
68 /**
100fef9d 69 * The paymentProcessor attributes for this page
6a488035
TO
70 *
71 * @var array
6a488035
TO
72 */
73 public $_paymentProcessor;
1b9f9ca3 74
6a488035
TO
75 public $_paymentObject = NULL;
76
77 /**
78 * The membership block for this page
79 *
80 * @var array
6a488035
TO
81 */
82 public $_membershipBlock = NULL;
83
f64a217a
EM
84 /**
85 * Does this form support a separate membership payment
86 * @var bool
87 */
88 protected $_separateMembershipPayment;
6a488035
TO
89
90 /**
91 * The params submitted by the form and computed by the app
92 *
93 * @var array
6a488035 94 */
90102a32 95 public $_params = array();
6a488035
TO
96
97 /**
98 * The fields involved in this contribution page
99 *
100 * @var array
6a488035 101 */
532ee86f 102 public $_fields = array();
6a488035
TO
103
104 /**
f92d1e2a 105 * The billing location id for this contribution page.
6a488035
TO
106 *
107 * @var int
6a488035
TO
108 */
109 public $_bltID;
110
111 /**
112 * Cache the amount to make things easier
113 *
114 * @var float
6a488035
TO
115 */
116 public $_amount;
117
118 /**
100fef9d 119 * Pcp id
6a488035
TO
120 *
121 * @var integer
6a488035
TO
122 */
123 public $_pcpId;
124
125 /**
100fef9d 126 * Pcp block
6a488035
TO
127 *
128 * @var array
6a488035
TO
129 */
130 public $_pcpBlock;
131
132 /**
100fef9d 133 * Pcp info
6a488035
TO
134 *
135 * @var array
6a488035
TO
136 */
137 public $_pcpInfo;
138
5b757295 139 /**
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
0e5e0c2e 142 * @var int
5b757295 143 */
0e5e0c2e 144 public $_contactID;
5b757295 145
6a488035
TO
146 protected $_userID;
147
148 /**
100fef9d 149 * The Membership ID for membership renewal
6a488035
TO
150 *
151 * @var int
6a488035
TO
152 */
153 public $_membershipId;
154
155 /**
156 * Price Set ID, if the new price set method is used
157 *
158 * @var int
6a488035
TO
159 */
160 public $_priceSetId;
161
162 /**
163 * Array of fields for the price set
164 *
165 * @var array
6a488035
TO
166 */
167 public $_priceSet;
168
169 public $_action;
170
dbddfb08
EM
171 /**
172 * Contribution mode e.g express for payment express, notify for off-site + notification back to CiviCRM
173 * @var string
174 */
175 public $_contributeMode;
176
177 /**
100fef9d 178 * Contribution page supports memberships
dbddfb08
EM
179 * @var boolean
180 */
181 public $_useForMember;
8ae4d0d3 182
0f2b049e 183 /**
184 * @deprecated
185 *
186 * @var
187 */
8ae4d0d3 188 public $_isBillingAddressRequiredForPayLater;
353ffa53 189
0c7c9ff7
KC
190 /**
191 * Flag if email field exists in embedded profile
192 *
193 * @var bool
194 */
195 public $_emailExists = FALSE;
196
18135422 197 /**
198 * Is this a backoffice form
199 * (this will affect whether paypal express code is displayed)
200 * @var bool
201 */
202 public $isBackOffice = FALSE;
203
204 /**
205 * Payment instrument if for the transaction.
206 *
207 * This will generally be drawn from the payment processor and is ignored for
208 * front end forms.
209 *
210 * @var int
211 */
212 public $paymentInstrumentID;
213
c59e7960 214 /**
215 * Is the price set quick config.
216 * @return bool
217 */
218 public function isQuickConfig() {
219 return isset(self::$_quickConfig) ? self::$_quickConfig : FALSE;
220 }
221
6a488035 222 /**
fe482240 223 * Set variables up before form is built.
6a488035 224 *
7fe37828
EM
225 * @throws \CRM_Contribute_Exception_InactiveContributionPageException
226 * @throws \Exception
6a488035
TO
227 */
228 public function preProcess() {
6a488035
TO
229
230 // current contribution page id
231 $this->_id = CRM_Utils_Request::retrieve('id', 'Positive', $this);
37e877b2 232 $this->_ccid = CRM_Utils_Request::retrieve('ccid', 'Positive', $this);
6a488035 233 if (!$this->_id) {
d420cf02
DL
234 // seems like the session is corrupted and/or we lost the id trail
235 // lets just bump this to a regular session error and redirect user to main page
236 $this->controller->invalidKeyRedirect();
6a488035 237 }
67c998f4 238 $this->_emailExists = $this->get('emailExists');
d420cf02 239
5b757295 240 // this was used prior to the cleverer this_>getContactID - unsure now
f23c302c 241 $this->_userID = CRM_Core_Session::singleton()->getLoggedInContactID();
5b757295 242
243 $this->_contactID = $this->_membershipContactID = $this->getContactID();
6a488035 244 $this->_mid = NULL;
5b757295 245 if ($this->_contactID) {
6a488035
TO
246 $this->_mid = CRM_Utils_Request::retrieve('mid', 'Positive', $this);
247 if ($this->_mid) {
248 $membership = new CRM_Member_DAO_Membership();
249 $membership->id = $this->_mid;
250
251 if ($membership->find(TRUE)) {
252 $this->_defaultMemTypeId = $membership->membership_type_id;
5b757295 253 if ($membership->contact_id != $this->_contactID) {
6fe8deba 254 $validMembership = FALSE;
33260076 255 $organizations = CRM_Contact_BAO_Relationship::getPermissionedContacts($this->_userID, NULL, NULL, 'Organization');
256 if (!empty($organizations) && array_key_exists($membership->contact_id, $organizations)) {
6fe8deba
DS
257 $this->_membershipContactID = $membership->contact_id;
258 $this->assign('membershipContactID', $this->_membershipContactID);
33260076 259 $this->assign('membershipContactName', $organizations[$this->_membershipContactID]['name']);
6fe8deba 260 $validMembership = TRUE;
0db6c3e1
TO
261 }
262 else {
51e89def
DS
263 $membershipType = new CRM_Member_BAO_MembershipType();
264 $membershipType->id = $membership->membership_type_id;
265 if ($membershipType->find(TRUE)) {
f9f0eff9 266 // CRM-14051 - membership_type.relationship_type_id is a CTRL-A padded string w one or more ID values.
f92d1e2a 267 // Convert to comma separated list.
f9f0eff9 268 $inheritedRelTypes = implode(CRM_Utils_Array::explodePadded($membershipType->relationship_type_id), ',');
51e89def
DS
269 $permContacts = CRM_Contact_BAO_Relationship::getPermissionedContacts($this->_userID, $membershipType->relationship_type_id);
270 if (array_key_exists($membership->contact_id, $permContacts)) {
271 $this->_membershipContactID = $membership->contact_id;
6fe8deba 272 $validMembership = TRUE;
51e89def
DS
273 }
274 }
6a488035 275 }
6fe8deba
DS
276 if (!$validMembership) {
277 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');
278 }
6a488035
TO
279 }
280 }
281 else {
282 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');
283 }
284 unset($membership);
285 }
286 }
287
288 // we do not want to display recently viewed items, so turn off
289 $this->assign('displayRecent', FALSE);
290 // Contribution page values are cleared from session, so can't use normal Printer Friendly view.
291 // Use Browser Print instead.
292 $this->assign('browserPrint', TRUE);
293
294 // action
295 $this->_action = CRM_Utils_Request::retrieve('action', 'String', $this, FALSE, 'add');
296 $this->assign('action', $this->_action);
297
298 // current mode
299 $this->_mode = ($this->_action == 1024) ? 'test' : 'live';
300
301 $this->_values = $this->get('values');
302 $this->_fields = $this->get('fields');
303 $this->_bltID = $this->get('bltID');
304 $this->_paymentProcessor = $this->get('paymentProcessor');
3dd22219 305
6a488035
TO
306 $this->_priceSetId = $this->get('priceSetId');
307 $this->_priceSet = $this->get('priceSet');
308
309 if (!$this->_values) {
310 // get all the values from the dao object
311 $this->_values = array();
312 $this->_fields = array();
313
314 CRM_Contribute_BAO_ContributionPage::setValues($this->_id, $this->_values);
40c655aa 315 if (CRM_Financial_BAO_FinancialType::isACLFinancialTypeStatus()
66af7c48
PN
316 && !CRM_Core_Permission::check('add contributions of type ' . CRM_Contribute_PseudoConstant::financialType($this->_values['financial_type_id']))
317 ) {
0799e1c4
E
318 CRM_Core_Error::fatal(ts('You do not have permission to access this page.'));
319 }
a7488080 320 if (empty($this->_values['is_active'])) {
4b57bc9f 321 throw new CRM_Contribute_Exception_InactiveContributionPageException(ts('The page you requested is currently unavailable.'), $this->_id);
6a488035
TO
322 }
323
ed1c698a 324 $endDate = CRM_Utils_Date::processDate(CRM_Utils_Array::value('end_date', $this->_values));
325 $now = date('YmdHis');
326 if ($endDate && $endDate < $now) {
ffc1e56f 327 throw new CRM_Contribute_Exception_PastContributionPageException(ts('The page you requested has past its end date on ' . CRM_Utils_Date::customFormat($endDate)), $this->_id);
ed1c698a 328 }
329
330 $startDate = CRM_Utils_Date::processDate(CRM_Utils_Array::value('start_date', $this->_values));
331 if ($startDate && $startDate > $now) {
ffc1e56f 332 throw new CRM_Contribute_Exception_FutureContributionPageException(ts('The page you requested will be active from ' . CRM_Utils_Date::customFormat($startDate)), $this->_id);
ed1c698a 333 }
334
8345c9d3 335 $this->assignBillingType();
6a488035
TO
336
337 // check for is_monetary status
338 $isMonetary = CRM_Utils_Array::value('is_monetary', $this->_values);
339 $isPayLater = CRM_Utils_Array::value('is_pay_later', $this->_values);
24cf7458 340 if (!empty($this->_ccid)) {
341 $this->_values['financial_type_id'] = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_Contribution',
342 $this->_ccid,
343 'financial_type_id'
344 );
345 if ($isPayLater) {
346 $isPayLater = FALSE;
347 $this->_values['is_pay_later'] = FALSE;
348 }
37e877b2 349 }
6a488035 350
427ae6c5
JP
351 if ($isMonetary) {
352 $this->_paymentProcessorIDs = array_filter(explode(
a6c15c46
EM
353 CRM_Core_DAO::VALUE_SEPARATOR,
354 CRM_Utils_Array::value('payment_processor', $this->_values)
427ae6c5 355 ));
f92d1e2a 356
cbcb5b49 357 $this->assignPaymentProcessor($isPayLater);
6a488035
TO
358 }
359
360 // get price info
361 // CRM-5095
9da8dc8c 362 CRM_Price_BAO_PriceSet::initSet($this, $this->_id, 'civicrm_contribution_page');
6a488035
TO
363
364 // this avoids getting E_NOTICE errors in php
365 $setNullFields = array(
366 'amount_block_is_active',
6a488035
TO
367 'is_allow_other_amount',
368 'footer_text',
369 );
370 foreach ($setNullFields as $f) {
371 if (!isset($this->_values[$f])) {
372 $this->_values[$f] = NULL;
373 }
374 }
375
376 //check if Membership Block is enabled, if Membership Fields are included in profile
377 //get membership section for this contribution page
378 $this->_membershipBlock = CRM_Member_BAO_Membership::getMembershipBlock($this->_id);
379 $this->set('membershipBlock', $this->_membershipBlock);
380
4779abb3 381 if (!empty($this->_values['custom_pre_id'])) {
6a488035
TO
382 $preProfileType = CRM_Core_BAO_UFField::getProfileType($this->_values['custom_pre_id']);
383 }
384
4779abb3 385 if (!empty($this->_values['custom_post_id'])) {
6a488035
TO
386 $postProfileType = CRM_Core_BAO_UFField::getProfileType($this->_values['custom_post_id']);
387 }
388
389 if (((isset($postProfileType) && $postProfileType == 'Membership') ||
390 (isset($preProfileType) && $preProfileType == 'Membership')
391 ) &&
392 !$this->_membershipBlock['is_active']
393 ) {
394 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.'));
395 }
396
397 $pledgeBlock = CRM_Pledge_BAO_PledgeBlock::getPledgeBlock($this->_id);
398
399 if ($pledgeBlock) {
400 $this->_values['pledge_block_id'] = CRM_Utils_Array::value('id', $pledgeBlock);
401 $this->_values['max_reminders'] = CRM_Utils_Array::value('max_reminders', $pledgeBlock);
402 $this->_values['initial_reminder_day'] = CRM_Utils_Array::value('initial_reminder_day', $pledgeBlock);
403 $this->_values['additional_reminder_day'] = CRM_Utils_Array::value('additional_reminder_day', $pledgeBlock);
404
405 //set pledge id in values
406 $pledgeId = CRM_Utils_Request::retrieve('pledgeId', 'Positive', $this);
407
408 //authenticate pledge user for pledge payment.
409 if ($pledgeId) {
410 $this->_values['pledge_id'] = $pledgeId;
411
412 //lets override w/ pledge campaign.
413 $this->_values['campaign_id'] = CRM_Core_DAO::getFieldValue('CRM_Pledge_DAO_Pledge',
414 $pledgeId,
415 'campaign_id'
416 );
417 self::authenticatePledgeUser();
418 }
419 }
420 $this->set('values', $this->_values);
421 $this->set('fields', $this->_fields);
422 }
423
424 // Handle PCP
425 $pcpId = CRM_Utils_Request::retrieve('pcpId', 'Positive', $this);
426 if ($pcpId) {
353ffa53
TO
427 $pcp = CRM_PCP_BAO_PCP::handlePcp($pcpId, 'contribute', $this->_values);
428 $this->_pcpId = $pcp['pcpId'];
6a488035 429 $this->_pcpBlock = $pcp['pcpBlock'];
353ffa53 430 $this->_pcpInfo = $pcp['pcpInfo'];
6a488035
TO
431 }
432
433 // Link (button) for users to create their own Personal Campaign page
434 if ($linkText = CRM_PCP_BAO_PCP::getPcpBlockStatus($this->_id, 'contribute')) {
435 $linkTextUrl = CRM_Utils_System::url('civicrm/contribute/campaign',
436 "action=add&reset=1&pageId={$this->_id}&component=contribute",
437 FALSE, NULL, TRUE
438 );
439 $this->assign('linkTextUrl', $linkTextUrl);
440 $this->assign('linkText', $linkText);
441 }
442
443 //set pledge block if block id is set
a7488080 444 if (!empty($this->_values['pledge_block_id'])) {
6a488035
TO
445 $this->assign('pledgeBlock', TRUE);
446 }
447
f92d1e2a 448 // check if one of the (amount , membership) blocks is active or not.
6a488035
TO
449 $this->_membershipBlock = $this->get('membershipBlock');
450
451 if (!$this->_values['amount_block_is_active'] &&
452 !$this->_membershipBlock['is_active'] &&
453 !$this->_priceSetId
454 ) {
455 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.'));
456 }
457
458 if ($this->_values['amount_block_is_active']) {
459 $this->set('amount_block_is_active', $this->_values['amount_block_is_active']);
460 }
461
462 $this->_contributeMode = $this->get('contributeMode');
463 $this->assign('contributeMode', $this->_contributeMode);
464
465 //assigning is_monetary and is_email_receipt to template
466 $this->assign('is_monetary', $this->_values['is_monetary']);
467 $this->assign('is_email_receipt', $this->_values['is_email_receipt']);
468 $this->assign('bltID', $this->_bltID);
469
470 //assign cancelSubscription URL to templates
471 $this->assign('cancelSubscriptionUrl',
472 CRM_Utils_Array::value('cancelSubscriptionUrl', $this->_values)
473 );
474
475 // assigning title to template in case someone wants to use it, also setting CMS page title
476 if ($this->_pcpId) {
477 $this->assign('title', $this->_pcpInfo['title']);
478 CRM_Utils_System::setTitle($this->_pcpInfo['title']);
479 }
480 else {
481 $this->assign('title', $this->_values['title']);
482 CRM_Utils_System::setTitle($this->_values['title']);
483 }
484 $this->_defaults = array();
485
486 $this->_amount = $this->get('amount');
d02c6418 487 // Assigning this to the template means it will be passed through to the payment form.
488 // This can, for example, by used by payment processors using client side encryption
489 $this->assign('currency', $this->getCurrency());
6a488035
TO
490
491 //CRM-6907
d02c6418 492 // these lines exist to support a non-default currenty on the form but are probably
493 // obsolete & meddling wth the defaultCurrency is not the right approach....
6a488035
TO
494 $config = CRM_Core_Config::singleton();
495 $config->defaultCurrency = CRM_Utils_Array::value('currency',
496 $this->_values,
497 $config->defaultCurrency
498 );
499
500 //lets allow user to override campaign.
501 $campID = CRM_Utils_Request::retrieve('campID', 'Positive', $this);
502 if ($campID && CRM_Core_DAO::getFieldValue('CRM_Campaign_DAO_Campaign', $campID)) {
503 $this->_values['campaign_id'] = $campID;
504 }
505
506 //do check for cancel recurring and clean db, CRM-7696
a3d827a7 507 if (CRM_Utils_Request::retrieve('cancel', 'Boolean')) {
6a488035
TO
508 self::cancelRecurring();
509 }
8ae4d0d3 510
511 // check if billing block is required for pay later
512 if (CRM_Utils_Array::value('is_pay_later', $this->_values)) {
513 $this->_isBillingAddressRequiredForPayLater = CRM_Utils_Array::value('is_billing_required', $this->_values);
514 $this->assign('isBillingAddressRequiredForPayLater', $this->_isBillingAddressRequiredForPayLater);
515 }
6a488035
TO
516 }
517
518 /**
fe482240 519 * Set the default values.
6a488035 520 */
00be9182 521 public function setDefaultValues() {
6a488035
TO
522 return $this->_defaults;
523 }
524
525 /**
fe482240 526 * Assign the minimal set of variables to the template.
6a488035 527 */
00be9182 528 public function assignToTemplate() {
0b50eca0 529 $this->set('name', $this->assignBillingName($this->_params));
6a488035
TO
530
531 $this->assign('paymentProcessor', $this->_paymentProcessor);
532 $vars = array(
353ffa53
TO
533 'amount',
534 'currencyID',
535 'credit_card_type',
536 'trxn_id',
537 'amount_level',
6a488035
TO
538 );
539
540 $config = CRM_Core_Config::singleton();
8cc574cf 541 if (isset($this->_values['is_recur']) && !empty($this->_paymentProcessor['is_recur'])) {
6a488035
TO
542 $this->assign('is_recur_enabled', 1);
543 $vars = array_merge($vars, array(
353ffa53
TO
544 'is_recur',
545 'frequency_interval',
546 'frequency_unit',
547 'installments',
548 ));
6a488035
TO
549 }
550
551 if (in_array('CiviPledge', $config->enableComponents) &&
552 CRM_Utils_Array::value('is_pledge', $this->_params) == 1
553 ) {
554 $this->assign('pledge_enabled', 1);
555
556 $vars = array_merge($vars, array(
557 'is_pledge',
353ffa53
TO
558 'pledge_frequency_interval',
559 'pledge_frequency_unit',
560 'pledge_installments',
561 ));
6a488035
TO
562 }
563
c039f658 564 // @todo - stop setting amount level in this function & call the CRM_Price_BAO_PriceSet::getAmountLevel
565 // function to get correct amount level consistently. Remove setting of the amount level in
566 // CRM_Price_BAO_PriceSet::processAmount. Extend the unit tests in CRM_Price_BAO_PriceSetTest
567 // to cover all variants.
6a488035
TO
568 if (isset($this->_params['amount_other']) || isset($this->_params['selectMembership'])) {
569 $this->_params['amount_level'] = '';
570 }
571
572 foreach ($vars as $v) {
3fb990f4 573 if (isset($this->_params[$v])) {
735fe42d
PJ
574 if ($v == "amount" && $this->_params[$v] === 0) {
575 $this->_params[$v] = CRM_Utils_Money::format($this->_params[$v], NULL, NULL, TRUE);
3fb990f4 576 }
6a488035
TO
577 $this->assign($v, $this->_params[$v]);
578 }
579 }
580
0b50eca0 581 $this->assign('address', CRM_Utils_Address::getFormattedBillingAddressFieldsFromParameters(
582 $this->_params,
583 $this->_bltID
584 ));
6a488035 585
cb804cd9 586 if (!empty($this->_params['onbehalf_profile_id']) && !empty($this->_params['onbehalf'])) {
6a488035
TO
587 $this->assign('onBehalfName', $this->_params['organization_name']);
588 $locTypeId = array_keys($this->_params['onbehalf_location']['email']);
589 $this->assign('onBehalfEmail', $this->_params['onbehalf_location']['email'][$locTypeId[0]]['email']);
590 }
591
592 //fix for CRM-3767
427ae6c5 593 $isMonetary = FALSE;
6a488035 594 if ($this->_amount > 0.0) {
427ae6c5 595 $isMonetary = TRUE;
6a488035 596 }
a7488080 597 elseif (!empty($this->_params['selectMembership'])) {
6a488035
TO
598 $memFee = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipType', $this->_params['selectMembership'], 'minimum_fee');
599 if ($memFee > 0.0) {
427ae6c5 600 $isMonetary = TRUE;
6a488035
TO
601 }
602 }
603
0f2b049e 604 // The concept of contributeMode is deprecated.
605 // The payment processor object can provide info about the fields it shows.
3dd22219 606 if ($isMonetary && is_a($this->_paymentProcessor['object'], 'CRM_Core_Payment')) {
9f7f8a50 607 /** @var $paymentProcessorObject \CRM_Core_Payment */
608 $paymentProcessorObject = $this->_paymentProcessor['object'];
3dd22219 609
9f7f8a50 610 $paymentFields = $paymentProcessorObject->getPaymentFormFields();
611 foreach ($paymentFields as $index => $paymentField) {
612 if (!isset($this->_params[$paymentField])) {
613 unset($paymentFields[$index]);
614 continue;
615 }
616 if ($paymentField === 'credit_card_exp_date') {
617 $date = CRM_Utils_Date::format(CRM_Utils_Array::value('credit_card_exp_date', $this->_params));
618 $date = CRM_Utils_Date::mysqlToIso($date);
619 $this->assign('credit_card_exp_date', $date);
620 }
621 elseif ($paymentField === 'credit_card_number') {
622 $this->assign('credit_card_number',
623 CRM_Utils_System::mungeCreditCard(CRM_Utils_Array::value('credit_card_number', $this->_params))
624 );
625 }
05d2edfd 626 elseif ($paymentField === 'credit_card_type') {
627 $this->assign('credit_card_type', CRM_Core_PseudoConstant::getLabel(
628 'CRM_Core_BAO_FinancialTrxn',
629 'card_type_id',
630 CRM_Core_PseudoConstant::getKey('CRM_Core_BAO_FinancialTrxn', 'card_type_id', $this->_params['credit_card_type'])
631 ));
632 }
9f7f8a50 633 else {
634 $this->assign($paymentField, $this->_params[$paymentField]);
635 }
6a488035 636 }
c42f1a19 637 $this->assign('paymentFieldsetLabel', CRM_Core_Payment_Form::getPaymentLabel($paymentProcessorObject));
9f7f8a50 638 $this->assign('paymentFields', $paymentFields);
639
6a488035
TO
640 }
641
642 $this->assign('email',
643 $this->controller->exportValue('Main', "email-{$this->_bltID}")
644 );
645
646 // also assign the receipt_text
647 if (isset($this->_values['receipt_text'])) {
648 $this->assign('receipt_text', $this->_values['receipt_text']);
649 }
650 }
651
652 /**
fe482240 653 * Add the custom fields.
6a488035 654 *
100fef9d
CW
655 * @param int $id
656 * @param string $name
f4aaa82a
EM
657 * @param bool $viewOnly
658 * @param null $profileContactType
f92d1e2a 659 * @param array $fieldTypes
6a488035 660 */
00be9182 661 public function buildCustom($id, $name, $viewOnly = FALSE, $profileContactType = NULL, $fieldTypes = NULL) {
6a488035 662 if ($id) {
da8d9879 663 $contactID = $this->getContactID();
6a488035
TO
664
665 // we don't allow conflicting fields to be
666 // configured via profile - CRM 2100
667 $fieldsToIgnore = array(
668 'receive_date' => 1,
669 'trxn_id' => 1,
670 'invoice_id' => 1,
671 'net_amount' => 1,
672 'fee_amount' => 1,
673 'non_deductible_amount' => 1,
674 'total_amount' => 1,
675 'amount_level' => 1,
676 'contribution_status_id' => 1,
7bc1d4da 677 // @todo replace payment_instrument with payment instrument id.
678 // both are available now but the id field is the most consistent.
6a488035 679 'payment_instrument' => 1,
7bc1d4da 680 'payment_instrument_id' => 1,
681 'contribution_check_number' => 1,
6a488035
TO
682 'financial_type' => 1,
683 );
684
423b9af4 685 $fields = CRM_Core_BAO_UFGroup::getFields($id, FALSE, CRM_Core_Action::ADD, NULL, NULL, FALSE,
686 NULL, FALSE, NULL, CRM_Core_Permission::CREATE, NULL
687 );
6a488035
TO
688
689 if ($fields) {
0c7c9ff7
KC
690 // determine if email exists in profile so we know if we need to manually insert CRM-2888, CRM-15067
691 foreach ($fields as $key => $field) {
692 if (substr($key, 0, 6) == 'email-' &&
693 !in_array($profileContactType, array('honor', 'onbehalf'))
694 ) {
695 $this->_emailExists = TRUE;
67c998f4 696 $this->set('emailExists', TRUE);
6a488035
TO
697 }
698 }
699
700 if (array_intersect_key($fields, $fieldsToIgnore)) {
701 $fields = array_diff_key($fields, $fieldsToIgnore);
702 CRM_Core_Session::setStatus(ts('Some of the profile fields cannot be configured for this page.'), ts('Warning'), 'alert');
703 }
704
d7d630be 705 //remove common fields only if profile is not configured for onbehalf/honor
706 if (!in_array($profileContactType, array('honor', 'onbehalf'))) {
94e01524 707 $fields = array_diff_key($fields, $this->_fields);
d7d630be 708 }
6a488035
TO
709
710 CRM_Core_BAO_Address::checkContactSharedAddressFields($fields, $contactID);
711 $addCaptcha = FALSE;
f3726153 712 // fetch file preview when not submitted yet, like in online contribution Confirm and ThankYou page
c2292dbd 713 $viewOnlyFileValues = empty($profileContactType) ? array() : array($profileContactType => array());
6a488035
TO
714 foreach ($fields as $key => $field) {
715 if ($viewOnly &&
716 isset($field['data_type']) &&
717 $field['data_type'] == 'File' || ($viewOnly && $field['name'] == 'image_URL')
718 ) {
c2292dbd 719 //retrieve file value from submitted values on basis of $profileContactType
9b7bedc5 720 $fileValue = CRM_Utils_Array::value($key, $this->_params);
721 if (!empty($profileContactType) && !empty($this->_params[$profileContactType])) {
722 $fileValue = CRM_Utils_Array::value($key, $this->_params[$profileContactType]);
723 }
c2292dbd 724
725 if ($fileValue) {
726 $path = CRM_Utils_Array::value('name', $fileValue);
727 $fileType = CRM_Utils_Array::value('type', $fileValue);
728 $fileValue = CRM_Utils_File::getFileURL($path, $fileType);
f3726153 729 }
6a488035 730
c2292dbd 731 // format custom file value fetched from submitted value
732 if ($profileContactType) {
733 $viewOnlyFileValues[$profileContactType][$key] = $fileValue;
734 }
735 else {
736 $viewOnlyFileValues[$key] = $fileValue;
737 }
1aedfc98 738
739 // On viewOnly use-case (as in online contribution Confirm page) we no longer need to set
740 // required property because being required file is already uploaded while registration
741 $field['is_required'] = FALSE;
c2292dbd 742 }
133e2c99 743 if ($profileContactType) {
744 //Since we are showing honoree name separately so we are removing it from honoree profile just for display
c043358f 745 if ($profileContactType == 'honor') {
746 $honoreeNamefields = array(
747 'prefix_id',
748 'first_name',
749 'last_name',
750 'suffix_id',
751 'organization_name',
752 'household_name',
753 );
754 if (in_array($field['name'], $honoreeNamefields)) {
755 unset($fields[$field['name']]);
756 continue;
757 }
133e2c99 758 }
6a488035
TO
759 if (!empty($fieldTypes) && in_array($field['field_type'], $fieldTypes)) {
760 CRM_Core_BAO_UFGroup::buildProfile(
761 $this,
762 $field,
763 CRM_Profile_Form::MODE_CREATE,
764 $contactID,
133e2c99 765 TRUE,
766 $profileContactType
6a488035 767 );
133e2c99 768 $this->_fields[$profileContactType][$key] = $field;
6a488035
TO
769 }
770 else {
771 unset($fields[$key]);
772 }
773 }
774 else {
775 CRM_Core_BAO_UFGroup::buildProfile(
776 $this,
777 $field,
778 CRM_Profile_Form::MODE_CREATE,
779 $contactID,
780 TRUE
781 );
782 $this->_fields[$key] = $field;
783 }
71fc6ea4
DG
784 // CRM-11316 Is ReCAPTCHA enabled for this profile AND is this an anonymous visitor
785 if ($field['add_captcha'] && !$this->_userID) {
6a488035
TO
786 $addCaptcha = TRUE;
787 }
788 }
789
790 $this->assign($name, $fields);
791
6d43e496 792 if ($profileContactType && count($viewOnlyFileValues[$profileContactType])) {
793 $this->assign('viewOnlyPrefixFileValues', $viewOnlyFileValues);
794 }
795 elseif (count($viewOnlyFileValues)) {
f3726153 796 $this->assign('viewOnlyFileValues', $viewOnlyFileValues);
797 }
798
6a488035 799 if ($addCaptcha && !$viewOnly) {
96ea60e0 800 $this->enableCaptchaOnForm();
6a488035
TO
801 }
802 }
803 }
804 }
805
96ea60e0
AP
806 /**
807 * Enable ReCAPTCHA on Contribution form
808 */
809 protected function enableCaptchaOnForm() {
810 $captcha = CRM_Utils_ReCAPTCHA::singleton();
8237b510
AP
811 if ($captcha->hasSettingsAvailable()) {
812 $captcha->add($this);
813 $this->assign('isCaptcha', TRUE);
814 }
ce287b85
AP
815 }
816
817 /**
818 * Display ReCAPTCHA warning on Contribution form
819 */
820 protected function displayCaptchaWarning() {
821 if (CRM_Core_Permission::check("administer CiviCRM")) {
822 $captcha = CRM_Utils_ReCAPTCHA::singleton();
823 if (!$captcha->hasSettingsAvailable()) {
824 $this->assign('displayCaptchaWarning', TRUE);
825 }
8237b510 826 }
96ea60e0
AP
827 }
828
ce287b85
AP
829 /**
830 * Check if ReCAPTCHA has to be added on Contribution form forcefully.
831 */
832 protected function hasToAddForcefully() {
833 $captcha = CRM_Utils_ReCAPTCHA::singleton();
834 return $captcha->hasToAddForcefully();
835 }
836
4779abb3 837 /**
838 * Add onbehalf/honoree profile fields and native module fields.
839 *
840 * @param int $id
841 * @param CRM_Core_Form $form
842 */
bcb8cc84 843 public function buildComponentForm($id, $form) {
844 if (empty($id)) {
845 return;
846 }
847
848 $contactID = $this->getContactID();
849
850 foreach (array('soft_credit', 'on_behalf') as $module) {
bcb8cc84 851 if ($module == 'soft_credit') {
4779abb3 852 if (empty($form->_values['honoree_profile_id'])) {
853 continue;
854 }
bcb8cc84 855
4779abb3 856 if (!CRM_Core_DAO::getFieldValue('CRM_Core_DAO_UFGroup', $form->_values['honoree_profile_id'], 'is_active')) {
bcb8cc84 857 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.'));
858 }
859
4779abb3 860 $profileContactType = CRM_Core_BAO_UFGroup::getContactType($form->_values['honoree_profile_id']);
bcb8cc84 861 $requiredProfileFields = array(
862 'Individual' => array('first_name', 'last_name'),
863 'Organization' => array('organization_name', 'email'),
864 'Household' => array('household_name', 'email'),
865 );
4779abb3 866 $validProfile = CRM_Core_BAO_UFGroup::checkValidProfile($form->_values['honoree_profile_id'], $requiredProfileFields[$profileContactType]);
bcb8cc84 867 if (!$validProfile) {
868 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.'));
869 }
870
cb804cd9 871 foreach (array('honor_block_title', 'honor_block_text') as $name) {
4779abb3 872 $form->assign($name, $form->_values[$name]);
cb804cd9 873 }
874
875 $softCreditTypes = CRM_Core_OptionGroup::values("soft_credit_type", FALSE);
876
877 // radio button for Honor Type
4779abb3 878 foreach ($form->_values['soft_credit_types'] as $value) {
cb804cd9 879 $honorTypes[$value] = $form->createElement('radio', NULL, NULL, $softCreditTypes[$value], $value);
880 }
881 $form->addGroup($honorTypes, 'soft_credit_type_id', NULL)->setAttribute('allowClear', TRUE);
882
4779abb3 883 $honoreeProfileFields = CRM_Core_BAO_UFGroup::getFields(
884 $this->_values['honoree_profile_id'], FALSE,
885 NULL, NULL,
886 NULL, FALSE,
887 NULL, TRUE,
888 NULL, CRM_Core_Permission::CREATE
cb804cd9 889 );
cb804cd9 890 $form->assign('honoreeProfileFields', $honoreeProfileFields);
891
892 // add the form elements
893 foreach ($honoreeProfileFields as $name => $field) {
894 // If soft credit type is not chosen then make omit requiredness from honoree profile fields
895 if (count($form->_submitValues) &&
896 empty($form->_submitValues['soft_credit_type_id']) &&
897 !empty($field['is_required'])
898 ) {
899 $field['is_required'] = FALSE;
900 }
c043358f 901 CRM_Core_BAO_UFGroup::buildProfile($form, $field, CRM_Profile_Form::MODE_CREATE, NULL, FALSE, FALSE, NULL, 'honor');
cb804cd9 902 }
bcb8cc84 903 }
904 else {
4779abb3 905 if (empty($form->_values['onbehalf_profile_id'])) {
906 continue;
907 }
bcb8cc84 908
4779abb3 909 if (!CRM_Core_DAO::getFieldValue('CRM_Core_DAO_UFGroup', $form->_values['onbehalf_profile_id'], 'is_active')) {
bcb8cc84 910 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.'));
911 }
912
913 $member = CRM_Member_BAO_Membership::getMembershipBlock($form->_id);
914 if (empty($member['is_active'])) {
915 $msg = ts('Mixed profile not allowed for on behalf of registration/sign up.');
4779abb3 916 $onBehalfProfile = CRM_Core_BAO_UFGroup::profileGroups($form->_values['onbehalf_profile_id']);
0c7c9ff7
KC
917 foreach (
918 array(
bcb8cc84 919 'Individual',
920 'Organization',
921 'Household',
0c7c9ff7
KC
922 ) as $contactType
923 ) {
bcb8cc84 924 if (in_array($contactType, $onBehalfProfile) &&
925 (in_array('Membership', $onBehalfProfile) ||
926 in_array('Contribution', $onBehalfProfile)
927 )
928 ) {
929 CRM_Core_Error::fatal($msg);
930 }
931 }
932 }
933
c043358f 934 if ($contactID) {
33260076 935 // retrieve all permissioned organizations of contact $contactID
936 $organizations = CRM_Contact_BAO_Relationship::getPermissionedContacts($contactID, NULL, NULL, 'Organization');
c043358f 937
33260076 938 if (count($organizations)) {
c043358f 939 // Related org url - pass checksum if needed
f23093b2 940 $args = array(
4779abb3 941 'ufId' => $form->_values['onbehalf_profile_id'],
f23093b2 942 'cid' => '',
943 );
c043358f 944 if (!empty($_GET['cs'])) {
945 $args = array(
4779abb3 946 'ufId' => $form->_values['onbehalf_profile_id'],
c043358f 947 'uid' => $this->_contactID,
948 'cs' => $_GET['cs'],
949 'cid' => '',
950 );
951 }
952 $locDataURL = CRM_Utils_System::url('civicrm/ajax/permlocation', $args, FALSE, NULL, FALSE);
953 $form->assign('locDataURL', $locDataURL);
954 }
33260076 955 if (count($organizations) > 0) {
956 $form->add('select', 'onbehalfof_id', '', CRM_Utils_Array::collect('name', $organizations));
c043358f 957
958 $orgOptions = array(
959 0 => ts('Select an existing organization'),
960 1 => ts('Enter a new organization'),
961 );
962 $form->addRadio('org_option', ts('options'), $orgOptions);
963 $form->setDefaults(array('org_option' => 0));
964 }
bcb8cc84 965 }
966
8bf67b7d 967 $form->assign('fieldSetTitle', ts(CRM_Core_BAO_UFGroup::getTitle($form->_values['onbehalf_profile_id'])));
c043358f 968
4779abb3 969 if (CRM_Utils_Array::value('is_for_organization', $form->_values)) {
970 if ($form->_values['is_for_organization'] == 2) {
c043358f 971 $form->assign('onBehalfRequired', TRUE);
bcb8cc84 972 }
973 else {
974 $form->addElement('checkbox', 'is_for_organization',
975 $form->_values['for_organization'],
976 NULL
977 );
978 }
979 }
c043358f 980
4779abb3 981 $profileFields = CRM_Core_BAO_UFGroup::getFields(
982 $form->_values['onbehalf_profile_id'],
983 FALSE, CRM_Core_Action::VIEW, NULL,
984 NULL, FALSE, NULL, FALSE, NULL,
985 CRM_Core_Permission::CREATE, NULL
c043358f 986 );
4779abb3 987
c043358f 988 $form->assign('onBehalfOfFields', $profileFields);
989 if (!empty($form->_submitValues['onbehalf'])) {
990 if (!empty($form->_submitValues['onbehalfof_id'])) {
991 $form->assign('submittedOnBehalf', $form->_submitValues['onbehalfof_id']);
992 }
d425f39b 993 $form->assign('submittedOnBehalfInfo', json_encode(str_replace('"', '\"', $form->_submitValues['onbehalf']), JSON_HEX_APOS));
c043358f 994 }
995
996 $fieldTypes = array('Contact', 'Organization');
a6a083d8 997 if (!empty($form->_membershipBlock)) {
998 $fieldTypes = array_merge($fieldTypes, array('Membership'));
999 }
c043358f 1000 $contactSubType = CRM_Contact_BAO_ContactType::subTypes('Organization');
1001 $fieldTypes = array_merge($fieldTypes, $contactSubType);
1002
1003 foreach ($profileFields as $name => $field) {
1004 if (in_array($field['field_type'], $fieldTypes)) {
1005 list($prefixName, $index) = CRM_Utils_System::explode('-', $name, 2);
1006 if (in_array($prefixName, array('organization_name', 'email')) && empty($field['is_required'])) {
1007 $field['is_required'] = 1;
1008 }
1009 if (count($form->_submitValues) &&
1010 empty($form->_submitValues['is_for_organization']) &&
4779abb3 1011 $form->_values['is_for_organization'] == 1 &&
c043358f 1012 !empty($field['is_required'])
1013 ) {
1014 $field['is_required'] = FALSE;
1015 }
4779abb3 1016 CRM_Core_BAO_UFGroup::buildProfile($form, $field, NULL, NULL, FALSE, 'onbehalf', NULL, 'onbehalf');
c043358f 1017 }
1018 }
bcb8cc84 1019 }
1020 }
1021
1022 }
1023
f4aaa82a 1024 /**
fe482240 1025 * Check template file exists.
f92d1e2a
EM
1026 *
1027 * @param string $suffix
f4aaa82a
EM
1028 *
1029 * @return null|string
1030 */
00be9182 1031 public function checkTemplateFileExists($suffix = NULL) {
6a488035
TO
1032 if ($this->_id) {
1033 $templateFile = "CRM/Contribute/Form/Contribution/{$this->_id}/{$this->_name}.{$suffix}tpl";
1034 $template = CRM_Core_Form::getTemplate();
1035 if ($template->template_exists($templateFile)) {
1036 return $templateFile;
1037 }
1038 }
1039 return NULL;
1040 }
1041
186c9c17 1042 /**
fe482240 1043 * Use the form name to create the tpl file name.
186c9c17
EM
1044 *
1045 * @return string
186c9c17 1046 */
00be9182 1047 public function getTemplateFileName() {
6a488035
TO
1048 $fileName = $this->checkTemplateFileExists();
1049 return $fileName ? $fileName : parent::getTemplateFileName();
1050 }
1051
186c9c17 1052 /**
f92d1e2a
EM
1053 * Add the extra.tpl in.
1054 *
186c9c17 1055 * Default extra tpl file basically just replaces .tpl with .extra.tpl
f92d1e2a 1056 * i.e. we do not override - why isn't this done at the CRM_Core_Form level?
186c9c17
EM
1057 *
1058 * @return string
186c9c17 1059 */
00be9182 1060 public function overrideExtraTemplateFileName() {
6a488035
TO
1061 $fileName = $this->checkTemplateFileExists('extra.');
1062 return $fileName ? $fileName : parent::overrideExtraTemplateFileName();
1063 }
1064
1065 /**
100fef9d 1066 * Authenticate pledge user during online payment.
6a488035
TO
1067 */
1068 public function authenticatePledgeUser() {
1069 //get the userChecksum and contact id
1070 $userChecksum = CRM_Utils_Request::retrieve('cs', 'String', $this);
1071 $contactID = CRM_Utils_Request::retrieve('cid', 'Positive', $this);
1072
1073 //get pledge status and contact id
353ffa53
TO
1074 $pledgeValues = array();
1075 $pledgeParams = array('id' => $this->_values['pledge_id']);
6a488035
TO
1076 $returnProperties = array('contact_id', 'status_id');
1077 CRM_Core_DAO::commonRetrieve('CRM_Pledge_DAO_Pledge', $pledgeParams, $pledgeValues, $returnProperties);
1078
1079 //get all status
1080 $allStatus = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');
353ffa53
TO
1081 $validStatus = array(
1082 array_search('Pending', $allStatus),
6a488035
TO
1083 array_search('In Progress', $allStatus),
1084 array_search('Overdue', $allStatus),
1085 );
1086
1087 $validUser = FALSE;
1088 if ($this->_userID &&
1089 $this->_userID == $pledgeValues['contact_id']
1090 ) {
1091 //check for authenticated user.
1092 $validUser = TRUE;
1093 }
1094 elseif ($userChecksum && $pledgeValues['contact_id']) {
1095 //check for anonymous user.
1096 $validUser = CRM_Contact_BAO_Contact_Utils::validChecksum($pledgeValues['contact_id'], $userChecksum);
1097
1098 //make sure cid is same as pledge contact id
1099 if ($validUser && ($pledgeValues['contact_id'] != $contactID)) {
1100 $validUser = FALSE;
1101 }
1102 }
1103
1104 if (!$validUser) {
1105 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."));
1106 }
1107
1108 //check for valid pledge status.
1109 if (!in_array($pledgeValues['status_id'], $validStatus)) {
1110 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))));
1111 }
1112 }
1113
1114 /**
f92d1e2a
EM
1115 * Cancel recurring contributions.
1116 *
6a488035
TO
1117 * In case user cancel recurring contribution,
1118 * When we get the control back from payment gate way
1119 * lets delete the recurring and related contribution.
389bcebf 1120 */
6a488035 1121 public function cancelRecurring() {
a3d827a7 1122 $isCancel = CRM_Utils_Request::retrieve('cancel', 'Boolean');
6a488035 1123 if ($isCancel) {
a3d827a7
CW
1124 $isRecur = CRM_Utils_Request::retrieve('isRecur', 'Boolean');
1125 $recurId = CRM_Utils_Request::retrieve('recurId', 'Positive');
6a488035
TO
1126 //clean db for recurring contribution.
1127 if ($isRecur && $recurId) {
1128 CRM_Contribute_BAO_ContributionRecur::deleteRecurContribution($recurId);
1129 }
a3d827a7 1130 $contribId = CRM_Utils_Request::retrieve('contribId', 'Positive');
6a488035
TO
1131 if ($contribId) {
1132 CRM_Contribute_BAO_Contribution::deleteContribution($contribId);
1133 }
1134 }
1135 }
96025800 1136
42e3a033
EM
1137 /**
1138 * Build Membership Block in Contribution Pages.
1139 *
42e3a033
EM
1140 * @param int $cid
1141 * Contact checked for having a current membership for a particular membership.
a46bfec1
EM
1142 * @param bool $isContributionMainPage
1143 * Is this the main page? If so add form input fields.
1144 * (or better yet don't have this functionality in a function shared with forms that don't share it).
376b971e 1145 * @param int|array $selectedMembershipTypeID
42e3a033
EM
1146 * Selected membership id.
1147 * @param bool $thankPage
1148 * Thank you page.
1149 * @param null $isTest
1150 *
1151 * @return bool
1152 * Is this a separate membership payment
1153 */
1154 protected function buildMembershipBlock(
1155 $cid,
a46bfec1 1156 $isContributionMainPage = FALSE,
42e3a033
EM
1157 $selectedMembershipTypeID = NULL,
1158 $thankPage = FALSE,
1159 $isTest = NULL
1160 ) {
1161
1162 $separateMembershipPayment = FALSE;
1163 if ($this->_membershipBlock) {
1164 $this->_currentMemberships = array();
1165
42e3a033
EM
1166 $membershipTypeIds = $membershipTypes = $radio = array();
1167 $membershipPriceset = (!empty($this->_priceSetId) && $this->_useForMember) ? TRUE : FALSE;
1168
1169 $allowAutoRenewMembership = $autoRenewOption = FALSE;
1170 $autoRenewMembershipTypeOptions = array();
1171
a46bfec1 1172 $separateMembershipPayment = CRM_Utils_Array::value('is_separate_payment', $this->_membershipBlock);
42e3a033
EM
1173
1174 if ($membershipPriceset) {
1175 foreach ($this->_priceSet['fields'] as $pField) {
1176 if (empty($pField['options'])) {
1177 continue;
1178 }
1179 foreach ($pField['options'] as $opId => $opValues) {
1180 if (empty($opValues['membership_type_id'])) {
1181 continue;
1182 }
1183 $membershipTypeIds[$opValues['membership_type_id']] = $opValues['membership_type_id'];
1184 }
1185 }
1186 }
a46bfec1
EM
1187 elseif (!empty($this->_membershipBlock['membership_types'])) {
1188 $membershipTypeIds = explode(',', $this->_membershipBlock['membership_types']);
42e3a033
EM
1189 }
1190
1191 if (!empty($membershipTypeIds)) {
1192 //set status message if wrong membershipType is included in membershipBlock
1193 if (isset($this->_mid) && !$membershipPriceset) {
1194 $membershipTypeID = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_Membership',
1195 $this->_mid,
1196 'membership_type_id'
1197 );
1198 if (!in_array($membershipTypeID, $membershipTypeIds)) {
1199 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');
1200 }
1201 }
1202
4c7b8a7d 1203 $membershipTypeValues = CRM_Member_BAO_Membership::buildMembershipTypeValues($this, $membershipTypeIds);
42e3a033
EM
1204 $this->_membershipTypeValues = $membershipTypeValues;
1205 $endDate = NULL;
1206 foreach ($membershipTypeIds as $value) {
1207 $memType = $membershipTypeValues[$value];
1208 if ($selectedMembershipTypeID != NULL) {
1209 if ($memType['id'] == $selectedMembershipTypeID) {
1210 $this->assign('minimum_fee',
1211 CRM_Utils_Array::value('minimum_fee', $memType)
1212 );
1213 $this->assign('membership_name', $memType['name']);
1214 if (!$thankPage && $cid) {
1215 $membership = new CRM_Member_DAO_Membership();
1216 $membership->contact_id = $cid;
1217 $membership->membership_type_id = $memType['id'];
1218 if ($membership->find(TRUE)) {
1219 $this->assign('renewal_mode', TRUE);
1220 $memType['current_membership'] = $membership->end_date;
1221 $this->_currentMemberships[$membership->membership_type_id] = $membership->membership_type_id;
1222 }
1223 }
1224 $membershipTypes[] = $memType;
1225 }
1226 }
1227 elseif ($memType['is_active']) {
1228 $javascriptMethod = NULL;
08a4ce4e 1229 $allowAutoRenewOpt = (int) $memType['auto_renew'];
42e3a033
EM
1230 if (is_array($this->_paymentProcessors)) {
1231 foreach ($this->_paymentProcessors as $id => $val) {
fb357d6e 1232 if ($id && !$val['is_recur']) {
42e3a033
EM
1233 $allowAutoRenewOpt = 0;
1234 continue;
1235 }
1236 }
1237 }
1238
1239 $javascriptMethod = array('onclick' => "return showHideAutoRenew( this.value );");
1240 $autoRenewMembershipTypeOptions["autoRenewMembershipType_{$value}"] = (int) $allowAutoRenewOpt * CRM_Utils_Array::value($value, CRM_Utils_Array::value('auto_renew', $this->_membershipBlock));;
1241
1242 if ($allowAutoRenewOpt) {
1243 $allowAutoRenewMembership = TRUE;
1244 }
1245
1246 //add membership type.
1247 $radio[$memType['id']] = $this->createElement('radio', NULL, NULL, NULL,
1248 $memType['id'], $javascriptMethod
1249 );
1250 if ($cid) {
1251 $membership = new CRM_Member_DAO_Membership();
1252 $membership->contact_id = $cid;
1253 $membership->membership_type_id = $memType['id'];
1254
1255 //show current membership, skip pending and cancelled membership records,
1256 //because we take first membership record id for renewal
1257 $membership->whereAdd('status_id != 5 AND status_id !=6');
1258
1259 if (!is_null($isTest)) {
1260 $membership->is_test = $isTest;
1261 }
1262
1263 //CRM-4297
1264 $membership->orderBy('end_date DESC');
1265
1266 if ($membership->find(TRUE)) {
1267 if (!$membership->end_date) {
1268 unset($radio[$memType['id']]);
1269 $this->assign('islifetime', TRUE);
1270 continue;
1271 }
1272 $this->assign('renewal_mode', TRUE);
1273 $this->_currentMemberships[$membership->membership_type_id] = $membership->membership_type_id;
1274 $memType['current_membership'] = $membership->end_date;
1275 if (!$endDate) {
1276 $endDate = $memType['current_membership'];
1277 $this->_defaultMemTypeId = $memType['id'];
1278 }
1279 if ($memType['current_membership'] < $endDate) {
1280 $endDate = $memType['current_membership'];
1281 $this->_defaultMemTypeId = $memType['id'];
1282 }
1283 }
1284 }
1285 $membershipTypes[] = $memType;
1286 }
1287 }
1288 }
1289
a46bfec1
EM
1290 $this->assign('membershipBlock', $this->_membershipBlock);
1291 $this->assign('showRadio', $isContributionMainPage);
1292 $this->assign('membershipTypes', $membershipTypes);
1293 $this->assign('allowAutoRenewMembership', $allowAutoRenewMembership);
1294 $this->assign('autoRenewMembershipTypeOptions', json_encode($autoRenewMembershipTypeOptions));
1295 //give preference to user submitted auto_renew value.
1296 $takeUserSubmittedAutoRenew = (!empty($_POST) || $this->isSubmitted()) ? TRUE : FALSE;
1297 $this->assign('takeUserSubmittedAutoRenew', $takeUserSubmittedAutoRenew);
1298
c843169c
MW
1299 // Assign autorenew option (0:hide,1:optional,2:required) so we can use it in confirmation etc.
1300 $autoRenewOption = CRM_Price_BAO_PriceSet::checkAutoRenewForPriceSet($this->_priceSetId);
376b971e
JP
1301 //$selectedMembershipTypeID is retrieved as an array for membership priceset if multiple
1302 //options for different organisation is selected on the contribution page.
1303 if (is_numeric($selectedMembershipTypeID) && isset($membershipTypeValues[$selectedMembershipTypeID]['auto_renew'])) {
c843169c
MW
1304 $this->assign('autoRenewOption', $membershipTypeValues[$selectedMembershipTypeID]['auto_renew']);
1305 }
1306 else {
1307 $this->assign('autoRenewOption', $autoRenewOption);
1308 }
1309
a46bfec1 1310 if ($isContributionMainPage) {
42e3a033 1311 if (!$membershipPriceset) {
a46bfec1 1312 if (!$this->_membershipBlock['is_required']) {
42e3a033
EM
1313 $this->assign('showRadioNoThanks', TRUE);
1314 $radio[''] = $this->createElement('radio', NULL, NULL, NULL, 'no_thanks', NULL);
1315 $this->addGroup($radio, 'selectMembership', NULL);
1316 }
a46bfec1 1317 elseif ($this->_membershipBlock['is_required'] && count($radio) == 1) {
42e3a033
EM
1318 $temp = array_keys($radio);
1319 $this->add('hidden', 'selectMembership', $temp[0], array('id' => 'selectMembership'));
1320 $this->assign('singleMembership', TRUE);
1321 $this->assign('showRadio', FALSE);
1322 }
1323 else {
1324 $this->addGroup($radio, 'selectMembership', NULL);
1325 }
1326
1327 $this->addRule('selectMembership', ts('Please select one of the memberships.'), 'required');
1328 }
42e3a033 1329
fb357d6e 1330 if ((!$this->_values['is_pay_later'] || is_array($this->_paymentProcessors)) && ($allowAutoRenewMembership || $autoRenewOption)) {
c843169c
MW
1331 if ($autoRenewOption == 2) {
1332 $this->addElement('hidden', 'auto_renew', ts('Please renew my membership automatically.'));
1333 }
1334 else {
1335 $this->addElement('checkbox', 'auto_renew', ts('Please renew my membership automatically.'));
1336 }
42e3a033
EM
1337 }
1338
1339 }
42e3a033
EM
1340 }
1341
1342 return $separateMembershipPayment;
1343 }
1344
90102a32
EM
1345 /**
1346 * Determine if recurring parameters need to be added to the form parameters.
8cb12ff1 1347 *
90102a32
EM
1348 * - is_recur
1349 * - frequency_interval
1350 * - frequency_unit
1351 *
1352 * For membership this is based on the membership type.
1353 *
1354 * This needs to be done before processing the pre-approval redirect where relevant on the main page or before any payment processing.
1355 *
1356 * Arguably the form should start to build $this->_params in the pre-process main page & use that array consistently throughout.
1357 */
1358 protected function setRecurringMembershipParams() {
8cb12ff1 1359 $selectedMembershipTypeID = CRM_Utils_Array::value('selectMembership', $this->_params);
1360 if ($selectedMembershipTypeID) {
fd359255
EM
1361 // @todo the price_x fields will ALWAYS allow us to determine the membership - so we should ignore
1362 // 'selectMembership' and calculate from the price_x fields so we have one method that always works
1363 // this is lazy & only catches when selectMembership is set, but the worst of all worlds would be to fix
1364 // this with an else (calculate for price set).
8cb12ff1 1365 $membershipTypes = CRM_Price_BAO_PriceSet::getMembershipTypesFromPriceSet($this->_priceSetId);
1366 if (in_array($selectedMembershipTypeID, $membershipTypes['autorenew_required'])
1367 || (in_array($selectedMembershipTypeID, $membershipTypes['autorenew_optional']) &&
1368 !empty($this->_params['is_recur']))
1369 ) {
fd359255
EM
1370 $this->_params['auto_renew'] = TRUE;
1371 }
1372 }
8cb12ff1 1373 if ((!empty($this->_params['selectMembership']) || !empty($this->_params['priceSetId']))
1374 && !empty($this->_paymentProcessor['is_recur']) &&
1375 CRM_Utils_Array::value('auto_renew', $this->_params)
1376 && empty($this->_params['is_recur']) && empty($this->_params['frequency_interval'])
90102a32
EM
1377 ) {
1378
1379 $this->_params['is_recur'] = $this->_values['is_recur'] = 1;
1380 // check if price set is not quick config
1381 if (!empty($this->_params['priceSetId']) && !CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceSet', $this->_params['priceSetId'], 'is_quick_config')) {
1382 list($this->_params['frequency_interval'], $this->_params['frequency_unit']) = CRM_Price_BAO_PriceSet::getRecurDetails($this->_params['priceSetId']);
1383 }
1384 else {
1385 // FIXME: set interval and unit based on selected membership type
1386 $this->_params['frequency_interval'] = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipType',
1387 $this->_params['selectMembership'], 'duration_interval'
1388 );
1389 $this->_params['frequency_unit'] = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipType',
1390 $this->_params['selectMembership'], 'duration_unit'
1391 );
1392 }
1393 }
1394 }
1395
6a488035 1396}