CRM/Member/Form/MembershipRenewal.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.5                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   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  +--------------------------------------------------------------------+
  26 */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2014
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * This class generates form components for Membership Renewal
  38  *
  39  */
  40 class CRM_Member_Form_MembershipRenewal extends CRM_Member_Form {
  41   /*
  42    * Display name of the member
  43    */
  44   protected $_memberDisplayName = null;
  45   /*
  46   * email of the person paying for the membership (used for receipts)
  47   */
  48   protected $_memberEmail = null;
  49   /*
  50   * Contact ID of the member
  51   */
  52   protected $_contactID = null;
  53   /*
  54   * Display name of the person paying for the membership (used for receipts)
  55   */
  56   protected $_contributorDisplayName = null;
  57  /*
  58   * email of the person paying for the membership (used for receipts)
  59   */
  60   protected $_contributorEmail = null;
  61   /*
  62   * email of the person paying for the membership (used for receipts)
  63   */
  64   protected $_contributorContactID = null;
  65  /*
  66   * ID of the person the receipt is to go to
  67   */
  68   protected $_receiptContactId = null;
  69   /*
  70    * context would be set to standalone if the contact is use is being selected from
  71    * the form rather than in the URL
  72    */
  73   protected $_context;
  74
  75   /**
  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
  78    *
  79    * @var array
  80    */
  81   protected $_dateFields = array(
  82     'receive_date' => array('default' => 'now'),
  83   );
  84
  85   public function preProcess() {
  86     //custom data related code
  87     $this->_cdType = CRM_Utils_Array::value('type', $_GET);
  88     $this->assign('cdType', FALSE);
  89     if ($this->_cdType) {
  90       $this->assign('cdType', TRUE);
  91       return CRM_Custom_Form_CustomData::preProcess($this);
  92     }
  93
  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'));
  97     }
  98     // action
  99     $this->_action = CRM_Utils_Request::retrieve('action', 'String',
 100       $this, FALSE, 'add'
 101     );
 102     $this->_context = CRM_Utils_Request::retrieve('context', 'String',
 103       $this, FALSE, 'membership'
 104     );
 105     $this->_id = CRM_Utils_Request::retrieve('id', 'Positive',
 106       $this
 107     );
 108     $this->_contactID = CRM_Utils_Request::retrieve('cid', 'Positive',
 109       $this
 110     );
 111     if ($this->_id) {
 112       $this->_memType = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_Membership', $this->_id, 'membership_type_id');
 113     }
 114
 115     $this->assign('endDate', CRM_Utils_Date::customFormat(CRM_Core_DAO::getFieldValue('CRM_Member_DAO_Membership',
 116           $this->_id, 'end_date'
 117         )
 118       ));
 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'
 123         ),
 124         'name'
 125       )
 126     );
 127
 128     //using credit card :: CRM-2759
 129     $this->_mode = CRM_Utils_Request::retrieve('mode', 'String', $this);
 130     if ($this->_mode) {
 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"
 137           ));
 138       }
 139       $this->assign('membershipMode', $this->_mode);
 140
 141       $this->_paymentProcessor = array('billing_mode' => 1);
 142       $validProcessors = array();
 143       $processors = CRM_Core_PseudoConstant::paymentProcessor(FALSE, FALSE, 'billing_mode IN ( 1, 3 )');
 144
 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']) {
 148           continue;
 149         }
 150         elseif ($paymentProcessor['payment_processor_type'] == 'Dummy' && $this->_mode == 'live') {
 151           continue;
 152         }
 153         else {
 154           $paymentObject = CRM_Core_Payment::singleton($this->_mode, $paymentProcessor, $this);
 155           $error = $paymentObject->checkConfig();
 156           if (empty($error)) {
 157             $validProcessors[$ppID] = $label;
 158           }
 159           $paymentObject = NULL;
 160         }
 161       }
 162       if (empty($validProcessors)) {
 163         CRM_Core_Error::fatal(ts('Could not find valid payment processor for this page'));
 164       }
 165       else {
 166         $this->_processors = $validProcessors;
 167       }
 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')));
 176       }
 177       $this->set('bltID', $this->_bltID);
 178       $this->assign('bltID', $this->_bltID);
 179
 180       $this->_fields = array();
 181
 182       CRM_Core_Payment_Form::setCreditCardFields($this);
 183
 184       // this required to show billing block
 185       $this->assign_by_ref('paymentProcessor', $paymentProcessor);
 186       $this->assign('hidePayPalExpress', TRUE);
 187     }
 188     else {
 189       $this->assign('membershipMode', FALSE);
 190     }
 191
 192     // when custom data is included in this page
 193     if (!empty($_POST['hidden_custom'])) {
 194       CRM_Custom_Form_CustomData::preProcess($this);
 195       CRM_Custom_Form_CustomData::buildQuickForm($this);
 196       CRM_Custom_Form_CustomData::setDefaultValues($this);
 197     }
 198
 199     $this->_fromEmails = CRM_Core_BAO_Email::getFromEmail();
 200
 201     CRM_Utils_System::setTitle(ts('Renew Membership'));
 202
 203     parent::preProcess();
 204   }
 205
 206   /**
 207    * This function sets the default values for the form.
 208    * the default values are retrieved from the database
 209    *
 210    * @access public
 211    *
 212    * @return void
 213    */
 214   public function setDefaultValues() {
 215     if ($this->_cdType) {
 216       return CRM_Custom_Form_CustomData::setDefaultValues($this);
 217     }
 218     $defaults       = array();
 219     $defaults       = parent::setDefaultValues();
 220     $this->_memType = $defaults['membership_type_id'];
 221
 222     // set renewal_date and receive_date to today in correct input format (setDateDefaults uses today if no value passed)
 223     list($now, $currentTime) = CRM_Utils_Date::setDateDefaults();
 224     $defaults['renewal_date'] = $now;
 225     $defaults['receive_date'] = $now;
 226     $defaults['receive_date_time'] = $currentTime;
 227
 228     if ($defaults['id']) {
 229       $defaults['record_contribution'] = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipPayment',
 230         $defaults['id'],
 231         'contribution_id',
 232         'membership_id'
 233       );
 234     }
 235
 236     if (is_numeric($this->_memType)) {
 237       $defaults['membership_type_id'] = array();
 238       $defaults['membership_type_id'][0] = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipType',
 239         $this->_memType,
 240         'member_of_contact_id',
 241         'id'
 242       );
 243       $defaults['membership_type_id'][1] = $this->_memType;
 244     }
 245     else {
 246       $defaults['membership_type_id'] = $this->_memType;
 247     }
 248
 249     $defaults['financial_type_id'] = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipType', $this->_memType, 'financial_type_id');
 250
 251     //CRM-13420
 252     if (empty($defaults['payment_instrument_id'])) {
 253       $defaults['payment_instrument_id'] = key(CRM_Core_OptionGroup::values('payment_instrument', FALSE, FALSE, FALSE, 'AND is_default = 1'));
 254     }
 255
 256     $defaults['total_amount'] = CRM_Utils_Money::format(CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipType',
 257         $this->_memType,
 258         'minimum_fee'
 259       ), NULL, '%a');
 260
 261
 262     $defaults['record_contribution'] = 0;
 263     $defaults['num_terms'] = 1;
 264     $defaults['send_receipt'] = 0;
 265
 266     //set Soft Credit Type to Gift by default
 267     $scTypes = CRM_Core_OptionGroup::values("soft_credit_type");
 268     $defaults['soft_credit_type_id'] = CRM_Utils_Array::value(ts('Gift'), array_flip($scTypes));
 269
 270     $renewalDate = CRM_Utils_Date::processDate(CRM_Utils_Array::value('renewal_date', $defaults),
 271       NULL, NULL, 'Y-m-d'
 272     );
 273     $this->assign('renewalDate', $renewalDate);
 274     $this->assign('member_is_test', CRM_Utils_Array::value('member_is_test', $defaults));
 275
 276     if ($this->_mode) {
 277       $fields = array();
 278
 279       foreach ($this->_fields as $name => $dontCare) {
 280         $fields[$name] = 1;
 281       }
 282
 283       $names = array(
 284         'first_name', 'middle_name', 'last_name', "street_address-{$this->_bltID}",
 285         "city-{$this->_bltID}", "postal_code-{$this->_bltID}", "country_id-{$this->_bltID}",
 286         "state_province_id-{$this->_bltID}",
 287       );
 288       foreach ($names as $name) {
 289         $fields[$name] = 1;
 290       }
 291
 292       $fields["state_province-{$this->_bltID}"] = 1;
 293       $fields["country-{$this->_bltID}"] = 1;
 294       $fields["email-{$this->_bltID}"] = 1;
 295       $fields['email-Primary'] = 1;
 296
 297       CRM_Core_BAO_UFGroup::setProfileDefaults($this->_contactID, $fields, $this->_defaults);
 298
 299       // use primary email address if billing email address is empty
 300       if (empty($this->_defaults["email-{$this->_bltID}"]) &&
 301         !empty($this->_defaults['email-Primary'])
 302       ) {
 303         $defaults["email-{$this->_bltID}"] = $this->_defaults['email-Primary'];
 304       }
 305
 306       foreach ($names as $name) {
 307         if (!empty($this->_defaults[$name])) {
 308           $defaults['billing_' . $name] = $this->_defaults[$name];
 309         }
 310       }
 311     }
 312
 313     return $defaults;
 314   }
 315
 316   /**
 317    * Function to build the form
 318    *
 319    * @return void
 320    * @access public
 321    */
 322   public function buildQuickForm() {
 323     if ($this->_cdType) {
 324       return CRM_Custom_Form_CustomData::buildQuickForm($this);
 325     }
 326
 327     parent::buildQuickForm();
 328
 329     $defaults       = array();
 330     $defaults       = parent::setDefaultValues();
 331     $this->_memType = $defaults['membership_type_id'];
 332     $this->assign('customDataType', 'Membership');
 333     $this->assign('customDataSubType', $this->_memType);
 334     $this->assign('entityID', $this->_id);
 335     $selOrgMemType[0][0] = $selMemTypeOrg[0] = ts('- select -');
 336
 337     $allMemberships = CRM_Member_BAO_Membership::buildMembershipTypeValues($this);
 338
 339     $allMembershipInfo = $membershipType = array();
 340
 341     // auto renew options if enabled for the membership
 342     $options = array(ts('No auto-renew option'), ts('Give option, but not required'), ts('Auto-renew required '));
 343
 344     foreach( $allMemberships as $key => $values ) {
 345       if (!empty($values['is_active'])) {
 346         $membershipType[$key] = CRM_Utils_Array::value('name', $values);
 347         if ($this->_mode && empty($values['minimum_fee'])) {
 348           continue;
 349         }
 350         else {
 351           $memberOfContactId = CRM_Utils_Array::value('member_of_contact_id', $values);
 352           if (empty($selMemTypeOrg[$memberOfContactId])) {
 353             $selMemTypeOrg[$memberOfContactId] = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact',
 354               $memberOfContactId,
 355               'display_name',
 356               'id'
 357             );
 358
 359             $selOrgMemType[$memberOfContactId][0] = ts('- select -');
 360           }
 361           if (empty($selOrgMemType[$memberOfContactId][$key])) {
 362             $selOrgMemType[$memberOfContactId][$key] = CRM_Utils_Array::value('name', $values);
 363           }
 364         }
 365
 366         // build membership info array, which is used to set the payment information block when
 367         // membership type is selected.
 368         $allMembershipInfo[$key] = array(
 369           'financial_type_id' => CRM_Utils_Array::value('financial_type_id', $values),
 370           'total_amount'         => CRM_Utils_Money::format($values['minimum_fee'], NULL, '%a'),
 371           'total_amount_numeric' => CRM_Utils_Array::value('minimum_fee', $values)
 372         );
 373
 374         if (!empty($values['auto_renew'])) {
 375           $allMembershipInfo[$key]['auto_renew'] = $options[$values['auto_renew']];
 376       }
 377     }
 378     }
 379
 380     $this->assign('allMembershipInfo', json_encode($allMembershipInfo));
 381
 382     if ($this->_memType) {
 383       $this->assign('orgName', $selMemTypeOrg[$allMemberships[$this->_memType]['member_of_contact_id']]);
 384       $this->assign('memType', $allMemberships[$this->_memType]['name']);
 385     }
 386
 387     // force select of organization by default, if only one organization in
 388     // the list
 389     if (count($selMemTypeOrg) == 2) {
 390       unset($selMemTypeOrg[0], $selOrgMemType[0][0]);
 391     }
 392     //sort membership organization and type, CRM-6099
 393     natcasesort($selMemTypeOrg);
 394     foreach ($selOrgMemType as $index => $orgMembershipType) {
 395       natcasesort($orgMembershipType);
 396       $selOrgMemType[$index] = $orgMembershipType;
 397     }
 398
 399     $js = array('onChange' => "setPaymentBlock( ); CRM.buildCustomData( 'Membership', this.value );");
 400
 401     //build the form for auto renew.
 402     $recurProcessor = array();
 403     if ($this->_mode || ($this->_action & CRM_Core_Action::UPDATE)) {
 404       //get the valid recurring processors.
 405       $recurring = CRM_Core_PseudoConstant::paymentProcessor(FALSE, FALSE, 'is_recur = 1');
 406       $recurProcessor = array_intersect_assoc($this->_processors, $recurring);
 407       if (!empty($recurProcessor)) {
 408         $autoRenew = array();
 409         if (!empty($membershipType)) {
 410           $sql = '
 411 SELECT  id,
 412         auto_renew,
 413         duration_unit,
 414         duration_interval
 415  FROM   civicrm_membership_type
 416 WHERE   id IN ( ' . implode(' , ', array_keys($membershipType)) . ' )';
 417           $recurMembershipTypes = CRM_Core_DAO::executeQuery($sql);
 418           while ($recurMembershipTypes->fetch()) {
 419             $autoRenew[$recurMembershipTypes->id] = $recurMembershipTypes->auto_renew;
 420             foreach (array(
 421               'id', 'auto_renew', 'duration_unit', 'duration_interval') as $fld) {
 422               $this->_recurMembershipTypes[$recurMembershipTypes->id][$fld] = $recurMembershipTypes->$fld;
 423             }
 424           }
 425         }
 426         $js = array('onChange' => "setPaymentBlock(); CRM.buildCustomData( 'Membership', this.value );");
 427         $this->assign('autoRenew', json_encode($autoRenew));
 428       }
 429       $autoRenewElement = $this->addElement('checkbox', 'auto_renew', ts('Membership renewed automatically'),
 430         NULL, array('onclick' => "showHideByValue('auto_renew','','send-receipt','table-row','radio',true); showHideNotice( );")
 431       );
 432       if ($this->_action & CRM_Core_Action::UPDATE) {
 433         $autoRenewElement->freeze();
 434       }
 435     }
 436     $this->assign('recurProcessor', json_encode($recurProcessor));
 437
 438     $sel = &$this->addElement('hierselect',
 439       'membership_type_id',
 440       ts('Renewal Membership Organization and Type'), $js
 441     );
 442
 443     $sel->setOptions(array($selMemTypeOrg, $selOrgMemType));
 444     $elements = array();
 445     if ($sel) {
 446       $elements[] = $sel;
 447     }
 448
 449     $this->applyFilter('__ALL__', 'trim');
 450
 451     $this->addDate('renewal_date', ts('Date Renewal Entered'), FALSE, array('formatType' => 'activityDate'));
 452
 453     $this->add('select', 'financial_type_id', ts('Financial Type'),
 454       array('' => ts('- select -')) + CRM_Contribute_PseudoConstant::financialType()
 455     );
 456     if (CRM_Core_Permission::access('CiviContribute') && !$this->_mode) {
 457       $this->addElement('checkbox', 'record_contribution', ts('Record Renewal Payment?'), NULL, array('onclick' => "checkPayment();"));
 458
 459       $this->add('text', 'total_amount', ts('Amount'));
 460       $this->addRule('total_amount', ts('Please enter a valid amount.'), 'money');
 461
 462       $this->addDate('receive_date', ts('Received'), FALSE, array('formatType' => 'activityDateTime'));
 463
 464       $this->add('text', 'num_terms', ts('Extend Membership by'), array('onchange' => "setPaymentBlock();"), TRUE);
 465       $this->addRule('num_terms', ts('Please enter a whole number for how many periods to renew.'), 'integer');
 466
 467       $this->add('select', 'payment_instrument_id', ts('Paid By'),
 468         array('' => ts('- select -')) + CRM_Contribute_PseudoConstant::paymentInstrument(),
 469         FALSE, array('onChange' => "return showHideByValue('payment_instrument_id','4','checkNumber','table-row','select',false);")
 470       );
 471
 472       $this->add('text', 'trxn_id', ts('Transaction ID'));
 473       $this->addRule('trxn_id', ts('Transaction ID already exists in Database.'),
 474         'objectExists', array('CRM_Contribute_DAO_Contribution', $this->_id, 'trxn_id')
 475       );
 476
 477       $this->add('select', 'contribution_status_id', ts('Payment Status'),
 478         CRM_Contribute_PseudoConstant::contributionStatus()
 479       );
 480
 481       $this->add('text', 'check_number', ts('Check Number'),
 482         CRM_Core_DAO::getAttribute('CRM_Contribute_DAO_Contribution', 'check_number')
 483       );
 484     }
 485     else {
 486       $this->add('text', 'total_amount', ts('Amount'));
 487       $this->addRule('total_amount', ts('Please enter a valid amount.'), 'money');
 488     }
 489     $this->addElement('checkbox', 'send_receipt', ts('Send Confirmation and Receipt?'), NULL,
 490       array('onclick' => "showHideByValue( 'send_receipt', '', 'notice', 'table-row', 'radio', false ); showHideByValue( 'send_receipt', '', 'fromEmail', 'table-row', 'radio',false);")
 491     );
 492
 493     $this->add('select', 'from_email_address', ts('Receipt From'), $this->_fromEmails);
 494
 495     $this->add('textarea', 'receipt_text_renewal', ts('Renewal Message'));
 496
 497     if ($this->_mode) {
 498       $this->add('select', 'payment_processor_id', ts('Payment Processor'), $this->_processors, TRUE);
 499       CRM_Core_Payment_Form::buildCreditCard($this, TRUE);
 500     }
 501
 502     // Retrieve the name and email of the contact - this will be the TO for receipt email
 503     list($this->_contributorDisplayName,
 504       $this->_contributorEmail
 505     ) = CRM_Contact_BAO_Contact_Location::getEmailDetails($this->_contactID);
 506     $this->assign('email', $this->_contributorEmail);
 507
 508     $mailingInfo = CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::MAILING_PREFERENCES_NAME,
 509       'mailing_backend'
 510     );
 511     $this->assign('outBound_option', $mailingInfo['outBound_option']);
 512
 513     if (CRM_Core_DAO::getFieldValue('CRM_Member_DAO_Membership', $this->_id, 'contribution_recur_id')) {
 514       if (CRM_Member_BAO_Membership::isCancelSubscriptionSupported($this->_id)) {
 515         $this->assign('cancelAutoRenew',
 516           CRM_Utils_System::url('civicrm/contribute/unsubscribe', "reset=1&mid={$this->_id}")
 517         );
 518       }
 519     }
 520     $this->addFormRule(array('CRM_Member_Form_MembershipRenewal', 'formRule'));
 521     if ($this->_context != 'standalone') {
 522       //CRM-10223 - allow contribution to be recorded against different contact
 523       // causes a conflict in standalone mode so skip in standalone for now
 524       $this->addElement('checkbox', 'contribution_contact', ts('Record Payment from a Different Contact?'));
 525       $this->addSelect('soft_credit_type_id', array('entity' => 'contribution_soft'));
 526       $this->addEntityRef('soft_credit_contact_id', ts('Payment From'), array('create' => TRUE));
 527   }
 528     }
 529
 530   /**
 531    * Function for validation
 532    *
 533    * @param array $params (ref.) an assoc array of name/value pairs
 534    *
 535    * @return mixed true or array of errors
 536    * @access public
 537    * @static
 538    */
 539   static function formRule($params) {
 540     $errors = array();
 541     if ($params['membership_type_id'][0] == 0) {
 542       $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.');
 543     }
 544     if ($params['membership_type_id'][1] == 0) {
 545       $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.');
 546     }
 547
 548     //total amount condition arise when membership type having no
 549     //minimum fee
 550     if (isset($params['record_contribution'])) {
 551       if (!$params['financial_type_id']) {
 552         $errors['financial_type_id'] = ts('Please select a Financial Type.');
 553       }
 554       if (!$params['total_amount']) {
 555         $errors['total_amount'] = ts('Please enter a Contribution Amount.');
 556       }
 557       if (empty($params['payment_instrument_id'])) {
 558         $errors['payment_instrument_id'] = ts('Paid By is a required field.');
 559       }
 560     }
 561     return empty($errors) ? TRUE : $errors;
 562   }
 563
 564   /**
 565    * Function to process the renewal form
 566    *
 567    * @access public
 568    *
 569    * @return void
 570    */
 571   public function postProcess() {
 572
 573     $ids = array();
 574     $config = CRM_Core_Config::singleton();
 575
 576     // get the submitted form values.
 577     $this->_params = $formValues = $this->controller->exportValues($this->_name);
 578
 579     $this->storeContactFields($formValues);
 580     // use values from screen
 581
 582     if ($formValues['membership_type_id'][1] <> 0) {
 583       $defaults['receipt_text_renewal'] = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipType',
 584         $formValues['membership_type_id'][1],
 585         'receipt_text_renewal'
 586       );
 587     }
 588
 589     $now = CRM_Utils_Date::getToday( null, 'YmdHis');
 590     $this->convertDateFieldsToMySQL($formValues);
 591     $this->assign('receive_date', $formValues['receive_date']);
 592
 593     if (!empty($this->_params['send_receipt'])) {
 594       $formValues['receipt_date'] = $now;
 595       $this->assign('receipt_date', CRM_Utils_Date::mysqlToIso($formValues['receipt_date']));
 596     }
 597     else {
 598       $formValues['receipt_date'] = NULL;
 599     }
 600
 601     if ($this->_mode) {
 602       $formValues['total_amount'] = CRM_Utils_Array::value('total_amount', $this->_params, CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipType',
 603           $this->_memType, 'minimum_fee'
 604         ));
 605       if (empty($formValues['financial_type_id'])) {
 606         $formValues['financial_type_id'] = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipType', $this->_memType,'financial_type_id');
 607       }
 608
 609       $this->_paymentProcessor = CRM_Financial_BAO_PaymentProcessor::getPayment($formValues['payment_processor_id'],
 610         $this->_mode
 611       );
 612
 613       $fields = array();
 614
 615       // set email for primary location.
 616       $fields['email-Primary'] = 1;
 617       $formValues['email-5'] = $formValues['email-Primary'] = $this->_contributorEmail;
 618       $formValues['register_date'] = $now;
 619
 620       // now set the values for the billing location.
 621       foreach ($this->_fields as $name => $dontCare) {
 622         $fields[$name] = 1;
 623       }
 624
 625       // also add location name to the array
 626       $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);
 627
 628       $formValues["address_name-{$this->_bltID}"] = trim($formValues["address_name-{$this->_bltID}"]);
 629
 630       $fields["address_name-{$this->_bltID}"] = 1;
 631
 632       $fields["email-{$this->_bltID}"] = 1;
 633
 634       $ctype = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $this->_contactID, 'contact_type');
 635
 636       $nameFields = array('first_name', 'middle_name', 'last_name');
 637
 638       foreach ($nameFields as $name) {
 639         $fields[$name] = 1;
 640         if (array_key_exists("billing_$name", $formValues)) {
 641           $formValues[$name] = $formValues["billing_{$name}"];
 642           $formValues['preserveDBName'] = TRUE;
 643         }
 644       }
 645
 646       //here we are setting up the billing contact - if different from the member they are already created
 647       // but they will get billing details assigned
 648       CRM_Contact_BAO_Contact::createProfileContact($formValues, $fields,
 649         $this->_contributorContactID, NULL, NULL, $ctype
 650       );
 651
 652       // add all the additional payment params we need
 653       $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}"]);
 654       $this->_params["country-{$this->_bltID}"] = $this->_params["billing_country-{$this->_bltID}"] = CRM_Core_PseudoConstant::countryIsoCode($this->_params["billing_country_id-{$this->_bltID}"]);
 655
 656       $this->_params['year'] = CRM_Core_Payment_Form::getCreditCardExpirationYear($this->_params);
 657       $this->_params['month'] = CRM_Core_Payment_Form::getCreditCardExpirationMonth($this->_params);
 658       $this->_params['ip_address'] = CRM_Utils_System::ipAddress();
 659       $this->_params['amount'] = $formValues['total_amount'];
 660       $this->_params['currencyID'] = $config->defaultCurrency;
 661       $this->_params['payment_action'] = 'Sale';
 662       $this->_params['invoiceID'] = md5(uniqid(rand(), TRUE));
 663
 664       // at this point we've created a contact and stored its address etc
 665       // all the payment processors expect the name and address to be in the passed params
 666       // so we copy stuff over to first_name etc.
 667       $paymentParams = $this->_params;
 668       if (!empty($this->_params['send_receipt'])) {
 669         $paymentParams['email'] = $this->_contributorEmail;
 670       }
 671
 672       $paymentParams['contactID'] = $this->_contributorContactID;
 673
 674       CRM_Core_Payment_Form::mapParams($this->_bltID, $this->_params, $paymentParams, TRUE);
 675
 676       $payment = CRM_Core_Payment::singleton($this->_mode, $this->_paymentProcessor, $this);
 677
 678       $result = &$payment->doDirectPayment($paymentParams);
 679
 680       if (is_a($result, 'CRM_Core_Error')) {
 681         CRM_Core_Error::displaySessionError($result);
 682         CRM_Utils_System::redirect(CRM_Utils_System::url('civicrm/contact/view/membership',
 683             "reset=1&action=renew&cid={$this->_contactID}&id={$this->_id}&context=membership&mode={$this->_mode}"
 684           ));
 685       }
 686
 687       if ($result) {
 688         $this->_params = array_merge($this->_params, $result);
 689       }
 690       $formValues['contribution_status_id'] = 1;
 691       $formValues['invoice_id'] = $this->_params['invoiceID'];
 692       $formValues['trxn_id'] = $result['trxn_id'];
 693       $formValues['payment_instrument_id'] = 1;
 694       $formValues['is_test'] = ($this->_mode == 'live') ? 0 : 1;
 695       $this->set('params', $this->_params);
 696       $this->assign('trxn_id', $result['trxn_id']);
 697     }
 698
 699     $renewalDate = NULL;
 700
 701     if ($formValues['renewal_date']) {
 702       $this->set('renewalDate', CRM_Utils_Date::processDate($formValues['renewal_date']));
 703     }
 704     $this->_membershipId = $this->_id;
 705
 706     // membership type custom data
 707     $customFields = CRM_Core_BAO_CustomField::getFields('Membership', FALSE, FALSE,
 708       $formValues['membership_type_id'][1]
 709     );
 710
 711     $customFields = CRM_Utils_Array::crmArrayMerge($customFields,
 712       CRM_Core_BAO_CustomField::getFields('Membership',
 713         FALSE, FALSE,
 714         NULL, NULL, TRUE
 715       )
 716     );
 717
 718     $customFieldsFormatted = CRM_Core_BAO_CustomField::postProcess($formValues,
 719       $customFields,
 720       $this->_id,
 721       'Membership'
 722     );
 723
 724     // check for test membership.
 725     $isTestMembership = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_Membership', $this->_membershipId, 'is_test');
 726
 727     // chk for renewal for multiple terms CRM-8750
 728     $numRenewTerms = 1;
 729     if (is_numeric(CRM_Utils_Array::value('num_terms', $formValues))) {
 730       $numRenewTerms = $formValues['num_terms'];
 731     }
 732
 733     //if contribution status is pending then set pay later
 734     if ($formValues['contribution_status_id'] == array_search('Pending', CRM_Contribute_PseudoConstant::contributionStatus())) {
 735       $this->_params['is_pay_later'] = 1;
 736     }
 737     $renewMembership = CRM_Member_BAO_Membership::renewMembershipFormWrapper($this->_contactID,
 738       $formValues['membership_type_id'][1],
 739       $isTestMembership, $this, NULL, NULL,
 740       $customFieldsFormatted, $numRenewTerms,
 741       $this->_membershipId
 742     );
 743
 744     $endDate = CRM_Utils_Date::processDate($renewMembership->end_date);
 745
 746     // Retrieve the name and email of the current user - this will be the FROM for the receipt email
 747     $session = CRM_Core_Session::singleton();
 748     $userID = $session->get('userID');
 749
 750     list($userName, $userEmail) = CRM_Contact_BAO_Contact_Location::getEmailDetails($userID);
 751
 752     $memType = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipType', $renewMembership->membership_type_id, 'name');
 753
 754     if (!empty($formValues['record_contribution']) || $this->_mode) {
 755       // set the source
 756       $formValues['contribution_source'] = "{$memType} Membership: Offline membership renewal (by {$userName})";
 757
 758       //create line items
 759       $lineItem = array();
 760       $priceSetId = null;
 761       CRM_Member_BAO_Membership::createLineItems($this, $formValues['membership_type_id'], $priceSetId);
 762       CRM_Price_BAO_PriceSet::processAmount($this->_priceSet['fields'],
 763         $this->_params, $lineItem[$priceSetId]
 764       );
 765       //CRM-11529 for quick config backoffice transactions
 766       //when financial_type_id is passed in form, update the
 767       //lineitems with the financial type selected in form
 768       if ($submittedFinancialType = CRM_Utils_Array::value('financial_type_id', $formValues)) {
 769         foreach ($lineItem[$priceSetId] as &$li) {
 770           $li['financial_type_id'] = $submittedFinancialType;
 771         }
 772       }
 773       $formValues['total_amount'] = CRM_Utils_Array::value('amount', $this->_params);
 774       if (!empty($lineItem)) {
 775         $formValues['lineItems'] = $lineItem;
 776         $formValues['processPriceSet'] = TRUE;
 777       }
 778
 779       //assign contribution contact id to the field expected by recordMembershipContribution
 780       if($this->_contributorContactID != $this->_contactID){
 781         $formValues['contribution_contact_id'] = $this->_contributorContactID;
 782         if (!empty($this->_params['soft_credit_type_id'])){
 783           $formValues['soft_credit'] = array(
 784             'soft_credit_type_id' => $this->_params['soft_credit_type_id'],
 785             'contact_id' => $this->_contactID,
 786           );
 787         }
 788       }
 789       $formValues['contact_id'] = $this->_contactID;
 790
 791       CRM_Member_BAO_Membership::recordMembershipContribution(array_merge($formValues, array('membership_id' => $renewMembership->id)));
 792     }
 793
 794     $receiptSend = FALSE;
 795     if (!empty($formValues['send_receipt'])) {
 796       $receiptSend = TRUE;
 797
 798       $receiptFrom = $formValues['from_email_address'];
 799
 800       if (!empty($formValues['payment_instrument_id'])) {
 801         $paymentInstrument = CRM_Contribute_PseudoConstant::paymentInstrument();
 802         $formValues['paidBy'] = $paymentInstrument[$formValues['payment_instrument_id']];
 803       }
 804       //get the group Tree
 805       $this->_groupTree = CRM_Core_BAO_CustomGroup::getTree('Membership', $this, $this->_id, FALSE, $this->_memType);
 806
 807       // retrieve custom data
 808       $customFields = $customValues = $fo = array();
 809       foreach ($this->_groupTree as $groupID => $group) {
 810         if ($groupID == 'info') {
 811           continue;
 812         }
 813         foreach ($group['fields'] as $k => $field) {
 814           $field['title'] = $field['label'];
 815           $customFields["custom_{$k}"] = $field;
 816         }
 817       }
 818       $members = array(array('member_id', '=', $this->_membershipId, 0, 0));
 819       // check whether its a test drive
 820       if ($this->_mode == 'test') {
 821         $members[] = array('member_test', '=', 1, 0, 0);
 822       }
 823       CRM_Core_BAO_UFGroup::getValues($this->_contactID, $customFields, $customValues, FALSE, $members);
 824
 825       $this->assign_by_ref('formValues', $formValues);
 826       if (!empty($formValues['contribution_id'])) {
 827         $this->assign('contributionID', $formValues['contribution_id']);
 828       }
 829       $this->assign('membershipID', $this->_id);
 830       $this->assign('contactID', $this->_contactID);
 831       $this->assign('module', 'Membership');
 832       $this->assign('receiptType', 'membership renewal');
 833       $this->assign('mem_start_date', CRM_Utils_Date::customFormat($renewMembership->start_date));
 834       $this->assign('mem_end_date', CRM_Utils_Date::customFormat($renewMembership->end_date));
 835       $this->assign('membership_name', CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipType',
 836           $renewMembership->membership_type_id
 837         ));
 838       $this->assign('customValues', $customValues);
 839       if ($this->_mode) {
 840         if (!empty($this->_params['billing_first_name'])) {
 841           $name = $this->_params['billing_first_name'];
 842         }
 843
 844         if (!empty($this->_params['billing_middle_name'])) {
 845           $name .= " {$this->_params['billing_middle_name']}";
 846         }
 847
 848         if (!empty($this->_params['billing_last_name'])) {
 849           $name .= " {$this->_params['billing_last_name']}";
 850         }
 851         $this->assign('billingName', $name);
 852
 853         // assign the address formatted up for display
 854         $addressParts = array(
 855           "street_address-{$this->_bltID}",
 856           "city-{$this->_bltID}",
 857           "postal_code-{$this->_bltID}",
 858           "state_province-{$this->_bltID}",
 859           "country-{$this->_bltID}",
 860         );
 861         $addressFields = array();
 862         foreach ($addressParts as $part) {
 863           list($n, $id) = explode('-', $part);
 864           if (isset($this->_params['billing_' . $part])) {
 865             $addressFields[$n] = $this->_params['billing_' . $part];
 866           }
 867         }
 868         $this->assign('address', CRM_Utils_Address::format($addressFields));
 869         $date = CRM_Utils_Date::format($this->_params['credit_card_exp_date']);
 870         $date = CRM_Utils_Date::mysqlToIso($date);
 871         $this->assign('credit_card_exp_date', $date);
 872         $this->assign('credit_card_number',
 873           CRM_Utils_System::mungeCreditCard($this->_params['credit_card_number'])
 874         );
 875         $this->assign('credit_card_type', $this->_params['credit_card_type']);
 876         $this->assign('contributeMode', 'direct');
 877         $this->assign('isAmountzero', 0);
 878         $this->assign('is_pay_later', 0);
 879         $this->assign('isPrimary', 1);
 880         if ($this->_mode == 'test') {
 881           $this->assign('action', '1024');
 882         }
 883       }
 884
 885       list($mailSend, $subject, $message, $html) = CRM_Core_BAO_MessageTemplate::sendTemplate(
 886         array(
 887           'groupName' => 'msg_tpl_workflow_membership',
 888           'valueName' => 'membership_offline_receipt',
 889           'contactId' => $this->_receiptContactId,
 890           'from' => $receiptFrom,
 891           'toName' => $this->_contributorDisplayName,
 892           'toEmail' => $this->_contributorEmail,
 893           'isTest' => $this->_mode == 'test',
 894         )
 895       );
 896     }
 897
 898     $statusMsg = ts('%1 membership for %2 has been renewed.', array(1 => $memType, 2 => $this->_memberDisplayName));
 899
 900     if ($endDate) {
 901       $statusMsg .= ' ' . ts('The new membership End Date is %1.', array(1 => CRM_Utils_Date::customFormat(substr($endDate,0,8))));
 902     }
 903
 904     if ($receiptSend && $mailSend) {
 905       $statusMsg .= ' ' . ts('A renewal confirmation and receipt has been sent to %1.', array(1 => $this->_contributorEmail));
 906     }
 907
 908     CRM_Core_Session::setStatus($statusMsg, ts('Complete'), 'success');
 909   }
 910 }
 911