Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
7e9e8871 | 4 | | CiviCRM version 4.7 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
0f03f337 | 6 | | Copyright CiviCRM LLC (c) 2004-2017 | |
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 | |
0f03f337 | 31 | * @copyright CiviCRM LLC (c) 2004-2017 |
6a488035 TO |
32 | */ |
33 | ||
34 | /** | |
35 | * This class generates form components for Membership Renewal | |
6a488035 TO |
36 | */ |
37 | class CRM_Member_Form_MembershipRenewal extends CRM_Member_Form { | |
d424ffde CW |
38 | |
39 | /** | |
fe482240 | 40 | * Display name of the member. |
d424ffde CW |
41 | * |
42 | * @var string | |
6a488035 | 43 | */ |
b09fe5ed | 44 | protected $_memberDisplayName = NULL; |
d424ffde CW |
45 | |
46 | /** | |
47 | * email of the person paying for the membership (used for receipts) | |
48 | */ | |
b09fe5ed | 49 | protected $_memberEmail = NULL; |
d424ffde CW |
50 | |
51 | /** | |
fe482240 | 52 | * Contact ID of the member. |
d424ffde CW |
53 | * |
54 | * | |
55 | * @var int | |
56 | */ | |
b09fe5ed | 57 | public $_contactID = NULL; |
d424ffde CW |
58 | |
59 | /** | |
60 | * Display name of the person paying for the membership (used for receipts) | |
61 | * | |
62 | * @var string | |
63 | */ | |
b09fe5ed | 64 | protected $_contributorDisplayName = NULL; |
d424ffde CW |
65 | |
66 | /** | |
67 | * email of the person paying for the membership (used for receipts) | |
68 | */ | |
b09fe5ed | 69 | protected $_contributorEmail = NULL; |
d424ffde CW |
70 | |
71 | /** | |
72 | * email of the person paying for the membership (used for receipts) | |
73 | * | |
74 | * @var int | |
75 | */ | |
b09fe5ed | 76 | protected $_contributorContactID = NULL; |
d424ffde CW |
77 | |
78 | /** | |
79 | * ID of the person the receipt is to go to | |
80 | * | |
81 | * @var int | |
82 | */ | |
b09fe5ed | 83 | protected $_receiptContactId = NULL; |
d424ffde CW |
84 | |
85 | /** | |
6a488035 TO |
86 | * context would be set to standalone if the contact is use is being selected from |
87 | * the form rather than in the URL | |
88 | */ | |
dda27a57 | 89 | public $_context; |
6a488035 | 90 | |
af990df6 EM |
91 | /** |
92 | * End date of renewed membership. | |
93 | * | |
94 | * @var string | |
95 | */ | |
96 | protected $endDate = NULL; | |
97 | ||
98 | /** | |
99 | * Has an email been sent. | |
100 | * | |
101 | * @var string | |
102 | */ | |
103 | protected $isMailSent = FALSE; | |
104 | ||
105 | /** | |
106 | * The name of the renewed membership type. | |
107 | * | |
108 | * @var string | |
109 | */ | |
110 | protected $membershipTypeName = ''; | |
111 | ||
5d86176b | 112 | /** |
113 | * An array to hold a list of datefields on the form | |
114 | * so that they can be converted to ISO in a consistent manner | |
115 | * | |
116 | * @var array | |
117 | */ | |
118 | protected $_dateFields = array( | |
119 | 'receive_date' => array('default' => 'now'), | |
120 | ); | |
121 | ||
c73f0c56 | 122 | /** |
123 | * Pre-process form. | |
124 | * | |
125 | * @throws \Exception | |
126 | */ | |
6a488035 | 127 | public function preProcess() { |
6a488035 | 128 | |
186a737c EM |
129 | // This string makes up part of the class names, differentiating them (not sure why) from the membership fields. |
130 | $this->assign('formClass', 'membershiprenew'); | |
a6513ad5 | 131 | parent::preProcess(); |
6a488035 TO |
132 | |
133 | $this->assign('endDate', CRM_Utils_Date::customFormat(CRM_Core_DAO::getFieldValue('CRM_Member_DAO_Membership', | |
353ffa53 TO |
134 | $this->_id, 'end_date' |
135 | ) | |
136 | )); | |
6a488035 TO |
137 | $this->assign('membershipStatus', |
138 | CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipStatus', | |
139 | CRM_Core_DAO::getFieldValue('CRM_Member_DAO_Membership', | |
140 | $this->_id, 'status_id' | |
141 | ), | |
142 | 'name' | |
143 | ) | |
144 | ); | |
145 | ||
6a488035 TO |
146 | if ($this->_mode) { |
147 | $membershipFee = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipType', $this->_memType, 'minimum_fee'); | |
148 | if (!$membershipFee) { | |
a6513ad5 | 149 | $statusMsg = ts('Membership Renewal using a credit card requires a Membership fee. Since there is no fee associated with the selected membership type, you can use the normal renewal mode.'); |
6a488035 TO |
150 | CRM_Core_Session::setStatus($statusMsg, '', 'info'); |
151 | CRM_Utils_System::redirect(CRM_Utils_System::url('civicrm/contact/view/membership', | |
353ffa53 TO |
152 | "reset=1&action=renew&cid={$this->_contactID}&id={$this->_id}&context=membership" |
153 | )); | |
6a488035 | 154 | } |
6a488035 TO |
155 | } |
156 | ||
157 | // when custom data is included in this page | |
a7488080 | 158 | if (!empty($_POST['hidden_custom'])) { |
9ac2fef4 | 159 | CRM_Custom_Form_CustomData::preProcess($this, NULL, $this->_memType, 1, 'Membership', $this->_id); |
6a488035 TO |
160 | CRM_Custom_Form_CustomData::buildQuickForm($this); |
161 | CRM_Custom_Form_CustomData::setDefaultValues($this); | |
162 | } | |
163 | ||
e2046b33 | 164 | CRM_Utils_System::setTitle(ts('Renew Membership')); |
af990df6 EM |
165 | |
166 | parent::preProcess(); | |
6a488035 TO |
167 | } |
168 | ||
169 | /** | |
c490a46a | 170 | * Set default values for the form. |
6a488035 TO |
171 | * the default values are retrieved from the database |
172 | * | |
2f9f578f EM |
173 | * @return array |
174 | * Default values. | |
6a488035 TO |
175 | */ |
176 | public function setDefaultValues() { | |
a6513ad5 | 177 | |
353ffa53 | 178 | $defaults = parent::setDefaultValues(); |
6a488035 TO |
179 | $this->_memType = $defaults['membership_type_id']; |
180 | ||
181 | // set renewal_date and receive_date to today in correct input format (setDateDefaults uses today if no value passed) | |
a9c72cdb | 182 | list($now, $currentTime) = CRM_Utils_Date::setDateDefaults(); |
6a488035 TO |
183 | $defaults['renewal_date'] = $now; |
184 | $defaults['receive_date'] = $now; | |
a9c72cdb | 185 | $defaults['receive_date_time'] = $currentTime; |
6a488035 TO |
186 | |
187 | if ($defaults['id']) { | |
188 | $defaults['record_contribution'] = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipPayment', | |
189 | $defaults['id'], | |
190 | 'contribution_id', | |
191 | 'membership_id' | |
192 | ); | |
193 | } | |
194 | ||
195 | if (is_numeric($this->_memType)) { | |
196 | $defaults['membership_type_id'] = array(); | |
197 | $defaults['membership_type_id'][0] = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipType', | |
198 | $this->_memType, | |
199 | 'member_of_contact_id', | |
200 | 'id' | |
201 | ); | |
202 | $defaults['membership_type_id'][1] = $this->_memType; | |
203 | } | |
204 | else { | |
205 | $defaults['membership_type_id'] = $this->_memType; | |
206 | } | |
207 | ||
208 | $defaults['financial_type_id'] = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipType', $this->_memType, 'financial_type_id'); | |
133e2c99 | 209 | |
d96cf288 | 210 | //CRM-13420 |
a7488080 | 211 | if (empty($defaults['payment_instrument_id'])) { |
d96cf288 DG |
212 | $defaults['payment_instrument_id'] = key(CRM_Core_OptionGroup::values('payment_instrument', FALSE, FALSE, FALSE, 'AND is_default = 1')); |
213 | } | |
6a488035 TO |
214 | |
215 | $defaults['total_amount'] = CRM_Utils_Money::format(CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipType', | |
353ffa53 TO |
216 | $this->_memType, |
217 | 'minimum_fee' | |
218 | ), NULL, '%a'); | |
6a488035 | 219 | |
6a488035 TO |
220 | $defaults['record_contribution'] = 0; |
221 | $defaults['num_terms'] = 1; | |
222 | $defaults['send_receipt'] = 0; | |
223 | ||
374a4dd6 | 224 | //set Soft Credit Type to Gift by default |
225 | $scTypes = CRM_Core_OptionGroup::values("soft_credit_type"); | |
226 | $defaults['soft_credit_type_id'] = CRM_Utils_Array::value(ts('Gift'), array_flip($scTypes)); | |
227 | ||
6a488035 TO |
228 | $renewalDate = CRM_Utils_Date::processDate(CRM_Utils_Array::value('renewal_date', $defaults), |
229 | NULL, NULL, 'Y-m-d' | |
230 | ); | |
231 | $this->assign('renewalDate', $renewalDate); | |
232 | $this->assign('member_is_test', CRM_Utils_Array::value('member_is_test', $defaults)); | |
233 | ||
234 | if ($this->_mode) { | |
3b8e6c3f | 235 | $defaults = $this->getBillingDefaults($defaults); |
6a488035 | 236 | } |
6a488035 TO |
237 | return $defaults; |
238 | } | |
239 | ||
240 | /** | |
fe482240 | 241 | * Build the form object. |
6a488035 TO |
242 | */ |
243 | public function buildQuickForm() { | |
6a488035 TO |
244 | |
245 | parent::buildQuickForm(); | |
246 | ||
353ffa53 | 247 | $defaults = parent::setDefaultValues(); |
6a488035 TO |
248 | $this->_memType = $defaults['membership_type_id']; |
249 | $this->assign('customDataType', 'Membership'); | |
250 | $this->assign('customDataSubType', $this->_memType); | |
251 | $this->assign('entityID', $this->_id); | |
252 | $selOrgMemType[0][0] = $selMemTypeOrg[0] = ts('- select -'); | |
253 | ||
ab30e033 | 254 | $allMembershipInfo = array(); |
6a488035 | 255 | |
414368d7 BS |
256 | //CRM-16950 |
257 | $taxRates = CRM_Core_PseudoConstant::getTaxRates(); | |
e43ad82d | 258 | $taxRate = CRM_Utils_Array::value($this->allMembershipTypeDetails[$defaults['membership_type_id']]['financial_type_id'], $taxRates); |
414368d7 | 259 | |
aaffa79f | 260 | $invoiceSettings = Civi::settings()->get('contribution_invoice_settings'); |
805eecf8 | 261 | |
6a488035 | 262 | // auto renew options if enabled for the membership |
dbd82592 | 263 | $options = CRM_Core_SelectValues::memberAutoRenew(); |
6a488035 | 264 | |
ab30e033 | 265 | foreach ($this->allMembershipTypeDetails as $key => $values) { |
a7488080 | 266 | if (!empty($values['is_active'])) { |
8cc574cf | 267 | if ($this->_mode && empty($values['minimum_fee'])) { |
6a488035 TO |
268 | continue; |
269 | } | |
270 | else { | |
271 | $memberOfContactId = CRM_Utils_Array::value('member_of_contact_id', $values); | |
a7488080 | 272 | if (empty($selMemTypeOrg[$memberOfContactId])) { |
6a488035 TO |
273 | $selMemTypeOrg[$memberOfContactId] = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', |
274 | $memberOfContactId, | |
275 | 'display_name', | |
276 | 'id' | |
277 | ); | |
278 | ||
279 | $selOrgMemType[$memberOfContactId][0] = ts('- select -'); | |
280 | } | |
a7488080 | 281 | if (empty($selOrgMemType[$memberOfContactId][$key])) { |
6a488035 TO |
282 | $selOrgMemType[$memberOfContactId][$key] = CRM_Utils_Array::value('name', $values); |
283 | } | |
284 | } | |
285 | ||
414368d7 | 286 | //CRM-16950 |
805eecf8 | 287 | $taxAmount = NULL; |
414368d7 | 288 | $totalAmount = CRM_Utils_Array::value('minimum_fee', $values); |
805eecf8 | 289 | if (CRM_Utils_Array::value($values['financial_type_id'], $taxRates)) { |
a9629de4 | 290 | $taxAmount = ($taxRate / 100) * CRM_Utils_Array::value('minimum_fee', $values); |
414368d7 | 291 | $totalAmount = $totalAmount + $taxAmount; |
414368d7 BS |
292 | } |
293 | ||
6a488035 TO |
294 | // build membership info array, which is used to set the payment information block when |
295 | // membership type is selected. | |
296 | $allMembershipInfo[$key] = array( | |
297 | 'financial_type_id' => CRM_Utils_Array::value('financial_type_id', $values), | |
414368d7 BS |
298 | 'total_amount' => CRM_Utils_Money::format($totalAmount, NULL, '%a'), |
299 | 'total_amount_numeric' => $totalAmount, | |
805eecf8 | 300 | 'tax_message' => $taxAmount ? ts("Includes %1 amount of %2", array(1 => CRM_Utils_Array::value('tax_term', $invoiceSettings), 2 => CRM_Utils_Money::format($taxAmount))) : $taxAmount, |
6a488035 TO |
301 | ); |
302 | ||
a7488080 | 303 | if (!empty($values['auto_renew'])) { |
6a488035 | 304 | $allMembershipInfo[$key]['auto_renew'] = $options[$values['auto_renew']]; |
b09fe5ed | 305 | } |
6a488035 TO |
306 | } |
307 | } | |
6a488035 TO |
308 | |
309 | $this->assign('allMembershipInfo', json_encode($allMembershipInfo)); | |
310 | ||
311 | if ($this->_memType) { | |
ab30e033 EM |
312 | $this->assign('orgName', $selMemTypeOrg[$this->allMembershipTypeDetails[$this->_memType]['member_of_contact_id']]); |
313 | $this->assign('memType', $this->allMembershipTypeDetails[$this->_memType]['name']); | |
6a488035 TO |
314 | } |
315 | ||
316 | // force select of organization by default, if only one organization in | |
317 | // the list | |
318 | if (count($selMemTypeOrg) == 2) { | |
319 | unset($selMemTypeOrg[0], $selOrgMemType[0][0]); | |
320 | } | |
321 | //sort membership organization and type, CRM-6099 | |
322 | natcasesort($selMemTypeOrg); | |
323 | foreach ($selOrgMemType as $index => $orgMembershipType) { | |
324 | natcasesort($orgMembershipType); | |
325 | $selOrgMemType[$index] = $orgMembershipType; | |
326 | } | |
327 | ||
ab30e033 | 328 | $js = array('onChange' => "setPaymentBlock(); CRM.buildCustomData('Membership', this.value);"); |
6a488035 TO |
329 | $sel = &$this->addElement('hierselect', |
330 | 'membership_type_id', | |
331 | ts('Renewal Membership Organization and Type'), $js | |
332 | ); | |
333 | ||
334 | $sel->setOptions(array($selMemTypeOrg, $selOrgMemType)); | |
335 | $elements = array(); | |
336 | if ($sel) { | |
337 | $elements[] = $sel; | |
338 | } | |
339 | ||
340 | $this->applyFilter('__ALL__', 'trim'); | |
bb7def85 A |
341 | |
342 | // CRM-20571 | |
343 | // Get the Join Date from Membership info as it is not available in the Renew form | |
344 | $joinDate = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_Membership', $this->_id, 'join_date'); | |
345 | // Save its value in a hidden field | |
346 | $this->addElement('hidden', 'join_date', $joinDate); | |
6a488035 TO |
347 | |
348 | $this->addDate('renewal_date', ts('Date Renewal Entered'), FALSE, array('formatType' => 'activityDate')); | |
349 | ||
03e04002 | 350 | $this->add('select', 'financial_type_id', ts('Financial Type'), |
6a488035 TO |
351 | array('' => ts('- select -')) + CRM_Contribute_PseudoConstant::financialType() |
352 | ); | |
3d7b228b J |
353 | |
354 | $this->add('text', 'num_terms', ts('Extend Membership by'), array('onchange' => "setPaymentBlock();"), TRUE); | |
355 | $this->addRule('num_terms', ts('Please enter a whole number for how many periods to renew.'), 'integer'); | |
356 | ||
6a488035 TO |
357 | if (CRM_Core_Permission::access('CiviContribute') && !$this->_mode) { |
358 | $this->addElement('checkbox', 'record_contribution', ts('Record Renewal Payment?'), NULL, array('onclick' => "checkPayment();")); | |
359 | ||
360 | $this->add('text', 'total_amount', ts('Amount')); | |
361 | $this->addRule('total_amount', ts('Please enter a valid amount.'), 'money'); | |
362 | ||
5d86176b | 363 | $this->addDate('receive_date', ts('Received'), FALSE, array('formatType' => 'activityDateTime')); |
6a488035 | 364 | |
4db803dd | 365 | $this->add('select', 'payment_instrument_id', ts('Payment Method'), |
6a488035 TO |
366 | array('' => ts('- select -')) + CRM_Contribute_PseudoConstant::paymentInstrument(), |
367 | FALSE, array('onChange' => "return showHideByValue('payment_instrument_id','4','checkNumber','table-row','select',false);") | |
368 | ); | |
369 | ||
370 | $this->add('text', 'trxn_id', ts('Transaction ID')); | |
371 | $this->addRule('trxn_id', ts('Transaction ID already exists in Database.'), | |
372 | 'objectExists', array('CRM_Contribute_DAO_Contribution', $this->_id, 'trxn_id') | |
373 | ); | |
374 | ||
375 | $this->add('select', 'contribution_status_id', ts('Payment Status'), | |
376 | CRM_Contribute_PseudoConstant::contributionStatus() | |
377 | ); | |
378 | ||
379 | $this->add('text', 'check_number', ts('Check Number'), | |
380 | CRM_Core_DAO::getAttribute('CRM_Contribute_DAO_Contribution', 'check_number') | |
381 | ); | |
382 | } | |
383 | else { | |
384 | $this->add('text', 'total_amount', ts('Amount')); | |
385 | $this->addRule('total_amount', ts('Please enter a valid amount.'), 'money'); | |
386 | } | |
387 | $this->addElement('checkbox', 'send_receipt', ts('Send Confirmation and Receipt?'), NULL, | |
388 | array('onclick' => "showHideByValue( 'send_receipt', '', 'notice', 'table-row', 'radio', false ); showHideByValue( 'send_receipt', '', 'fromEmail', 'table-row', 'radio',false);") | |
389 | ); | |
390 | ||
391 | $this->add('select', 'from_email_address', ts('Receipt From'), $this->_fromEmails); | |
392 | ||
393 | $this->add('textarea', 'receipt_text_renewal', ts('Renewal Message')); | |
394 | ||
6a488035 TO |
395 | // Retrieve the name and email of the contact - this will be the TO for receipt email |
396 | list($this->_contributorDisplayName, | |
397 | $this->_contributorEmail | |
353ffa53 | 398 | ) = CRM_Contact_BAO_Contact_Location::getEmailDetails($this->_contactID); |
6a488035 | 399 | $this->assign('email', $this->_contributorEmail); |
186a737c EM |
400 | // The member form uses emailExists. Assigning both while we transition / synchronise. |
401 | $this->assign('emailExists', $this->_contributorEmail); | |
6a488035 | 402 | |
aaffa79f | 403 | $mailingInfo = Civi::settings()->get('mailing_backend'); |
6a488035 TO |
404 | $this->assign('outBound_option', $mailingInfo['outBound_option']); |
405 | ||
406 | if (CRM_Core_DAO::getFieldValue('CRM_Member_DAO_Membership', $this->_id, 'contribution_recur_id')) { | |
407 | if (CRM_Member_BAO_Membership::isCancelSubscriptionSupported($this->_id)) { | |
408 | $this->assign('cancelAutoRenew', | |
409 | CRM_Utils_System::url('civicrm/contribute/unsubscribe', "reset=1&mid={$this->_id}") | |
410 | ); | |
411 | } | |
412 | } | |
413 | $this->addFormRule(array('CRM_Member_Form_MembershipRenewal', 'formRule')); | |
389eb82a | 414 | $this->addElement('checkbox', 'is_different_contribution_contact', ts('Record Payment from a Different Contact?')); |
186a737c EM |
415 | $this->addSelect('soft_credit_type_id', array('entity' => 'contribution_soft')); |
416 | $this->addEntityRef('soft_credit_contact_id', ts('Payment From'), array('create' => TRUE)); | |
b09fe5ed | 417 | } |
6a488035 TO |
418 | |
419 | /** | |
fe482240 | 420 | * Validation. |
6a488035 | 421 | * |
b2363ea8 TO |
422 | * @param array $params |
423 | * (ref.) an assoc array of name/value pairs. | |
6a488035 | 424 | * |
72b3a70c CW |
425 | * @return bool|array |
426 | * mixed true or array of errors | |
6a488035 | 427 | */ |
00be9182 | 428 | public static function formRule($params) { |
6a488035 TO |
429 | $errors = array(); |
430 | if ($params['membership_type_id'][0] == 0) { | |
431 | $errors['membership_type_id'] = ts('Oops. It looks like you are trying to change the membership type while renewing the membership. Please click the "change membership type" link, and select a Membership Organization.'); | |
432 | } | |
433 | if ($params['membership_type_id'][1] == 0) { | |
434 | $errors['membership_type_id'] = ts('Oops. It looks like you are trying to change the membership type while renewing the membership. Please click the "change membership type" link and select a Membership Type from the list.'); | |
435 | } | |
436 | ||
bb7def85 A |
437 | // CRM-20571: Check if the renewal date is not before Join Date, if it is then add to 'errors' array |
438 | // The fields in Renewal form come into this routine in $params array. 'renewal_date' is already in the form and | |
439 | // we added 'join_date' as a hidden field in the buildForm routine with member join date value | |
440 | // We process both the dates before comparison using CRM utils so that they are in same date format | |
441 | if (isset($params['renewal_date'])) { | |
442 | if (CRM_Utils_Date::processDate($params['renewal_date']) < CRM_Utils_Date::processDate($params['join_date'])) { | |
443 | $errors['renewal_date'] = ts('Renewal date must be the same or later than Member since (Join Date).'); | |
444 | } | |
445 | } | |
446 | ||
6a488035 TO |
447 | //total amount condition arise when membership type having no |
448 | //minimum fee | |
449 | if (isset($params['record_contribution'])) { | |
450 | if (!$params['financial_type_id']) { | |
451 | $errors['financial_type_id'] = ts('Please select a Financial Type.'); | |
452 | } | |
453 | if (!$params['total_amount']) { | |
454 | $errors['total_amount'] = ts('Please enter a Contribution Amount.'); | |
455 | } | |
a7488080 | 456 | if (empty($params['payment_instrument_id'])) { |
4db803dd | 457 | $errors['payment_instrument_id'] = ts('Payment Method is a required field.'); |
d96cf288 | 458 | } |
6a488035 TO |
459 | } |
460 | return empty($errors) ? TRUE : $errors; | |
461 | } | |
462 | ||
463 | /** | |
fe482240 | 464 | * Process the renewal form. |
6a488035 TO |
465 | */ |
466 | public function postProcess() { | |
6a488035 | 467 | // get the submitted form values. |
b37f1131 | 468 | $this->_params = $this->controller->exportValues($this->_name); |
1a00ea3c | 469 | $this->assignBillingName(); |
6a488035 | 470 | |
1a00ea3c | 471 | try { |
af990df6 EM |
472 | $this->submit(); |
473 | $statusMsg = ts('%1 membership for %2 has been renewed.', array(1 => $this->membershipTypeName, 2 => $this->_memberDisplayName)); | |
474 | ||
475 | if ($this->endDate) { | |
1c34cb9b | 476 | $statusMsg .= ' ' . ts('The new membership End Date is %1.', array( |
c5c263ca | 477 | 1 => CRM_Utils_Date::customFormat(substr($this->endDate, 0, 8)), |
1c34cb9b | 478 | )); |
af990df6 EM |
479 | } |
480 | ||
481 | if ($this->isMailSent) { | |
1c34cb9b | 482 | $statusMsg .= ' ' . ts('A renewal confirmation and receipt has been sent to %1.', array( |
c5c263ca | 483 | 1 => $this->_contributorEmail, |
1c34cb9b | 484 | )); |
af990df6 EM |
485 | return $statusMsg; |
486 | } | |
487 | return $statusMsg; | |
1a00ea3c EM |
488 | } |
489 | catch (\Civi\Payment\Exception\PaymentProcessorException $e) { | |
490 | CRM_Core_Error::displaySessionError($e->getMessage()); | |
491 | CRM_Utils_System::redirect(CRM_Utils_System::url('civicrm/contact/view/membership', | |
492 | "reset=1&action=renew&cid={$this->_contactID}&id={$this->_id}&context=membership&mode={$this->_mode}" | |
493 | )); | |
494 | } | |
4187b12f EM |
495 | |
496 | CRM_Core_Session::setStatus($statusMsg, ts('Complete'), 'success'); | |
497 | } | |
498 | ||
4187b12f EM |
499 | /** |
500 | * Process form submission. | |
501 | * | |
502 | * This function is also accessed by a unit test. | |
4187b12f | 503 | */ |
b37f1131 EM |
504 | protected function submit() { |
505 | $this->storeContactFields($this->_params); | |
ba2f3f65 | 506 | $this->beginPostProcess(); |
481a74f4 | 507 | $now = CRM_Utils_Date::getToday(NULL, 'YmdHis'); |
b37f1131 EM |
508 | $this->convertDateFieldsToMySQL($this->_params); |
509 | $this->assign('receive_date', $this->_params['receive_date']); | |
09108d7d | 510 | $this->processBillingAddress(); |
af990df6 | 511 | list($userName) = CRM_Contact_BAO_Contact_Location::getEmailDetails(CRM_Core_Session::singleton()->get('userID')); |
0816949d EM |
512 | $this->_params['total_amount'] = CRM_Utils_Array::value('total_amount', $this->_params, |
513 | CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipType', $this->_memType, 'minimum_fee') | |
514 | ); | |
515 | $this->_membershipId = $this->_id; | |
516 | $customFieldsFormatted = CRM_Core_BAO_CustomField::postProcess($this->_params, | |
517 | $this->_id, | |
518 | 'Membership' | |
519 | ); | |
520 | if (empty($this->_params['financial_type_id'])) { | |
521 | $this->_params['financial_type_id'] = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipType', $this->_memType, 'financial_type_id'); | |
522 | } | |
14065266 | 523 | $contributionRecurID = NULL; |
0816949d EM |
524 | $this->assign('membershipID', $this->_id); |
525 | $this->assign('contactID', $this->_contactID); | |
526 | $this->assign('module', 'Membership'); | |
527 | $this->assign('receiptType', 'membership renewal'); | |
528 | $this->_params['currencyID'] = CRM_Core_Config::singleton()->defaultCurrency; | |
529 | $this->_params['invoice_id'] = $this->_params['invoiceID'] = md5(uniqid(rand(), TRUE)); | |
6a488035 | 530 | |
a7488080 | 531 | if (!empty($this->_params['send_receipt'])) { |
b37f1131 EM |
532 | $this->_params['receipt_date'] = $now; |
533 | $this->assign('receipt_date', CRM_Utils_Date::mysqlToIso($this->_params['receipt_date'])); | |
6a488035 TO |
534 | } |
535 | else { | |
b37f1131 | 536 | $this->_params['receipt_date'] = NULL; |
6a488035 TO |
537 | } |
538 | ||
539 | if ($this->_mode) { | |
b37f1131 | 540 | $this->_params['register_date'] = $now; |
e47238e5 | 541 | $this->_params['description'] = ts("Contribution submitted by a staff person using member's credit card for renewal"); |
b37f1131 | 542 | $this->_params['amount'] = $this->_params['total_amount']; |
b1b2796c | 543 | $this->_params['payment_instrument_id'] = $this->_paymentProcessor['payment_instrument_id']; |
6a488035 TO |
544 | |
545 | // at this point we've created a contact and stored its address etc | |
546 | // all the payment processors expect the name and address to be in the passed params | |
547 | // so we copy stuff over to first_name etc. | |
548 | $paymentParams = $this->_params; | |
a7488080 | 549 | if (!empty($this->_params['send_receipt'])) { |
6a488035 TO |
550 | $paymentParams['email'] = $this->_contributorEmail; |
551 | } | |
b1b2796c | 552 | $paymentParams['is_email_receipt'] = !empty($this->_params['send_receipt']); |
6a488035 TO |
553 | |
554 | $paymentParams['contactID'] = $this->_contributorContactID; | |
6a488035 TO |
555 | |
556 | CRM_Core_Payment_Form::mapParams($this->_bltID, $this->_params, $paymentParams, TRUE); | |
557 | ||
0816949d | 558 | $payment = $this->_paymentProcessor['object']; |
6a488035 | 559 | |
b37f1131 | 560 | if (!empty($this->_params['auto_renew'])) { |
a70418a7 | 561 | $contributionRecurParams = $this->processRecurringContribution($paymentParams); |
14065266 | 562 | $contributionRecurID = $contributionRecurParams['contributionRecurID']; |
a70418a7 EM |
563 | $paymentParams = array_merge($paymentParams, $contributionRecurParams); |
564 | } | |
0816949d | 565 | |
1a00ea3c | 566 | $result = $payment->doPayment($paymentParams); |
0816949d | 567 | $this->_params = array_merge($this->_params, $result); |
6a488035 | 568 | |
0816949d | 569 | $this->_params['contribution_status_id'] = $result['payment_status_id']; |
b37f1131 | 570 | $this->_params['trxn_id'] = $result['trxn_id']; |
b37f1131 | 571 | $this->_params['is_test'] = ($this->_mode == 'live') ? 0 : 1; |
6a488035 TO |
572 | $this->set('params', $this->_params); |
573 | $this->assign('trxn_id', $result['trxn_id']); | |
574 | } | |
575 | ||
b37f1131 | 576 | $renewalDate = !empty($this->_params['renewal_date']) ? $renewalDate = CRM_Utils_Date::processDate($this->_params['renewal_date']) : NULL; |
4187b12f | 577 | |
6a488035 TO |
578 | // check for test membership. |
579 | $isTestMembership = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_Membership', $this->_membershipId, 'is_test'); | |
580 | ||
581 | // chk for renewal for multiple terms CRM-8750 | |
582 | $numRenewTerms = 1; | |
b37f1131 EM |
583 | if (is_numeric(CRM_Utils_Array::value('num_terms', $this->_params))) { |
584 | $numRenewTerms = $this->_params['num_terms']; | |
6a488035 TO |
585 | } |
586 | ||
587 | //if contribution status is pending then set pay later | |
0816949d | 588 | $this->_params['is_pay_later'] = FALSE; |
b37f1131 | 589 | if ($this->_params['contribution_status_id'] == array_search('Pending', CRM_Contribute_PseudoConstant::contributionStatus())) { |
6a488035 TO |
590 | $this->_params['is_pay_later'] = 1; |
591 | } | |
8bc79dfc | 592 | |
d87103d2 EM |
593 | // These variable sets prior to renewMembership may not be required for this form. They were in |
594 | // a function this form shared with other forms. | |
61767a1d | 595 | $membershipSource = NULL; |
d87103d2 EM |
596 | if (!empty($this->_params['membership_source'])) { |
597 | $membershipSource = $this->_params['membership_source']; | |
61767a1d | 598 | } |
0816949d | 599 | |
ae30430b | 600 | $isPending = ($this->_params['contribution_status_id'] == 2) ? TRUE : FALSE; |
d87103d2 | 601 | |
356bfcaf | 602 | list($renewMembership) = CRM_Member_BAO_Membership::processMembership( |
b37f1131 | 603 | $this->_contactID, $this->_params['membership_type_id'][1], $isTestMembership, |
dfc9c0c7 | 604 | $renewalDate, NULL, $customFieldsFormatted, $numRenewTerms, $this->_membershipId, |
0816949d EM |
605 | $isPending, |
606 | $contributionRecurID, $membershipSource, $this->_params['is_pay_later'], CRM_Utils_Array::value('campaign_id', | |
607 | $this->_params) | |
6a488035 TO |
608 | ); |
609 | ||
af990df6 | 610 | $this->endDate = CRM_Utils_Date::processDate($renewMembership->end_date); |
6a488035 | 611 | |
af990df6 EM |
612 | $this->membershipTypeName = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipType', $renewMembership->membership_type_id, |
613 | 'name'); | |
6a488035 | 614 | |
b37f1131 | 615 | if (!empty($this->_params['record_contribution']) || $this->_mode) { |
6a488035 | 616 | // set the source |
af990df6 | 617 | $this->_params['contribution_source'] = "{$this->membershipTypeName} Membership: Offline membership renewal (by {$userName})"; |
03e04002 | 618 | |
6a488035 TO |
619 | //create line items |
620 | $lineItem = array(); | |
ccb02c2d | 621 | $this->_params = $this->setPriceSetParameters($this->_params); |
9da8dc8c | 622 | CRM_Price_BAO_PriceSet::processAmount($this->_priceSet['fields'], |
1a1a2f4f | 623 | $this->_params, $lineItem[$this->_priceSetId], NULL, $this->_priceSetId |
6a488035 | 624 | ); |
03e04002 | 625 | //CRM-11529 for quick config backoffice transactions |
626 | //when financial_type_id is passed in form, update the | |
1f676e92 | 627 | //line items with the financial type selected in form |
b37f1131 | 628 | if ($submittedFinancialType = CRM_Utils_Array::value('financial_type_id', $this->_params)) { |
ccb02c2d | 629 | foreach ($lineItem[$this->_priceSetId] as &$li) { |
6a488035 TO |
630 | $li['financial_type_id'] = $submittedFinancialType; |
631 | } | |
632 | } | |
b3f6108a | 633 | |
6a488035 | 634 | if (!empty($lineItem)) { |
b37f1131 EM |
635 | $this->_params['lineItems'] = $lineItem; |
636 | $this->_params['processPriceSet'] = TRUE; | |
6a488035 TO |
637 | } |
638 | ||
639 | //assign contribution contact id to the field expected by recordMembershipContribution | |
9b873358 | 640 | if ($this->_contributorContactID != $this->_contactID) { |
b37f1131 | 641 | $this->_params['contribution_contact_id'] = $this->_contributorContactID; |
9b873358 | 642 | if (!empty($this->_params['soft_credit_type_id'])) { |
b37f1131 | 643 | $this->_params['soft_credit'] = array( |
133e2c99 | 644 | 'soft_credit_type_id' => $this->_params['soft_credit_type_id'], |
91ef9be0 | 645 | 'contact_id' => $this->_contactID, |
133e2c99 | 646 | ); |
6a488035 TO |
647 | } |
648 | } | |
b37f1131 | 649 | $this->_params['contact_id'] = $this->_contactID; |
1acc24d5 EM |
650 | //recordMembershipContribution receives params as a reference & adds one variable. This is |
651 | // not a great pattern & ideally it would not receive as a reference. We assign our params as a | |
652 | // temporary variable to avoid e-notice & to make it clear to future refactorer that | |
653 | // this function is NOT reliant on that var being set | |
e136edcf | 654 | $temporaryParams = array_merge($this->_params, array( |
655 | 'membership_id' => $renewMembership->id, | |
656 | 'contribution_recur_id' => $contributionRecurID, | |
657 | )); | |
85ade0ae | 658 | //Remove `tax_amount` if it is not calculated. |
659 | if (CRM_Utils_Array::value('tax_amount', $temporaryParams) === 0) { | |
660 | unset($temporaryParams['tax_amount']); | |
661 | } | |
1acc24d5 | 662 | CRM_Member_BAO_Membership::recordMembershipContribution($temporaryParams); |
6a488035 TO |
663 | } |
664 | ||
b37f1131 | 665 | if (!empty($this->_params['send_receipt'])) { |
6a488035 | 666 | |
b37f1131 | 667 | $receiptFrom = $this->_params['from_email_address']; |
6a488035 | 668 | |
b37f1131 | 669 | if (!empty($this->_params['payment_instrument_id'])) { |
6a488035 | 670 | $paymentInstrument = CRM_Contribute_PseudoConstant::paymentInstrument(); |
b37f1131 | 671 | $this->_params['paidBy'] = $paymentInstrument[$this->_params['payment_instrument_id']]; |
6a488035 TO |
672 | } |
673 | //get the group Tree | |
0b330e6d | 674 | $this->_groupTree = CRM_Core_BAO_CustomGroup::getTree('Membership', NULL, $this->_id, FALSE, $this->_memType); |
6a488035 TO |
675 | |
676 | // retrieve custom data | |
677 | $customFields = $customValues = $fo = array(); | |
678 | foreach ($this->_groupTree as $groupID => $group) { | |
679 | if ($groupID == 'info') { | |
680 | continue; | |
681 | } | |
682 | foreach ($group['fields'] as $k => $field) { | |
683 | $field['title'] = $field['label']; | |
684 | $customFields["custom_{$k}"] = $field; | |
685 | } | |
686 | } | |
687 | $members = array(array('member_id', '=', $this->_membershipId, 0, 0)); | |
688 | // check whether its a test drive | |
689 | if ($this->_mode == 'test') { | |
690 | $members[] = array('member_test', '=', 1, 0, 0); | |
691 | } | |
692 | CRM_Core_BAO_UFGroup::getValues($this->_contactID, $customFields, $customValues, FALSE, $members); | |
693 | ||
b37f1131 EM |
694 | $this->assign_by_ref('formValues', $this->_params); |
695 | if (!empty($this->_params['contribution_id'])) { | |
696 | $this->assign('contributionID', $this->_params['contribution_id']); | |
6a488035 | 697 | } |
0816949d | 698 | |
6a488035 | 699 | $this->assign('membership_name', CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipType', |
353ffa53 TO |
700 | $renewMembership->membership_type_id |
701 | )); | |
6a488035 | 702 | $this->assign('customValues', $customValues); |
0816949d EM |
703 | $this->assign('mem_start_date', CRM_Utils_Date::customFormat($renewMembership->start_date)); |
704 | $this->assign('mem_end_date', CRM_Utils_Date::customFormat($renewMembership->end_date)); | |
6a488035 | 705 | if ($this->_mode) { |
0b50eca0 | 706 | $this->assign('address', CRM_Utils_Address::getFormattedBillingAddressFieldsFromParameters( |
707 | $this->_params, | |
708 | $this->_bltID | |
709 | )); | |
6a488035 TO |
710 | $this->assign('contributeMode', 'direct'); |
711 | $this->assign('isAmountzero', 0); | |
712 | $this->assign('is_pay_later', 0); | |
713 | $this->assign('isPrimary', 1); | |
ed00719b | 714 | $this->assign('receipt_text_renewal', $this->_params['receipt_text']); |
6a488035 TO |
715 | if ($this->_mode == 'test') { |
716 | $this->assign('action', '1024'); | |
717 | } | |
718 | } | |
719 | ||
af990df6 | 720 | list($this->isMailSent) = CRM_Core_BAO_MessageTemplate::sendTemplate( |
6a488035 TO |
721 | array( |
722 | 'groupName' => 'msg_tpl_workflow_membership', | |
723 | 'valueName' => 'membership_offline_receipt', | |
724 | 'contactId' => $this->_receiptContactId, | |
725 | 'from' => $receiptFrom, | |
726 | 'toName' => $this->_contributorDisplayName, | |
727 | 'toEmail' => $this->_contributorEmail, | |
728 | 'isTest' => $this->_mode == 'test', | |
729 | ) | |
730 | ); | |
731 | } | |
6a488035 | 732 | } |
96025800 | 733 | |
6a488035 | 734 | } |