3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.4 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2013 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2013
37 * This class generates form components for Membership Renewal
40 class CRM_Member_Form_MembershipRenewal
extends CRM_Member_Form
{
42 * Display name of the member
44 protected $_memberDisplayName = null;
46 * email of the person paying for the membership (used for receipts)
48 protected $_memberEmail = null;
50 * Contact ID of the member
52 protected $_contactID = null;
54 * Display name of the person paying for the membership (used for receipts)
56 protected $_contributorDisplayName = null;
58 * email of the person paying for the membership (used for receipts)
60 protected $_contributorEmail = null;
62 * email of the person paying for the membership (used for receipts)
64 protected $_contributorContactID = null;
66 * ID of the person the receipt is to go to
68 protected $_receiptContactId = null;
70 * context would be set to standalone if the contact is use is being selected from
71 * the form rather than in the URL
76 * An array to hold a list of datefields on the form
77 * so that they can be converted to ISO in a consistent manner
81 protected $_dateFields = array(
82 'receive_date' => array('default' => 'now'),
85 public function preProcess() {
86 //custom data related code
87 $this->_cdType
= CRM_Utils_Array
::value('type', $_GET);
88 $this->assign('cdType', FALSE);
90 $this->assign('cdType', TRUE);
91 return CRM_Custom_Form_CustomData
::preProcess($this);
94 // check for edit permission
95 if (!CRM_Core_Permission
::check('edit memberships')) {
96 CRM_Core_Error
::fatal(ts('You do not have permission to access this page'));
99 $this->_action
= CRM_Utils_Request
::retrieve('action', 'String',
102 $this->_context
= CRM_Utils_Request
::retrieve('context', 'String',
103 $this, FALSE, 'membership'
105 $this->_id
= CRM_Utils_Request
::retrieve('id', 'Positive',
108 $this->_contactID
= CRM_Utils_Request
::retrieve('cid', 'Positive',
112 $this->_memType
= CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership', $this->_id
, 'membership_type_id');
115 $this->assign('endDate', CRM_Utils_Date
::customFormat(CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership',
116 $this->_id
, 'end_date'
119 $this->assign('membershipStatus',
120 CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipStatus',
121 CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership',
122 $this->_id
, 'status_id'
128 //using credit card :: CRM-2759
129 $this->_mode
= CRM_Utils_Request
::retrieve('mode', 'String', $this);
131 $membershipFee = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType', $this->_memType
, 'minimum_fee');
132 if (!$membershipFee) {
133 $statusMsg = ts('Membership Renewal using a credit card requires a Membership fee. Since there is no fee associated with the selected memebership type, you can use the normal renewal mode.');
134 CRM_Core_Session
::setStatus($statusMsg, '', 'info');
135 CRM_Utils_System
::redirect(CRM_Utils_System
::url('civicrm/contact/view/membership',
136 "reset=1&action=renew&cid={$this->_contactID}&id={$this->_id}&context=membership"
139 $this->assign('membershipMode', $this->_mode
);
141 $this->_paymentProcessor
= array('billing_mode' => 1);
142 $validProcessors = array();
143 $processors = CRM_Core_PseudoConstant
::paymentProcessor(FALSE, FALSE, 'billing_mode IN ( 1, 3 )');
145 foreach ($processors as $ppID => $label) {
146 $paymentProcessor = CRM_Financial_BAO_PaymentProcessor
::getPayment($ppID, $this->_mode
);
147 if ($paymentProcessor['payment_processor_type'] == 'PayPal' && !$paymentProcessor['user_name']) {
150 elseif ($paymentProcessor['payment_processor_type'] == 'Dummy' && $this->_mode
== 'live') {
154 $paymentObject = CRM_Core_Payment
::singleton($this->_mode
, $paymentProcessor, $this);
155 $error = $paymentObject->checkConfig();
157 $validProcessors[$ppID] = $label;
159 $paymentObject = NULL;
162 if (empty($validProcessors)) {
163 CRM_Core_Error
::fatal(ts('Could not find valid payment processor for this page'));
166 $this->_processors
= $validProcessors;
168 // also check for billing information
169 // get the billing location type
170 $locationTypes = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Address', 'location_type_id', array(), 'validate');
171 // CRM-8108 remove ts around Billing location type
172 //$this->_bltID = array_search( ts('Billing'), $locationTypes );
173 $this->_bltID
= array_search('Billing', $locationTypes);
174 if (!$this->_bltID
) {
175 CRM_Core_Error
::fatal(ts('Please set a location type of %1', array(1 => 'Billing')));
177 $this->set('bltID', $this->_bltID
);
178 $this->assign('bltID', $this->_bltID
);
180 $this->_fields
= array();
182 CRM_Core_Payment_Form
::setCreditCardFields($this);
184 // this required to show billing block
185 $this->assign_by_ref('paymentProcessor', $paymentProcessor);
186 $this->assign('hidePayPalExpress', TRUE);
189 $this->assign('membershipMode', FALSE);
192 // when custom data is included in this page
193 if (CRM_Utils_Array
::value('hidden_custom', $_POST)) {
194 CRM_Custom_Form_CustomData
::preProcess($this);
195 CRM_Custom_Form_CustomData
::buildQuickForm($this);
196 CRM_Custom_Form_CustomData
::setDefaultValues($this);
199 $this->_fromEmails
= CRM_Core_BAO_Email
::getFromEmail();
200 parent
::preProcess();
204 * This function sets the default values for the form.
205 * the default values are retrieved from the database
211 public function setDefaultValues() {
212 if ($this->_cdType
) {
213 return CRM_Custom_Form_CustomData
::setDefaultValues($this);
216 $defaults = parent
::setDefaultValues();
217 $this->_memType
= $defaults['membership_type_id'];
219 // set renewal_date and receive_date to today in correct input format (setDateDefaults uses today if no value passed)
220 list($now, $currentTime) = CRM_Utils_Date
::setDateDefaults();
221 $defaults['renewal_date'] = $now;
222 $defaults['receive_date'] = $now;
223 $defaults['receive_date_time'] = $currentTime;
225 if ($defaults['id']) {
226 $defaults['record_contribution'] = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipPayment',
233 if (is_numeric($this->_memType
)) {
234 $defaults['membership_type_id'] = array();
235 $defaults['membership_type_id'][0] = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType',
237 'member_of_contact_id',
240 $defaults['membership_type_id'][1] = $this->_memType
;
243 $defaults['membership_type_id'] = $this->_memType
;
246 $defaults['financial_type_id'] = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType', $this->_memType
, 'financial_type_id');
249 if (!CRM_Utils_Array
::value('payment_instrument_id', $defaults)) {
250 $defaults['payment_instrument_id'] = key(CRM_Core_OptionGroup
::values('payment_instrument', FALSE, FALSE, FALSE, 'AND is_default = 1'));
253 $defaults['total_amount'] = CRM_Utils_Money
::format(CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType',
259 $defaults['record_contribution'] = 0;
260 $defaults['num_terms'] = 1;
261 $defaults['send_receipt'] = 0;
263 $renewalDate = CRM_Utils_Date
::processDate(CRM_Utils_Array
::value('renewal_date', $defaults),
266 $this->assign('renewalDate', $renewalDate);
267 $this->assign('member_is_test', CRM_Utils_Array
::value('member_is_test', $defaults));
272 foreach ($this->_fields
as $name => $dontCare) {
277 'first_name', 'middle_name', 'last_name', "street_address-{$this->_bltID}",
278 "city-{$this->_bltID}", "postal_code-{$this->_bltID}", "country_id-{$this->_bltID}",
279 "state_province_id-{$this->_bltID}",
281 foreach ($names as $name) {
285 $fields["state_province-{$this->_bltID}"] = 1;
286 $fields["country-{$this->_bltID}"] = 1;
287 $fields["email-{$this->_bltID}"] = 1;
288 $fields['email-Primary'] = 1;
290 CRM_Core_BAO_UFGroup
::setProfileDefaults($this->_contactID
, $fields, $this->_defaults
);
292 // use primary email address if billing email address is empty
293 if (empty($this->_defaults
["email-{$this->_bltID}"]) &&
294 !empty($this->_defaults
['email-Primary'])
296 $defaults["email-{$this->_bltID}"] = $this->_defaults
['email-Primary'];
299 foreach ($names as $name) {
300 if (!empty($this->_defaults
[$name])) {
301 $defaults['billing_' . $name] = $this->_defaults
[$name];
310 * Function to build the form
315 public function buildQuickForm() {
316 if ($this->_cdType
) {
317 return CRM_Custom_Form_CustomData
::buildQuickForm($this);
320 parent
::buildQuickForm();
323 $defaults = parent
::setDefaultValues();
324 $this->_memType
= $defaults['membership_type_id'];
325 $this->assign('customDataType', 'Membership');
326 $this->assign('customDataSubType', $this->_memType
);
327 $this->assign('entityID', $this->_id
);
328 $selOrgMemType[0][0] = $selMemTypeOrg[0] = ts('- select -');
330 $allMemberships = CRM_Member_BAO_Membership
::buildMembershipTypeValues($this);
332 $allMembershipInfo = $membershipType = array();
334 // auto renew options if enabled for the membership
335 $options = array(ts('No auto-renew option'), ts('Give option, but not required'), ts('Auto-renew required '));
337 foreach( $allMemberships as $key => $values ) {
338 if (CRM_Utils_Array
::value('is_active', $values) ) {
339 $membershipType[$key] = CRM_Utils_Array
::value('name', $values);
340 if ($this->_mode
&& !CRM_Utils_Array
::value('minimum_fee', $values)) {
344 $memberOfContactId = CRM_Utils_Array
::value('member_of_contact_id', $values);
345 if (!CRM_Utils_Array
::value($memberOfContactId, $selMemTypeOrg)) {
346 $selMemTypeOrg[$memberOfContactId] = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact',
352 $selOrgMemType[$memberOfContactId][0] = ts('- select -');
354 if (!CRM_Utils_Array
::value($key, $selOrgMemType[$memberOfContactId])) {
355 $selOrgMemType[$memberOfContactId][$key] = CRM_Utils_Array
::value('name', $values);
359 // build membership info array, which is used to set the payment information block when
360 // membership type is selected.
361 $allMembershipInfo[$key] = array(
362 'financial_type_id' => CRM_Utils_Array
::value('financial_type_id', $values),
363 'total_amount' => CRM_Utils_Money
::format($values['minimum_fee'], NULL, '%a'),
364 'total_amount_numeric' => CRM_Utils_Array
::value('minimum_fee', $values)
367 if (CRM_Utils_Array
::value('auto_renew', $values)) {
368 $allMembershipInfo[$key]['auto_renew'] = $options[$values['auto_renew']];
373 $this->assign('allMembershipInfo', json_encode($allMembershipInfo));
375 if ($this->_memType
) {
376 $this->assign('orgName', $selMemTypeOrg[$allMemberships[$this->_memType
]['member_of_contact_id']]);
377 $this->assign('memType', $allMemberships[$this->_memType
]['name']);
380 // force select of organization by default, if only one organization in
382 if (count($selMemTypeOrg) == 2) {
383 unset($selMemTypeOrg[0], $selOrgMemType[0][0]);
385 //sort membership organization and type, CRM-6099
386 natcasesort($selMemTypeOrg);
387 foreach ($selOrgMemType as $index => $orgMembershipType) {
388 natcasesort($orgMembershipType);
389 $selOrgMemType[$index] = $orgMembershipType;
392 $js = array('onChange' => "setPaymentBlock( ); CRM.buildCustomData( 'Membership', this.value );");
394 //build the form for auto renew.
395 $recurProcessor = array();
396 if ($this->_mode ||
($this->_action
& CRM_Core_Action
::UPDATE
)) {
397 //get the valid recurring processors.
398 $recurring = CRM_Core_PseudoConstant
::paymentProcessor(FALSE, FALSE, 'is_recur = 1');
399 $recurProcessor = array_intersect_assoc($this->_processors
, $recurring);
400 if (!empty($recurProcessor)) {
401 $autoRenew = array();
402 if (!empty($membershipType)) {
408 FROM civicrm_membership_type
409 WHERE id IN ( ' . implode(' , ', array_keys($membershipType)) . ' )';
410 $recurMembershipTypes = CRM_Core_DAO
::executeQuery($sql);
411 while ($recurMembershipTypes->fetch()) {
412 $autoRenew[$recurMembershipTypes->id
] = $recurMembershipTypes->auto_renew
;
414 'id', 'auto_renew', 'duration_unit', 'duration_interval') as $fld) {
415 $this->_recurMembershipTypes
[$recurMembershipTypes->id
][$fld] = $recurMembershipTypes->$fld;
419 $js = array('onChange' => "setPaymentBlock(); CRM.buildCustomData( 'Membership', this.value );");
420 $this->assign('autoRenew', json_encode($autoRenew));
422 $autoRenewElement = $this->addElement('checkbox', 'auto_renew', ts('Membership renewed automatically'),
423 NULL, array('onclick' => "showHideByValue('auto_renew','','send-receipt','table-row','radio',true); showHideNotice( );")
425 if ($this->_action
& CRM_Core_Action
::UPDATE
) {
426 $autoRenewElement->freeze();
429 $this->assign('recurProcessor', json_encode($recurProcessor));
431 $sel = &$this->addElement('hierselect',
432 'membership_type_id',
433 ts('Renewal Membership Organization and Type'), $js
436 $sel->setOptions(array($selMemTypeOrg, $selOrgMemType));
442 $this->applyFilter('__ALL__', 'trim');
444 $this->addDate('renewal_date', ts('Date Renewal Entered'), FALSE, array('formatType' => 'activityDate'));
446 $this->add('select', 'financial_type_id', ts('Financial Type'),
447 array('' => ts('- select -')) + CRM_Contribute_PseudoConstant
::financialType()
449 if (CRM_Core_Permission
::access('CiviContribute') && !$this->_mode
) {
450 $this->addElement('checkbox', 'record_contribution', ts('Record Renewal Payment?'), NULL, array('onclick' => "checkPayment();"));
452 $this->add('text', 'total_amount', ts('Amount'));
453 $this->addRule('total_amount', ts('Please enter a valid amount.'), 'money');
455 $this->addDate('receive_date', ts('Received'), FALSE, array('formatType' => 'activityDateTime'));
457 $this->add('text', 'num_terms', ts('Extend Membership by'), array('onchange' => "setPaymentBlock();"), TRUE);
458 $this->addRule('num_terms', ts('Please enter a whole number for how many periods to renew.'), 'integer');
460 $this->add('select', 'payment_instrument_id', ts('Paid By'),
461 array('' => ts('- select -')) + CRM_Contribute_PseudoConstant
::paymentInstrument(),
462 FALSE, array('onChange' => "return showHideByValue('payment_instrument_id','4','checkNumber','table-row','select',false);")
465 $this->add('text', 'trxn_id', ts('Transaction ID'));
466 $this->addRule('trxn_id', ts('Transaction ID already exists in Database.'),
467 'objectExists', array('CRM_Contribute_DAO_Contribution', $this->_id
, 'trxn_id')
470 $this->add('select', 'contribution_status_id', ts('Payment Status'),
471 CRM_Contribute_PseudoConstant
::contributionStatus()
474 $this->add('text', 'check_number', ts('Check Number'),
475 CRM_Core_DAO
::getAttribute('CRM_Contribute_DAO_Contribution', 'check_number')
479 $this->add('text', 'total_amount', ts('Amount'));
480 $this->addRule('total_amount', ts('Please enter a valid amount.'), 'money');
482 $this->addElement('checkbox', 'send_receipt', ts('Send Confirmation and Receipt?'), NULL,
483 array('onclick' => "showHideByValue( 'send_receipt', '', 'notice', 'table-row', 'radio', false ); showHideByValue( 'send_receipt', '', 'fromEmail', 'table-row', 'radio',false);")
486 $this->add('select', 'from_email_address', ts('Receipt From'), $this->_fromEmails
);
488 $this->add('textarea', 'receipt_text_renewal', ts('Renewal Message'));
491 $this->add('select', 'payment_processor_id', ts('Payment Processor'), $this->_processors
, TRUE);
492 CRM_Core_Payment_Form
::buildCreditCard($this, TRUE);
495 // Retrieve the name and email of the contact - this will be the TO for receipt email
496 list($this->_contributorDisplayName
,
497 $this->_contributorEmail
498 ) = CRM_Contact_BAO_Contact_Location
::getEmailDetails($this->_contactID
);
499 $this->assign('email', $this->_contributorEmail
);
501 $mailingInfo = CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::MAILING_PREFERENCES_NAME
,
504 $this->assign('outBound_option', $mailingInfo['outBound_option']);
506 if (CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership', $this->_id
, 'contribution_recur_id')) {
507 if (CRM_Member_BAO_Membership
::isCancelSubscriptionSupported($this->_id
)) {
508 $this->assign('cancelAutoRenew',
509 CRM_Utils_System
::url('civicrm/contribute/unsubscribe', "reset=1&mid={$this->_id}")
513 $this->addFormRule(array('CRM_Member_Form_MembershipRenewal', 'formRule'));
514 if ($this->_context
!= 'standalone') {
515 //CRM-10223 - allow contribution to be recorded against different contact
516 // causes a conflict in standalone mode so skip in standalone for now
517 $this->addElement('checkbox', 'contribution_contact', ts('Record Payment from a Different Contact?'));
518 $this->add( 'select', 'honor_type_id', ts('Membership payment is : '),
519 array( '' => ts( '-') ) + CRM_Core_PseudoConstant
::get('CRM_Contribute_DAO_Contribution', 'honor_type_id') );
520 require_once 'CRM/Contact/Form/NewContact.php';
521 CRM_Contact_Form_NewContact
::buildQuickForm($this,1, null, false,'contribution_');
526 * Function for validation
528 * @param array $params (ref.) an assoc array of name/value pairs
530 * @return mixed true or array of errors
534 static function formRule($params) {
536 if ($params['membership_type_id'][0] == 0) {
537 $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.');
539 if ($params['membership_type_id'][1] == 0) {
540 $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.');
543 //total amount condition arise when membership type having no
545 if (isset($params['record_contribution'])) {
546 if (!$params['financial_type_id']) {
547 $errors['financial_type_id'] = ts('Please select a Financial Type.');
549 if (!$params['total_amount']) {
550 $errors['total_amount'] = ts('Please enter a Contribution Amount.');
552 if (!CRM_Utils_Array
::value('payment_instrument_id', $params)) {
553 $errors['payment_instrument_id'] = ts('Paid By is a required field.');
556 return empty($errors) ?
TRUE : $errors;
560 * Function to process the renewal form
566 public function postProcess() {
569 $config = CRM_Core_Config
::singleton();
571 // get the submitted form values.
572 $this->_params
= $formValues = $this->controller
->exportValues($this->_name
);
574 $this->storeContactFields($formValues);
575 // use values from screen
577 if ($formValues['membership_type_id'][1] <> 0) {
578 $defaults['receipt_text_renewal'] = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType',
579 $formValues['membership_type_id'][1],
580 'receipt_text_renewal'
584 $now = CRM_Utils_Date
::getToday( null, 'YmdHis');
585 $this->convertDateFieldsToMySQL($formValues);
586 $this->assign('receive_date', $formValues['receive_date']);
588 if (CRM_Utils_Array
::value('send_receipt', $this->_params
)) {
589 $formValues['receipt_date'] = $now;
590 $this->assign('receipt_date', CRM_Utils_Date
::mysqlToIso($formValues['receipt_date']));
593 $formValues['receipt_date'] = NULL;
597 $formValues['total_amount'] = CRM_Utils_Array
::value('total_amount', $this->_params
, CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType',
598 $this->_memType
, 'minimum_fee'
600 if (!CRM_Utils_Array
::value('financial_type_id', $formValues)) {
601 $formValues['financial_type_id'] = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType', $this->_memType
,'financial_type_id');
604 $this->_paymentProcessor
= CRM_Financial_BAO_PaymentProcessor
::getPayment($formValues['payment_processor_id'],
610 // set email for primary location.
611 $fields['email-Primary'] = 1;
612 $formValues['email-5'] = $formValues['email-Primary'] = $this->_contributorEmail
;
613 $formValues['register_date'] = $now;
615 // now set the values for the billing location.
616 foreach ($this->_fields
as $name => $dontCare) {
620 // also add location name to the array
621 $formValues["address_name-{$this->_bltID}"] = CRM_Utils_Array
::value('billing_first_name', $formValues) . ' ' . CRM_Utils_Array
::value('billing_middle_name', $formValues) . ' ' . CRM_Utils_Array
::value('billing_last_name', $formValues);
623 $formValues["address_name-{$this->_bltID}"] = trim($formValues["address_name-{$this->_bltID}"]);
625 $fields["address_name-{$this->_bltID}"] = 1;
627 $fields["email-{$this->_bltID}"] = 1;
629 $ctype = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $this->_contactID
, 'contact_type');
631 $nameFields = array('first_name', 'middle_name', 'last_name');
633 foreach ($nameFields as $name) {
635 if (array_key_exists("billing_$name", $formValues)) {
636 $formValues[$name] = $formValues["billing_{$name}"];
637 $formValues['preserveDBName'] = TRUE;
641 //here we are setting up the billing contact - if different from the member they are already created
642 // but they will get billing details assigned
643 CRM_Contact_BAO_Contact
::createProfileContact($formValues, $fields,
644 $this->_contributorContactID
, NULL, NULL, $ctype
647 // add all the additional payment params we need
648 $this->_params
["state_province-{$this->_bltID}"] = $this->_params
["billing_state_province-{$this->_bltID}"] = CRM_Core_PseudoConstant
::stateProvinceAbbreviation($this->_params
["billing_state_province_id-{$this->_bltID}"]);
649 $this->_params
["country-{$this->_bltID}"] = $this->_params
["billing_country-{$this->_bltID}"] = CRM_Core_PseudoConstant
::countryIsoCode($this->_params
["billing_country_id-{$this->_bltID}"]);
651 $this->_params
['year'] = CRM_Core_Payment_Form
::getCreditCardExpirationYear($this->_params
);
652 $this->_params
['month'] = CRM_Core_Payment_Form
::getCreditCardExpirationMonth($this->_params
);
653 $this->_params
['ip_address'] = CRM_Utils_System
::ipAddress();
654 $this->_params
['amount'] = $formValues['total_amount'];
655 $this->_params
['currencyID'] = $config->defaultCurrency
;
656 $this->_params
['payment_action'] = 'Sale';
657 $this->_params
['invoiceID'] = md5(uniqid(rand(), TRUE));
659 // at this point we've created a contact and stored its address etc
660 // all the payment processors expect the name and address to be in the passed params
661 // so we copy stuff over to first_name etc.
662 $paymentParams = $this->_params
;
663 if (CRM_Utils_Array
::value('send_receipt', $this->_params
)) {
664 $paymentParams['email'] = $this->_contributorEmail
;
667 $paymentParams['contactID'] = $this->_contributorContactID
;
668 //CRM-10377 if payment is by an alternate contact then we need to set that person
669 // as the contact in the payment params
670 if ($this->_contributorContactID
!= $this->_contactID
) {
671 if (CRM_Utils_Array
::value('honor_type_id', $this->_params
)) {
672 $paymentParams['honor_contact_id'] = $this->_contactID
;
673 $paymentParams['honor_type_id'] = $this->_params
['honor_type_id'];
677 CRM_Core_Payment_Form
::mapParams($this->_bltID
, $this->_params
, $paymentParams, TRUE);
679 $payment = CRM_Core_Payment
::singleton($this->_mode
, $this->_paymentProcessor
, $this);
681 $result = &$payment->doDirectPayment($paymentParams);
683 if (is_a($result, 'CRM_Core_Error')) {
684 CRM_Core_Error
::displaySessionError($result);
685 CRM_Utils_System
::redirect(CRM_Utils_System
::url('civicrm/contact/view/membership',
686 "reset=1&action=renew&cid={$this->_contactID}&id={$this->_id}&context=membership&mode={$this->_mode}"
691 $this->_params
= array_merge($this->_params
, $result);
693 $formValues['contribution_status_id'] = 1;
694 $formValues['invoice_id'] = $this->_params
['invoiceID'];
695 $formValues['trxn_id'] = $result['trxn_id'];
696 $formValues['payment_instrument_id'] = 1;
697 $formValues['is_test'] = ($this->_mode
== 'live') ?
0 : 1;
698 $this->set('params', $this->_params
);
699 $this->assign('trxn_id', $result['trxn_id']);
704 if ($formValues['renewal_date']) {
705 $this->set('renewalDate', CRM_Utils_Date
::processDate($formValues['renewal_date']));
707 $this->_membershipId
= $this->_id
;
709 // membership type custom data
710 $customFields = CRM_Core_BAO_CustomField
::getFields('Membership', FALSE, FALSE,
711 $formValues['membership_type_id'][1]
714 $customFields = CRM_Utils_Array
::crmArrayMerge($customFields,
715 CRM_Core_BAO_CustomField
::getFields('Membership',
721 $customFieldsFormatted = CRM_Core_BAO_CustomField
::postProcess($formValues,
727 // check for test membership.
728 $isTestMembership = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership', $this->_membershipId
, 'is_test');
730 // chk for renewal for multiple terms CRM-8750
732 if (is_numeric(CRM_Utils_Array
::value('num_terms', $formValues))) {
733 $numRenewTerms = $formValues['num_terms'];
736 //if contribution status is pending then set pay later
737 if ($formValues['contribution_status_id'] == array_search('Pending', CRM_Contribute_PseudoConstant
::contributionStatus())) {
738 $this->_params
['is_pay_later'] = 1;
740 $renewMembership = CRM_Member_BAO_Membership
::renewMembership($this->_contactID
,
741 $formValues['membership_type_id'][1],
742 $isTestMembership, $this, NULL, NULL,
743 $customFieldsFormatted, $numRenewTerms
746 $endDate = CRM_Utils_Date
::processDate($renewMembership->end_date
);
748 // Retrieve the name and email of the current user - this will be the FROM for the receipt email
749 $session = CRM_Core_Session
::singleton();
750 $userID = $session->get('userID');
752 list($userName, $userEmail) = CRM_Contact_BAO_Contact_Location
::getEmailDetails($userID);
754 $memType = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType', $renewMembership->membership_type_id
, 'name');
756 if (CRM_Utils_Array
::value('record_contribution', $formValues) ||
$this->_mode
) {
758 $formValues['contribution_source'] = "{$memType} Membership: Offline membership renewal (by {$userName})";
763 CRM_Member_BAO_Membership
::createLineItems($this, $formValues['membership_type_id'], $priceSetId);
764 CRM_Price_BAO_PriceSet
::processAmount($this->_priceSet
['fields'],
765 $this->_params
, $lineItem[$priceSetId]
767 //CRM-11529 for quick config backoffice transactions
768 //when financial_type_id is passed in form, update the
769 //lineitems with the financial type selected in form
770 if ($submittedFinancialType = CRM_Utils_Array
::value('financial_type_id', $formValues)) {
771 foreach ($lineItem[$priceSetId] as &$li) {
772 $li['financial_type_id'] = $submittedFinancialType;
775 $formValues['total_amount'] = CRM_Utils_Array
::value('amount', $this->_params
);
776 if (!empty($lineItem)) {
777 $formValues['lineItems'] = $lineItem;
778 $formValues['processPriceSet'] = TRUE;
781 //assign contribution contact id to the field expected by recordMembershipContribution
782 if($this->_contributorContactID
!= $this->_contactID
){
783 $formValues['contribution_contact_id'] = $this->_contributorContactID
;
784 if(CRM_Utils_Array
::value('honor_type_id', $this->_params
)){
785 $formValues['honor_contact_id'] = $this->_contactID
;
788 $formValues['contact_id'] = $this->_contactID
;
790 CRM_Member_BAO_Membership
::recordMembershipContribution(array_merge($formValues, array('membership_id' => $renewMembership->id
)));
793 if (CRM_Utils_Array
::value('send_receipt', $formValues)) {
794 CRM_Core_DAO
::setFieldValue('CRM_Member_DAO_MembershipType',
795 $formValues['membership_type_id'][1],
796 'receipt_text_renewal',
797 $formValues['receipt_text_renewal']
801 $receiptSend = FALSE;
802 if (CRM_Utils_Array
::value('send_receipt', $formValues)) {
805 $receiptFrom = $formValues['from_email_address'];
807 if (CRM_Utils_Array
::value('payment_instrument_id', $formValues)) {
808 $paymentInstrument = CRM_Contribute_PseudoConstant
::paymentInstrument();
809 $formValues['paidBy'] = $paymentInstrument[$formValues['payment_instrument_id']];
812 $this->_groupTree
= CRM_Core_BAO_CustomGroup
::getTree('Membership', $this, $this->_id
, FALSE, $this->_memType
);
814 // retrieve custom data
815 $customFields = $customValues = $fo = array();
816 foreach ($this->_groupTree
as $groupID => $group) {
817 if ($groupID == 'info') {
820 foreach ($group['fields'] as $k => $field) {
821 $field['title'] = $field['label'];
822 $customFields["custom_{$k}"] = $field;
825 $members = array(array('member_id', '=', $this->_membershipId
, 0, 0));
826 // check whether its a test drive
827 if ($this->_mode
== 'test') {
828 $members[] = array('member_test', '=', 1, 0, 0);
830 CRM_Core_BAO_UFGroup
::getValues($this->_contactID
, $customFields, $customValues, FALSE, $members);
832 $this->assign_by_ref('formValues', $formValues);
833 if ( CRM_Utils_Array
::value( 'contribution_id', $formValues ) ) {
834 $this->assign('contributionID', $formValues['contribution_id']);
836 $this->assign('membershipID', $this->_id
);
837 $this->assign('contactID', $this->_contactID
);
838 $this->assign('module', 'Membership');
839 $this->assign('receiptType', 'membership renewal');
840 $this->assign('mem_start_date', CRM_Utils_Date
::customFormat($renewMembership->start_date
));
841 $this->assign('mem_end_date', CRM_Utils_Date
::customFormat($renewMembership->end_date
));
842 $this->assign('membership_name', CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType',
843 $renewMembership->membership_type_id
845 $this->assign('customValues', $customValues);
847 if (CRM_Utils_Array
::value('billing_first_name', $this->_params
)) {
848 $name = $this->_params
['billing_first_name'];
851 if (CRM_Utils_Array
::value('billing_middle_name', $this->_params
)) {
852 $name .= " {$this->_params['billing_middle_name']}";
855 if (CRM_Utils_Array
::value('billing_last_name', $this->_params
)) {
856 $name .= " {$this->_params['billing_last_name']}";
858 $this->assign('billingName', $name);
860 // assign the address formatted up for display
861 $addressParts = array(
862 "street_address-{$this->_bltID}",
863 "city-{$this->_bltID}",
864 "postal_code-{$this->_bltID}",
865 "state_province-{$this->_bltID}",
866 "country-{$this->_bltID}",
868 $addressFields = array();
869 foreach ($addressParts as $part) {
870 list($n, $id) = explode('-', $part);
871 if (isset($this->_params
['billing_' . $part])) {
872 $addressFields[$n] = $this->_params
['billing_' . $part];
875 $this->assign('address', CRM_Utils_Address
::format($addressFields));
876 $date = CRM_Utils_Date
::format($this->_params
['credit_card_exp_date']);
877 $date = CRM_Utils_Date
::mysqlToIso($date);
878 $this->assign('credit_card_exp_date', $date);
879 $this->assign('credit_card_number',
880 CRM_Utils_System
::mungeCreditCard($this->_params
['credit_card_number'])
882 $this->assign('credit_card_type', $this->_params
['credit_card_type']);
883 $this->assign('contributeMode', 'direct');
884 $this->assign('isAmountzero', 0);
885 $this->assign('is_pay_later', 0);
886 $this->assign('isPrimary', 1);
887 if ($this->_mode
== 'test') {
888 $this->assign('action', '1024');
892 list($mailSend, $subject, $message, $html) = CRM_Core_BAO_MessageTemplate
::sendTemplate(
894 'groupName' => 'msg_tpl_workflow_membership',
895 'valueName' => 'membership_offline_receipt',
896 'contactId' => $this->_receiptContactId
,
897 'from' => $receiptFrom,
898 'toName' => $this->_contributorDisplayName
,
899 'toEmail' => $this->_contributorEmail
,
900 'isTest' => $this->_mode
== 'test',
905 $statusMsg = ts('%1 membership for %2 has been renewed.', array(1 => $memType, 2 => $this->_memberDisplayName
));
908 $statusMsg .= ' ' . ts('The new membership End Date is %1.', array(1 => CRM_Utils_Date
::customFormat(substr($endDate,0,8))));
911 if ($receiptSend && $mailSend) {
912 $statusMsg .= ' ' . ts('A renewal confirmation and receipt has been sent to %1.', array(1 => $this->_contributorEmail
));
915 CRM_Core_Session
::setStatus($statusMsg, ts('Complete'), 'success');