CRM/Member/Form/MembershipRenewal.php

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