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