3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2015 |
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-2015
37 * This class generates form components for Membership Renewal
40 class CRM_Member_Form_MembershipRenewal
extends CRM_Member_Form
{
43 * Display name of the member.
47 protected $_memberDisplayName = NULL;
50 * email of the person paying for the membership (used for receipts)
52 protected $_memberEmail = NULL;
55 * Contact ID of the member.
60 public $_contactID = NULL;
63 * Display name of the person paying for the membership (used for receipts)
67 protected $_contributorDisplayName = NULL;
70 * email of the person paying for the membership (used for receipts)
72 protected $_contributorEmail = NULL;
75 * email of the person paying for the membership (used for receipts)
79 protected $_contributorContactID = NULL;
82 * ID of the person the receipt is to go to
86 protected $_receiptContactId = NULL;
89 * context would be set to standalone if the contact is use is being selected from
90 * the form rather than in the URL
95 * End date of renewed membership.
99 protected $endDate = NULL;
102 * Has an email been sent.
106 protected $isMailSent = FALSE;
109 * The name of the renewed membership type.
113 protected $membershipTypeName = '';
116 * An array to hold a list of datefields on the form
117 * so that they can be converted to ISO in a consistent manner
121 protected $_dateFields = array(
122 'receive_date' => array('default' => 'now'),
125 public function preProcess() {
127 // This string makes up part of the class names, differentiating them (not sure why) from the membership fields.
128 $this->assign('formClass', 'membershiprenew');
129 parent
::preProcess();
130 // check for edit permission
131 if (!CRM_Core_Permission
::check('edit memberships')) {
132 CRM_Core_Error
::fatal(ts('You do not have permission to access this page.'));
135 $this->assign('endDate', CRM_Utils_Date
::customFormat(CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership',
136 $this->_id
, 'end_date'
139 $this->assign('membershipStatus',
140 CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipStatus',
141 CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership',
142 $this->_id
, 'status_id'
149 $membershipFee = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType', $this->_memType
, 'minimum_fee');
150 if (!$membershipFee) {
151 $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.');
152 CRM_Core_Session
::setStatus($statusMsg, '', 'info');
153 CRM_Utils_System
::redirect(CRM_Utils_System
::url('civicrm/contact/view/membership',
154 "reset=1&action=renew&cid={$this->_contactID}&id={$this->_id}&context=membership"
159 // when custom data is included in this page
160 if (!empty($_POST['hidden_custom'])) {
161 CRM_Custom_Form_CustomData
::preProcess($this);
162 CRM_Custom_Form_CustomData
::buildQuickForm($this);
163 CRM_Custom_Form_CustomData
::setDefaultValues($this);
166 CRM_Utils_System
::setTitle(ts('Renew Membership'));
168 parent
::preProcess();
172 * Set default values for the form.
173 * the default values are retrieved from the database
178 public function setDefaultValues() {
180 $defaults = parent
::setDefaultValues();
181 $this->_memType
= $defaults['membership_type_id'];
183 // set renewal_date and receive_date to today in correct input format (setDateDefaults uses today if no value passed)
184 list($now, $currentTime) = CRM_Utils_Date
::setDateDefaults();
185 $defaults['renewal_date'] = $now;
186 $defaults['receive_date'] = $now;
187 $defaults['receive_date_time'] = $currentTime;
189 if ($defaults['id']) {
190 $defaults['record_contribution'] = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipPayment',
197 if (is_numeric($this->_memType
)) {
198 $defaults['membership_type_id'] = array();
199 $defaults['membership_type_id'][0] = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType',
201 'member_of_contact_id',
204 $defaults['membership_type_id'][1] = $this->_memType
;
207 $defaults['membership_type_id'] = $this->_memType
;
210 $defaults['financial_type_id'] = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType', $this->_memType
, 'financial_type_id');
213 if (empty($defaults['payment_instrument_id'])) {
214 $defaults['payment_instrument_id'] = key(CRM_Core_OptionGroup
::values('payment_instrument', FALSE, FALSE, FALSE, 'AND is_default = 1'));
217 $defaults['total_amount'] = CRM_Utils_Money
::format(CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType',
222 $defaults['record_contribution'] = 0;
223 $defaults['num_terms'] = 1;
224 $defaults['send_receipt'] = 0;
226 //set Soft Credit Type to Gift by default
227 $scTypes = CRM_Core_OptionGroup
::values("soft_credit_type");
228 $defaults['soft_credit_type_id'] = CRM_Utils_Array
::value(ts('Gift'), array_flip($scTypes));
230 $renewalDate = CRM_Utils_Date
::processDate(CRM_Utils_Array
::value('renewal_date', $defaults),
233 $this->assign('renewalDate', $renewalDate);
234 $this->assign('member_is_test', CRM_Utils_Array
::value('member_is_test', $defaults));
237 // set default country from config if no country set
238 $config = CRM_Core_Config
::singleton();
239 if (empty($defaults["billing_country_id-{$this->_bltID}"])) {
240 $defaults["billing_country_id-{$this->_bltID}"] = $config->defaultContactCountry
;
243 if (empty($defaults["billing_state_province_id-{$this->_bltID}"])) {
244 $defaults["billing_state_province_id-{$this->_bltID}"] = $config->defaultContactStateProvince
;
247 $billingDefaults = $this->getProfileDefaults('Billing', $this->_contactID
);
248 $defaults = array_merge($defaults, $billingDefaults);
255 * Build the form object.
257 public function buildQuickForm() {
259 parent
::buildQuickForm();
261 $defaults = parent
::setDefaultValues();
262 $this->_memType
= $defaults['membership_type_id'];
263 $this->assign('customDataType', 'Membership');
264 $this->assign('customDataSubType', $this->_memType
);
265 $this->assign('entityID', $this->_id
);
266 $selOrgMemType[0][0] = $selMemTypeOrg[0] = ts('- select -');
268 $allMembershipInfo = array();
270 // auto renew options if enabled for the membership
271 $options = CRM_Core_SelectValues
::memberAutoRenew();
273 foreach ($this->allMembershipTypeDetails
as $key => $values) {
274 if (!empty($values['is_active'])) {
275 if ($this->_mode
&& empty($values['minimum_fee'])) {
279 $memberOfContactId = CRM_Utils_Array
::value('member_of_contact_id', $values);
280 if (empty($selMemTypeOrg[$memberOfContactId])) {
281 $selMemTypeOrg[$memberOfContactId] = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact',
287 $selOrgMemType[$memberOfContactId][0] = ts('- select -');
289 if (empty($selOrgMemType[$memberOfContactId][$key])) {
290 $selOrgMemType[$memberOfContactId][$key] = CRM_Utils_Array
::value('name', $values);
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),
298 'total_amount' => CRM_Utils_Money
::format($values['minimum_fee'], NULL, '%a'),
299 'total_amount_numeric' => CRM_Utils_Array
::value('minimum_fee', $values),
302 if (!empty($values['auto_renew'])) {
303 $allMembershipInfo[$key]['auto_renew'] = $options[$values['auto_renew']];
308 $this->assign('allMembershipInfo', json_encode($allMembershipInfo));
310 if ($this->_memType
) {
311 $this->assign('orgName', $selMemTypeOrg[$this->allMembershipTypeDetails
[$this->_memType
]['member_of_contact_id']]);
312 $this->assign('memType', $this->allMembershipTypeDetails
[$this->_memType
]['name']);
315 // force select of organization by default, if only one organization in
317 if (count($selMemTypeOrg) == 2) {
318 unset($selMemTypeOrg[0], $selOrgMemType[0][0]);
320 //sort membership organization and type, CRM-6099
321 natcasesort($selMemTypeOrg);
322 foreach ($selOrgMemType as $index => $orgMembershipType) {
323 natcasesort($orgMembershipType);
324 $selOrgMemType[$index] = $orgMembershipType;
327 $js = array('onChange' => "setPaymentBlock(); CRM.buildCustomData('Membership', this.value);");
328 $sel = &$this->addElement('hierselect',
329 'membership_type_id',
330 ts('Renewal Membership Organization and Type'), $js
333 $sel->setOptions(array($selMemTypeOrg, $selOrgMemType));
339 $this->applyFilter('__ALL__', 'trim');
341 $this->addDate('renewal_date', ts('Date Renewal Entered'), FALSE, array('formatType' => 'activityDate'));
343 $this->add('select', 'financial_type_id', ts('Financial Type'),
344 array('' => ts('- select -')) + CRM_Contribute_PseudoConstant
::financialType()
346 if (CRM_Core_Permission
::access('CiviContribute') && !$this->_mode
) {
347 $this->addElement('checkbox', 'record_contribution', ts('Record Renewal Payment?'), NULL, array('onclick' => "checkPayment();"));
349 $this->add('text', 'total_amount', ts('Amount'));
350 $this->addRule('total_amount', ts('Please enter a valid amount.'), 'money');
352 $this->addDate('receive_date', ts('Received'), FALSE, array('formatType' => 'activityDateTime'));
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');
357 $this->add('select', 'payment_instrument_id', ts('Payment Method'),
358 array('' => ts('- select -')) + CRM_Contribute_PseudoConstant
::paymentInstrument(),
359 FALSE, array('onChange' => "return showHideByValue('payment_instrument_id','4','checkNumber','table-row','select',false);")
362 $this->add('text', 'trxn_id', ts('Transaction ID'));
363 $this->addRule('trxn_id', ts('Transaction ID already exists in Database.'),
364 'objectExists', array('CRM_Contribute_DAO_Contribution', $this->_id
, 'trxn_id')
367 $this->add('select', 'contribution_status_id', ts('Payment Status'),
368 CRM_Contribute_PseudoConstant
::contributionStatus()
371 $this->add('text', 'check_number', ts('Check Number'),
372 CRM_Core_DAO
::getAttribute('CRM_Contribute_DAO_Contribution', 'check_number')
376 $this->add('text', 'total_amount', ts('Amount'));
377 $this->addRule('total_amount', ts('Please enter a valid amount.'), 'money');
379 $this->addElement('checkbox', 'send_receipt', ts('Send Confirmation and Receipt?'), NULL,
380 array('onclick' => "showHideByValue( 'send_receipt', '', 'notice', 'table-row', 'radio', false ); showHideByValue( 'send_receipt', '', 'fromEmail', 'table-row', 'radio',false);")
383 $this->add('select', 'from_email_address', ts('Receipt From'), $this->_fromEmails
);
385 $this->add('textarea', 'receipt_text_renewal', ts('Renewal Message'));
387 // Retrieve the name and email of the contact - this will be the TO for receipt email
388 list($this->_contributorDisplayName
,
389 $this->_contributorEmail
390 ) = CRM_Contact_BAO_Contact_Location
::getEmailDetails($this->_contactID
);
391 $this->assign('email', $this->_contributorEmail
);
392 // The member form uses emailExists. Assigning both while we transition / synchronise.
393 $this->assign('emailExists', $this->_contributorEmail
);
395 $mailingInfo = CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::MAILING_PREFERENCES_NAME
,
398 $this->assign('outBound_option', $mailingInfo['outBound_option']);
400 if (CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership', $this->_id
, 'contribution_recur_id')) {
401 if (CRM_Member_BAO_Membership
::isCancelSubscriptionSupported($this->_id
)) {
402 $this->assign('cancelAutoRenew',
403 CRM_Utils_System
::url('civicrm/contribute/unsubscribe', "reset=1&mid={$this->_id}")
407 $this->addFormRule(array('CRM_Member_Form_MembershipRenewal', 'formRule'));
408 $this->addElement('checkbox', 'is_different_contribution_contact', ts('Record Payment from a Different
410 $this->addSelect('soft_credit_type_id', array('entity' => 'contribution_soft'));
411 $this->addEntityRef('soft_credit_contact_id', ts('Payment From'), array('create' => TRUE));
417 * @param array $params
418 * (ref.) an assoc array of name/value pairs.
421 * mixed true or array of errors
423 public static function formRule($params) {
425 if ($params['membership_type_id'][0] == 0) {
426 $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.');
428 if ($params['membership_type_id'][1] == 0) {
429 $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.');
432 //total amount condition arise when membership type having no
434 if (isset($params['record_contribution'])) {
435 if (!$params['financial_type_id']) {
436 $errors['financial_type_id'] = ts('Please select a Financial Type.');
438 if (!$params['total_amount']) {
439 $errors['total_amount'] = ts('Please enter a Contribution Amount.');
441 if (empty($params['payment_instrument_id'])) {
442 $errors['payment_instrument_id'] = ts('Payment Method is a required field.');
445 return empty($errors) ?
TRUE : $errors;
449 * Process the renewal form.
454 public function postProcess() {
455 // get the submitted form values.
456 $this->_params
= $this->controller
->exportValues($this->_name
);
457 $this->assignBillingName();
461 $statusMsg = ts('%1 membership for %2 has been renewed.', array(1 => $this->membershipTypeName
, 2 => $this->_memberDisplayName
));
463 if ($this->endDate
) {
464 $statusMsg .= ' ' . ts('The new membership End Date is %1.', array(
465 1 => CRM_Utils_Date
::customFormat(substr($this->endDate
, 0, 8)),
469 if ($this->isMailSent
) {
470 $statusMsg .= ' ' . ts('A renewal confirmation and receipt has been sent to %1.', array(
471 1 => $this->_contributorEmail
,
477 catch (\Civi\Payment\Exception\PaymentProcessorException
$e) {
478 CRM_Core_Error
::displaySessionError($e->getMessage());
479 CRM_Utils_System
::redirect(CRM_Utils_System
::url('civicrm/contact/view/membership',
480 "reset=1&action=renew&cid={$this->_contactID}&id={$this->_id}&context=membership&mode={$this->_mode}"
484 CRM_Core_Session
::setStatus($statusMsg, ts('Complete'), 'success');
488 * Process form submission.
490 * This function is also accessed by a unit test.
492 protected function submit() {
493 $this->storeContactFields($this->_params
);
495 $now = CRM_Utils_Date
::getToday(NULL, 'YmdHis');
496 $this->convertDateFieldsToMySQL($this->_params
);
497 $this->assign('receive_date', $this->_params
['receive_date']);
498 $this->processBillingAddress($now);
499 list($userName) = CRM_Contact_BAO_Contact_Location
::getEmailDetails(CRM_Core_Session
::singleton()->get('userID'));
500 $this->_params
['total_amount'] = CRM_Utils_Array
::value('total_amount', $this->_params
,
501 CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType', $this->_memType
, 'minimum_fee')
503 $this->_membershipId
= $this->_id
;
504 $customFieldsFormatted = CRM_Core_BAO_CustomField
::postProcess($this->_params
,
508 if (empty($this->_params
['financial_type_id'])) {
509 $this->_params
['financial_type_id'] = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType', $this->_memType
, 'financial_type_id');
512 $this->assign('membershipID', $this->_id
);
513 $this->assign('contactID', $this->_contactID
);
514 $this->assign('module', 'Membership');
515 $this->assign('receiptType', 'membership renewal');
516 $this->_params
['currencyID'] = CRM_Core_Config
::singleton()->defaultCurrency
;
517 $this->_params
['invoice_id'] = $this->_params
['invoiceID'] = md5(uniqid(rand(), TRUE));
519 if (!empty($this->_params
['send_receipt'])) {
520 $this->_params
['receipt_date'] = $now;
521 $this->assign('receipt_date', CRM_Utils_Date
::mysqlToIso($this->_params
['receipt_date']));
524 $this->_params
['receipt_date'] = NULL;
528 $this->_params
['register_date'] = $now;
529 $this->_paymentProcessor
= CRM_Financial_BAO_PaymentProcessor
::getPayment($this->_params
['payment_processor_id']);
531 $this->_params
['year'] = CRM_Core_Payment_Form
::getCreditCardExpirationYear($this->_params
);
532 $this->_params
['month'] = CRM_Core_Payment_Form
::getCreditCardExpirationMonth($this->_params
);
533 $this->assign('credit_card_exp_date', CRM_Utils_Date
::mysqlToIso(CRM_Utils_Date
::format($this->_params
['credit_card_exp_date'])));
534 $this->assign('credit_card_number',
535 CRM_Utils_System
::mungeCreditCard($this->_params
['credit_card_number'])
537 $this->assign('credit_card_type', $this->_params
['credit_card_type']);
538 $this->_params
['description'] = ts("Contribution submitted by a staff person using member's credit card for renewal");
539 $this->_params
['ip_address'] = CRM_Utils_System
::ipAddress();
540 $this->_params
['amount'] = $this->_params
['total_amount'];
542 // at this point we've created a contact and stored its address etc
543 // all the payment processors expect the name and address to be in the passed params
544 // so we copy stuff over to first_name etc.
545 $paymentParams = $this->_params
;
546 if (!empty($this->_params
['send_receipt'])) {
547 $paymentParams['email'] = $this->_contributorEmail
;
550 $paymentParams['contactID'] = $this->_contributorContactID
;
552 CRM_Core_Payment_Form
::mapParams($this->_bltID
, $this->_params
, $paymentParams, TRUE);
554 $payment = $this->_paymentProcessor
['object'];
556 if (!empty($this->_params
['auto_renew'])) {
557 $contributionRecurParams = $this->processRecurringContribution($paymentParams);
558 $paymentParams = array_merge($paymentParams, $contributionRecurParams);
561 $result = $payment->doPayment($paymentParams);
562 $this->_params
= array_merge($this->_params
, $result);
564 $this->_params
['contribution_status_id'] = $result['payment_status_id'];
565 $this->_params
['trxn_id'] = $result['trxn_id'];
566 $this->_params
['payment_instrument_id'] = 1;
567 $this->_params
['is_test'] = ($this->_mode
== 'live') ?
0 : 1;
568 $this->set('params', $this->_params
);
569 $this->assign('trxn_id', $result['trxn_id']);
572 $renewalDate = !empty($this->_params
['renewal_date']) ?
$renewalDate = CRM_Utils_Date
::processDate($this->_params
['renewal_date']) : NULL;
574 // check for test membership.
575 $isTestMembership = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership', $this->_membershipId
, 'is_test');
577 // chk for renewal for multiple terms CRM-8750
579 if (is_numeric(CRM_Utils_Array
::value('num_terms', $this->_params
))) {
580 $numRenewTerms = $this->_params
['num_terms'];
583 //if contribution status is pending then set pay later
584 $this->_params
['is_pay_later'] = FALSE;
585 if ($this->_params
['contribution_status_id'] == array_search('Pending', CRM_Contribute_PseudoConstant
::contributionStatus())) {
586 $this->_params
['is_pay_later'] = 1;
589 // These variable sets prior to renewMembership may not be required for this form. They were in
590 // a function this form shared with other forms.
591 $contributionRecurID = isset($this->_params
['contributionRecurID']) ?
$this->_params
['contributionRecurID'] : NULL;
592 $membershipSource = NULL;
593 if (!empty($this->_params
['membership_source'])) {
594 $membershipSource = $this->_params
['membership_source'];
597 $isPending = ($this->_params
['contribution_status_id'] == 2) ?
TRUE : FALSE;
599 list($renewMembership) = CRM_Member_BAO_Membership
::renewMembership(
600 $this->_contactID
, $this->_params
['membership_type_id'][1], $isTestMembership,
601 $renewalDate, NULL, $customFieldsFormatted, $numRenewTerms, $this->_membershipId
,
603 $contributionRecurID, $membershipSource, $this->_params
['is_pay_later'], CRM_Utils_Array
::value('campaign_id',
607 $this->endDate
= CRM_Utils_Date
::processDate($renewMembership->end_date
);
609 $this->membershipTypeName
= CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType', $renewMembership->membership_type_id
,
612 if (!empty($this->_params
['record_contribution']) ||
$this->_mode
) {
614 $this->_params
['contribution_source'] = "{$this->membershipTypeName} Membership: Offline membership renewal (by {$userName})";
619 $priceSetId = CRM_Member_BAO_Membership
::createLineItems($this, $this->_params
['membership_type_id']);
620 CRM_Price_BAO_PriceSet
::processAmount($this->_priceSet
['fields'],
621 $this->_params
, $lineItem[$priceSetId]
623 //CRM-11529 for quick config backoffice transactions
624 //when financial_type_id is passed in form, update the
625 //line items with the financial type selected in form
626 if ($submittedFinancialType = CRM_Utils_Array
::value('financial_type_id', $this->_params
)) {
627 foreach ($lineItem[$priceSetId] as &$li) {
628 $li['financial_type_id'] = $submittedFinancialType;
631 $this->_params
['total_amount'] = CRM_Utils_Array
::value('amount', $this->_params
);
632 if (!empty($lineItem)) {
633 $this->_params
['lineItems'] = $lineItem;
634 $this->_params
['processPriceSet'] = TRUE;
637 //assign contribution contact id to the field expected by recordMembershipContribution
638 if ($this->_contributorContactID
!= $this->_contactID
) {
639 $this->_params
['contribution_contact_id'] = $this->_contributorContactID
;
640 if (!empty($this->_params
['soft_credit_type_id'])) {
641 $this->_params
['soft_credit'] = array(
642 'soft_credit_type_id' => $this->_params
['soft_credit_type_id'],
643 'contact_id' => $this->_contactID
,
647 $this->_params
['contact_id'] = $this->_contactID
;
648 //recordMembershipContribution receives params as a reference & adds one variable. This is
649 // not a great pattern & ideally it would not receive as a reference. We assign our params as a
650 // temporary variable to avoid e-notice & to make it clear to future refactorer that
651 // this function is NOT reliant on that var being set
652 $temporaryParams = array_merge($this->_params
, array('membership_id' => $renewMembership->id
));
653 CRM_Member_BAO_Membership
::recordMembershipContribution($temporaryParams);
656 if (!empty($this->_params
['send_receipt'])) {
658 $receiptFrom = $this->_params
['from_email_address'];
660 if (!empty($this->_params
['payment_instrument_id'])) {
661 $paymentInstrument = CRM_Contribute_PseudoConstant
::paymentInstrument();
662 $this->_params
['paidBy'] = $paymentInstrument[$this->_params
['payment_instrument_id']];
665 $this->_groupTree
= CRM_Core_BAO_CustomGroup
::getTree('Membership', $this, $this->_id
, FALSE, $this->_memType
);
667 // retrieve custom data
668 $customFields = $customValues = $fo = array();
669 foreach ($this->_groupTree
as $groupID => $group) {
670 if ($groupID == 'info') {
673 foreach ($group['fields'] as $k => $field) {
674 $field['title'] = $field['label'];
675 $customFields["custom_{$k}"] = $field;
678 $members = array(array('member_id', '=', $this->_membershipId
, 0, 0));
679 // check whether its a test drive
680 if ($this->_mode
== 'test') {
681 $members[] = array('member_test', '=', 1, 0, 0);
683 CRM_Core_BAO_UFGroup
::getValues($this->_contactID
, $customFields, $customValues, FALSE, $members);
685 $this->assign_by_ref('formValues', $this->_params
);
686 if (!empty($this->_params
['contribution_id'])) {
687 $this->assign('contributionID', $this->_params
['contribution_id']);
690 $this->assign('membership_name', CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType',
691 $renewMembership->membership_type_id
693 $this->assign('customValues', $customValues);
694 $this->assign('mem_start_date', CRM_Utils_Date
::customFormat($renewMembership->start_date
));
695 $this->assign('mem_end_date', CRM_Utils_Date
::customFormat($renewMembership->end_date
));
697 // assign the address formatted up for display
698 $addressParts = array(
699 "street_address-{$this->_bltID}",
700 "city-{$this->_bltID}",
701 "postal_code-{$this->_bltID}",
702 "state_province-{$this->_bltID}",
703 "country-{$this->_bltID}",
705 $addressFields = array();
706 foreach ($addressParts as $part) {
707 list($n) = explode('-', $part);
708 if (isset($this->_params
['billing_' . $part])) {
709 $addressFields[$n] = $this->_params
['billing_' . $part];
712 $this->assign('address', CRM_Utils_Address
::format($addressFields));
713 $this->assign('contributeMode', 'direct');
714 $this->assign('isAmountzero', 0);
715 $this->assign('is_pay_later', 0);
716 $this->assign('isPrimary', 1);
717 $this->assign('receipt_text_renewal', $this->_params
['receipt_text']);
718 if ($this->_mode
== 'test') {
719 $this->assign('action', '1024');
723 list($this->isMailSent
) = CRM_Core_BAO_MessageTemplate
::sendTemplate(
725 'groupName' => 'msg_tpl_workflow_membership',
726 'valueName' => 'membership_offline_receipt',
727 'contactId' => $this->_receiptContactId
,
728 'from' => $receiptFrom,
729 'toName' => $this->_contributorDisplayName
,
730 'toEmail' => $this->_contributorEmail
,
731 'isTest' => $this->_mode
== 'test',
738 * Wrapper function for unit tests.
740 * @param array $formValues
742 public function testSubmit($formValues) {
743 $this->_memType
= $formValues['membership_type_id'][1];
744 $this->_params
= $formValues;
745 $this->submit($formValues);
748 protected function assignBillingName() {
750 if (!empty($this->_params
['billing_first_name'])) {
751 $name = $this->_params
['billing_first_name'];
754 if (!empty($this->_params
['billing_middle_name'])) {
755 $name .= " {$this->_params['billing_middle_name']}";
758 if (!empty($this->_params
['billing_last_name'])) {
759 $name .= " {$this->_params['billing_last_name']}";
761 $this->assign('billingName', $name);
765 * Add the billing address to the contact who paid.
767 protected function processBillingAddress() {
770 // set email for primary location.
771 $fields['email-Primary'] = 1;
772 $this->_params
['email-5'] = $this->_params
['email-Primary'] = $this->_contributorEmail
;
774 // also add location name to the array
775 $this->_params
["address_name-{$this->_bltID}"] = CRM_Utils_Array
::value('billing_first_name', $this->_params
) . ' ' . CRM_Utils_Array
::value('billing_middle_name', $this->_params
) . ' ' . CRM_Utils_Array
::value('billing_last_name', $this->_params
);
777 $this->_params
["address_name-{$this->_bltID}"] = trim($this->_params
["address_name-{$this->_bltID}"]);
779 $fields["address_name-{$this->_bltID}"] = 1;
780 $fields["email-{$this->_bltID}"] = 1;
782 list($hasBillingField, $addressParams) = CRM_Contribute_BAO_Contribution
::getPaymentProcessorReadyAddressParams($this->_params
, $this->_bltID
);
784 $addressParams['preserveDBName'] = TRUE;
785 if ($hasBillingField) {
786 $addressParams = array_merge($this->_params
, $addressParams);
787 //here we are setting up the billing contact - if different from the member they are already created
788 // but they will get billing details assigned
789 CRM_Contact_BAO_Contact
::createProfileContact($addressParams, $fields,
790 $this->_contributorContactID
, NULL, NULL,
791 CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $this->_contactID
, 'contact_type')