CRM/Member/Form/Membership.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2018                                |
   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-2018
  32  */
  33
  34 /**
  35  * This class generates form components for offline membership form.
  36  */
  37 class CRM_Member_Form_Membership extends CRM_Member_Form {
  38
  39   protected $_memType = NULL;
  40
  41   protected $_onlinePendingContributionId;
  42
  43   public $_mode;
  44
  45   public $_contributeMode = 'direct';
  46
  47   protected $_recurMembershipTypes;
  48
  49   protected $_memTypeSelected;
  50
  51   /**
  52    * Display name of the member.
  53    *
  54    * @var string
  55    */
  56   protected $_memberDisplayName = NULL;
  57
  58   /**
  59    * email of the person paying for the membership (used for receipts)
  60    */
  61   protected $_memberEmail = NULL;
  62
  63   /**
  64    * Contact ID of the member.
  65    *
  66    * @var int
  67    */
  68   public $_contactID = NULL;
  69
  70   /**
  71    * Display name of the person paying for the membership (used for receipts)
  72    *
  73    * @var string
  74    */
  75   protected $_contributorDisplayName = NULL;
  76
  77   /**
  78    * email of the person paying for the membership (used for receipts)
  79    */
  80   protected $_contributorEmail = NULL;
  81
  82   /**
  83    * email of the person paying for the membership (used for receipts)
  84    *
  85    * @var int
  86    */
  87   protected $_contributorContactID = NULL;
  88
  89   /**
  90    * ID of the person the receipt is to go to.
  91    *
  92    * @var int
  93    */
  94   protected $_receiptContactId = NULL;
  95
  96   /**
  97    * Keep a class variable for ALL membership IDs so
  98    * postProcess hook function can do something with it
  99    *
 100    * @var array
 101    */
 102   protected $_membershipIDs = array();
 103
 104   /**
 105    * An array to hold a list of date fields on the form
 106    * so that they can be converted to ISO in a consistent manner
 107    *
 108    * @var array
 109    */
 110   protected $_dateFields = array(
 111     'receive_date' => array('default' => 'now'),
 112   );
 113
 114   /**
 115    * Set entity fields to be assigned to the form.
 116    */
 117   protected function setEntityFields() {
 118     $this->entityFields = [
 119       'join_date' => [
 120         'name' => 'join_date',
 121         'description' => ts('Member Since'),
 122       ],
 123       'start_date' => [
 124         'name' => 'start_date',
 125         'description' => ts('Start Date'),
 126       ],
 127       'end_date' => [
 128         'name' => 'end_date',
 129         'description' => ts('End Date'),
 130       ],
 131     ];
 132   }
 133
 134   /**
 135    * Set the delete message.
 136    *
 137    * We do this from the constructor in order to do a translation.
 138    */
 139   public function setDeleteMessage() {
 140     $this->deleteMessage = '<span class="font-red bold">'
 141       . ts("WARNING: Deleting this membership will also delete any related payment (contribution) records." .  ts("This action cannot be undone.")
 142         . '</span><p>'
 143         . ts("Consider modifying the membership status instead if you want to maintain an audit trail and avoid losing payment data. You can set the status to Cancelled by editing the membership and clicking the Status Override checkbox.")
 144           . '</p><p>'
 145         . ts("Click 'Delete' if you want to continue.") . '</p>');
 146   }
 147
 148   /**
 149    * Overriding this entity trait function as not yet tested.
 150    *
 151    * We continue to rely on legacy handling.
 152    */
 153   public function addCustomDataToForm() {}
 154
 155
 156   /**
 157    * Overriding this entity trait function as not yet tested.
 158    *
 159    * We continue to rely on legacy handling.
 160    */
 161   public function addFormButtons() {}
 162
 163   /**
 164    * Get selected membership type from the form values.
 165    *
 166    * @param array $priceSet
 167    * @param array $params
 168    *
 169    * @return array
 170    */
 171   public static function getSelectedMemberships($priceSet, $params) {
 172     $memTypeSelected = array();
 173     $priceFieldIDS = self::getPriceFieldIDs($params, $priceSet);
 174     if (isset($params['membership_type_id']) && !empty($params['membership_type_id'][1])) {
 175       $memTypeSelected = array($params['membership_type_id'][1] => $params['membership_type_id'][1]);
 176     }
 177     else {
 178       foreach ($priceFieldIDS as $priceFieldId) {
 179         if ($id = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceFieldValue', $priceFieldId, 'membership_type_id')) {
 180           $memTypeSelected[$id] = $id;
 181         }
 182       }
 183     }
 184     return $memTypeSelected;
 185   }
 186
 187   /**
 188    * Extract price set fields and values from $params.
 189    *
 190    * @param array $params
 191    * @param array $priceSet
 192    *
 193    * @return array
 194    */
 195   public static function getPriceFieldIDs($params, $priceSet) {
 196     $priceFieldIDS = array();
 197     if (isset($priceSet['fields']) && is_array($priceSet['fields'])) {
 198       foreach ($priceSet['fields'] as $fieldId => $field) {
 199         if (!empty($params['price_' . $fieldId])) {
 200           if (is_array($params['price_' . $fieldId])) {
 201             foreach ($params['price_' . $fieldId] as $priceFldVal => $isSet) {
 202               if ($isSet) {
 203                 $priceFieldIDS[] = $priceFldVal;
 204               }
 205             }
 206           }
 207           elseif (!$field['is_enter_qty']) {
 208             $priceFieldIDS[] = $params['price_' . $fieldId];
 209           }
 210         }
 211       }
 212     }
 213     return $priceFieldIDS;
 214   }
 215
 216   /**
 217    * Form preProcess function.
 218    *
 219    * @throws \Exception
 220    */
 221   public function preProcess() {
 222     // This string makes up part of the class names, differentiating them (not sure why) from the membership fields.
 223     $this->assign('formClass', 'membership');
 224     parent::preProcess();
 225     if ($this->isUpdateToExistingRecurringMembership()) {
 226       $this->entityFields['end_date']['is_freeze'] = TRUE;
 227     }
 228     // get price set id.
 229     $this->_priceSetId = CRM_Utils_Array::value('priceSetId', $_GET);
 230     $this->set('priceSetId', $this->_priceSetId);
 231     $this->assign('priceSetId', $this->_priceSetId);
 232
 233     if ($this->_action & CRM_Core_Action::DELETE) {
 234       $contributionID = CRM_Member_BAO_Membership::getMembershipContributionId($this->_id);
 235       // check delete permission for contribution
 236       if ($this->_id && $contributionID && !CRM_Core_Permission::checkActionPermission('CiviContribute', $this->_action)) {
 237         CRM_Core_Error::fatal(ts("This Membership is linked to a contribution. You must have 'delete in CiviContribute' permission in order to delete this record."));
 238       }
 239     }
 240
 241     if ($this->_action & CRM_Core_Action::ADD) {
 242       if ($this->_contactID) {
 243         //check whether contact has a current membership so we can alert user that they may want to do a renewal instead
 244         $contactMemberships = array();
 245         $memParams = array('contact_id' => $this->_contactID);
 246         CRM_Member_BAO_Membership::getValues($memParams, $contactMemberships, TRUE);
 247         $cMemTypes = array();
 248         foreach ($contactMemberships as $mem) {
 249           $cMemTypes[] = $mem['membership_type_id'];
 250         }
 251         if (count($cMemTypes) > 0) {
 252           $memberorgs = CRM_Member_BAO_MembershipType::getMemberOfContactByMemTypes($cMemTypes);
 253           $mems_by_org = array();
 254           foreach ($contactMemberships as $mem) {
 255             $mem['member_of_contact_id'] = CRM_Utils_Array::value($mem['membership_type_id'], $memberorgs);
 256             if (!empty($mem['membership_end_date'])) {
 257               $mem['membership_end_date'] = CRM_Utils_Date::customformat($mem['membership_end_date']);
 258             }
 259             $mem['membership_type'] = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipType',
 260               $mem['membership_type_id'],
 261               'name', 'id'
 262             );
 263             $mem['membership_status'] = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipStatus',
 264               $mem['status_id'],
 265               'label', 'id'
 266             );
 267             $mem['renewUrl'] = CRM_Utils_System::url('civicrm/contact/view/membership',
 268               "reset=1&action=renew&cid={$this->_contactID}&id={$mem['id']}&context=membership&selectedChild=member"
 269               . ($this->_mode ? '&mode=live' : '')
 270             );
 271             $mem['membershipTab'] = CRM_Utils_System::url('civicrm/contact/view',
 272               "reset=1&force=1&cid={$this->_contactID}&selectedChild=member"
 273             );
 274             $mems_by_org[$mem['member_of_contact_id']] = $mem;
 275           }
 276           $this->assign('existingContactMemberships', $mems_by_org);
 277         }
 278       }
 279       else {
 280         // In standalone mode we don't have a contact id yet so lookup will be done client-side with this script:
 281         $resources = CRM_Core_Resources::singleton();
 282         $resources->addScriptFile('civicrm', 'templates/CRM/Member/Form/MembershipStandalone.js');
 283         $passthru = array(
 284           'typeorgs' => CRM_Member_BAO_MembershipType::getMembershipTypeOrganization(),
 285           'memtypes' => CRM_Core_PseudoConstant::get('CRM_Member_BAO_Membership', 'membership_type_id'),
 286           'statuses' => CRM_Core_PseudoConstant::get('CRM_Member_BAO_Membership', 'status_id'),
 287         );
 288         $resources->addSetting(array('existingMems' => $passthru));
 289       }
 290     }
 291
 292     if (!$this->_memType) {
 293       $params = CRM_Utils_Request::exportValues();
 294       if (!empty($params['membership_type_id'][1])) {
 295         $this->_memType = $params['membership_type_id'][1];
 296       }
 297     }
 298
 299     // Add custom data to form
 300     CRM_Custom_Form_CustomData::addToForm($this, $this->_memType);
 301
 302     // CRM-4395, get the online pending contribution id.
 303     $this->_onlinePendingContributionId = NULL;
 304     if (!$this->_mode && $this->_id && ($this->_action & CRM_Core_Action::UPDATE)) {
 305       $this->_onlinePendingContributionId = CRM_Contribute_BAO_Contribution::checkOnlinePendingContribution($this->_id,
 306         'Membership'
 307       );
 308     }
 309     $this->assign('onlinePendingContributionId', $this->_onlinePendingContributionId);
 310
 311     $this->setPageTitle(ts('Membership'));
 312   }
 313
 314   /**
 315    * Set default values for the form.
 316    */
 317   public function setDefaultValues() {
 318
 319     if ($this->_priceSetId) {
 320       return CRM_Price_BAO_PriceSet::setDefaultPriceSet($this, $defaults);
 321     }
 322
 323     $defaults = parent::setDefaultValues();
 324
 325     //setting default join date and receive date
 326     list($now, $currentTime) = CRM_Utils_Date::setDateDefaults();
 327     if ($this->_action == CRM_Core_Action::ADD) {
 328       $defaults['receive_date'] = $now;
 329       $defaults['receive_date_time'] = $currentTime;
 330     }
 331
 332     $defaults['num_terms'] = 1;
 333
 334     if (!empty($defaults['id'])) {
 335       if ($this->_onlinePendingContributionId) {
 336         $defaults['record_contribution'] = $this->_onlinePendingContributionId;
 337       }
 338       else {
 339         $contributionId = CRM_Core_DAO::singleValueQuery("
 340   SELECT contribution_id
 341   FROM civicrm_membership_payment
 342   WHERE membership_id = $this->_id
 343   ORDER BY contribution_id
 344   DESC limit 1");
 345
 346         if ($contributionId) {
 347           $defaults['record_contribution'] = $contributionId;
 348         }
 349       }
 350     }
 351
 352     //set Soft Credit Type to Gift by default
 353     $scTypes = CRM_Core_OptionGroup::values("soft_credit_type");
 354     $defaults['soft_credit_type_id'] = CRM_Utils_Array::value(ts('Gift'), array_flip($scTypes));
 355
 356     if (!empty($defaults['record_contribution']) && !$this->_mode) {
 357       $contributionParams = array('id' => $defaults['record_contribution']);
 358       $contributionIds = array();
 359
 360       //keep main object campaign in hand.
 361       $memberCampaignId = CRM_Utils_Array::value('campaign_id', $defaults);
 362
 363       CRM_Contribute_BAO_Contribution::getValues($contributionParams, $defaults, $contributionIds);
 364
 365       //get back original object campaign id.
 366       $defaults['campaign_id'] = $memberCampaignId;
 367
 368       if (!empty($defaults['receive_date'])) {
 369         list($defaults['receive_date']) = CRM_Utils_Date::setDateDefaults($defaults['receive_date']);
 370       }
 371
 372       // Contribution::getValues() over-writes the membership record's source field value - so we need to restore it.
 373       if (!empty($defaults['membership_source'])) {
 374         $defaults['source'] = $defaults['membership_source'];
 375       }
 376     }
 377     //CRM-13420
 378     if (empty($defaults['payment_instrument_id'])) {
 379       $defaults['payment_instrument_id'] = key(CRM_Core_OptionGroup::values('payment_instrument', FALSE, FALSE, FALSE, 'AND is_default = 1'));
 380     }
 381
 382     // User must explicitly choose to send a receipt in both add and update mode.
 383     $defaults['send_receipt'] = 0;
 384
 385     if ($this->_action & CRM_Core_Action::UPDATE) {
 386       // in this mode by default uncheck this checkbox
 387       unset($defaults['record_contribution']);
 388     }
 389
 390     $subscriptionCancelled = FALSE;
 391     if (!empty($defaults['id'])) {
 392       $subscriptionCancelled = CRM_Member_BAO_Membership::isSubscriptionCancelled($this->_id);
 393     }
 394
 395     $alreadyAutoRenew = FALSE;
 396     if (!empty($defaults['contribution_recur_id']) && !$subscriptionCancelled) {
 397       $defaults['auto_renew'] = 1;
 398       $alreadyAutoRenew = TRUE;
 399     }
 400     $this->assign('alreadyAutoRenew', $alreadyAutoRenew);
 401
 402     $this->assign('member_is_test', CRM_Utils_Array::value('member_is_test', $defaults));
 403
 404     $this->assign('membership_status_id', CRM_Utils_Array::value('status_id', $defaults));
 405
 406     if (!empty($defaults['is_pay_later'])) {
 407       $this->assign('is_pay_later', TRUE);
 408     }
 409     if ($this->_mode) {
 410       $defaults = $this->getBillingDefaults($defaults);
 411       // hack to simplify credit card entry for testing
 412       // $defaults['credit_card_type']     = 'Visa';
 413       // $defaults['credit_card_number']   = '4807731747657838';
 414       // $defaults['cvv2']                 = '000';
 415       // $defaults['credit_card_exp_date'] = array( 'Y' => '2012', 'M' => '05' );
 416     }
 417
 418     //setting default join date if there is no join date
 419     if (empty($defaults['join_date'])) {
 420       $defaults['join_date'] = date('Y-m-d H:i:s');
 421     }
 422
 423     if (!empty($defaults['membership_end_date'])) {
 424       $this->assign('endDate', $defaults['membership_end_date']);
 425     }
 426
 427     return $defaults;
 428   }
 429
 430   /**
 431    * Build the form object.
 432    */
 433   public function buildQuickForm() {
 434
 435     $this->buildQuickEntityForm();
 436     $this->assign('currency', CRM_Core_Config::singleton()->defaultCurrencySymbol);
 437     $isUpdateToExistingRecurringMembership = $this->isUpdateToExistingRecurringMembership();
 438     // build price set form.
 439     $buildPriceSet = FALSE;
 440     if ($this->_priceSetId || !empty($_POST['price_set_id'])) {
 441       if (!empty($_POST['price_set_id'])) {
 442         $buildPriceSet = TRUE;
 443       }
 444       $getOnlyPriceSetElements = TRUE;
 445       if (!$this->_priceSetId) {
 446         $this->_priceSetId = $_POST['price_set_id'];
 447         $getOnlyPriceSetElements = FALSE;
 448       }
 449
 450       $this->set('priceSetId', $this->_priceSetId);
 451       CRM_Price_BAO_PriceSet::buildPriceSet($this);
 452
 453       $optionsMembershipTypes = array();
 454       foreach ($this->_priceSet['fields'] as $pField) {
 455         if (empty($pField['options'])) {
 456           continue;
 457         }
 458         foreach ($pField['options'] as $opId => $opValues) {
 459           $optionsMembershipTypes[$opId] = CRM_Utils_Array::value('membership_type_id', $opValues, 0);
 460         }
 461       }
 462
 463       $this->assign('autoRenewOption', CRM_Price_BAO_PriceSet::checkAutoRenewForPriceSet($this->_priceSetId));
 464
 465       $this->assign('optionsMembershipTypes', $optionsMembershipTypes);
 466       $this->assign('contributionType', CRM_Utils_Array::value('financial_type_id', $this->_priceSet));
 467
 468       // get only price set form elements.
 469       if ($getOnlyPriceSetElements) {
 470         return;
 471       }
 472     }
 473
 474     // use to build form during form rule.
 475     $this->assign('buildPriceSet', $buildPriceSet);
 476
 477     if ($this->_action & CRM_Core_Action::ADD) {
 478       $buildPriceSet = FALSE;
 479       $priceSets = CRM_Price_BAO_PriceSet::getAssoc(FALSE, 'CiviMember');
 480       if (!empty($priceSets)) {
 481         $buildPriceSet = TRUE;
 482       }
 483
 484       if ($buildPriceSet) {
 485         $this->add('select', 'price_set_id', ts('Choose price set'),
 486           array(
 487             '' => ts('Choose price set'),
 488           ) + $priceSets,
 489           NULL, array('onchange' => "buildAmount( this.value );")
 490         );
 491       }
 492       $this->assign('hasPriceSets', $buildPriceSet);
 493     }
 494
 495     if ($this->_action & CRM_Core_Action::DELETE) {
 496       $this->addButtons(array(
 497         array(
 498           'type' => 'next',
 499           'name' => ts('Delete'),
 500           'spacing' => '&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;',
 501           'isDefault' => TRUE,
 502         ),
 503         array(
 504           'type' => 'cancel',
 505           'name' => ts('Cancel'),
 506         ),
 507       ));
 508       return;
 509     }
 510
 511     if ($this->_context == 'standalone') {
 512       $this->addEntityRef('contact_id', ts('Contact'), array(
 513         'create' => TRUE,
 514         'api' => array('extra' => array('email')),
 515       ), TRUE);
 516     }
 517
 518     $selOrgMemType[0][0] = $selMemTypeOrg[0] = ts('- select -');
 519
 520     // Throw status bounce when no Membership type or priceset is present
 521     if (CRM_Financial_BAO_FinancialType::isACLFinancialTypeStatus()
 522       && empty($this->allMembershipTypeDetails) && empty($priceSets)
 523     ) {
 524       CRM_Core_Error::statusBounce(ts('You do not have all the permissions needed for this page.'));
 525     }
 526     // retrieve all memberships
 527     $allMembershipInfo = array();
 528     foreach ($this->allMembershipTypeDetails as $key => $values) {
 529       if ($this->_mode && empty($values['minimum_fee'])) {
 530         continue;
 531       }
 532       else {
 533         $memberOfContactId = CRM_Utils_Array::value('member_of_contact_id', $values);
 534         if (empty($selMemTypeOrg[$memberOfContactId])) {
 535           $selMemTypeOrg[$memberOfContactId] = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact',
 536             $memberOfContactId,
 537             'display_name',
 538             'id'
 539           );
 540
 541           $selOrgMemType[$memberOfContactId][0] = ts('- select -');
 542         }
 543         if (empty($selOrgMemType[$memberOfContactId][$key])) {
 544           $selOrgMemType[$memberOfContactId][$key] = CRM_Utils_Array::value('name', $values);
 545         }
 546       }
 547       $totalAmount = CRM_Utils_Array::value('minimum_fee', $values);
 548       //CRM-18827 - override the default value if total_amount is submitted
 549       if (!empty($this->_submitValues['total_amount'])) {
 550         $totalAmount = $this->_submitValues['total_amount'];
 551       }
 552       // build membership info array, which is used when membership type is selected to:
 553       // - set the payment information block
 554       // - set the max related block
 555       $allMembershipInfo[$key] = array(
 556         'financial_type_id' => CRM_Utils_Array::value('financial_type_id', $values),
 557         'total_amount' => CRM_Utils_Money::format($totalAmount, NULL, '%a'),
 558         'total_amount_numeric' => $totalAmount,
 559         'auto_renew' => CRM_Utils_Array::value('auto_renew', $values),
 560         'has_related' => isset($values['relationship_type_id']),
 561         'max_related' => CRM_Utils_Array::value('max_related', $values),
 562       );
 563     }
 564
 565     $this->assign('allMembershipInfo', json_encode($allMembershipInfo));
 566
 567     // show organization by default, if only one organization in
 568     // the list
 569     if (count($selMemTypeOrg) == 2) {
 570       unset($selMemTypeOrg[0], $selOrgMemType[0][0]);
 571     }
 572     //sort membership organization and type, CRM-6099
 573     natcasesort($selMemTypeOrg);
 574     foreach ($selOrgMemType as $index => $orgMembershipType) {
 575       natcasesort($orgMembershipType);
 576       $selOrgMemType[$index] = $orgMembershipType;
 577     }
 578
 579     $memTypeJs = array(
 580       'onChange' => "buildMaxRelated(this.value,true); CRM.buildCustomData('Membership', this.value);",
 581     );
 582
 583     if (!empty($this->_recurPaymentProcessors)) {
 584       $memTypeJs['onChange'] = "" . $memTypeJs['onChange'] . "buildAutoRenew(this.value, null, '{$this->_mode}');";
 585     }
 586
 587     $this->add('text', 'max_related', ts('Max related'),
 588       CRM_Core_DAO::getAttribute('CRM_Member_DAO_Membership', 'max_related')
 589     );
 590
 591     $sel = &$this->addElement('hierselect',
 592       'membership_type_id',
 593       ts('Membership Organization and Type'),
 594       $memTypeJs
 595     );
 596
 597     $sel->setOptions(array($selMemTypeOrg, $selOrgMemType));
 598     if ($isUpdateToExistingRecurringMembership) {
 599       $sel->freeze();
 600     }
 601
 602     if ($this->_action & CRM_Core_Action::ADD) {
 603       $this->add('text', 'num_terms', ts('Number of Terms'), array('size' => 6));
 604     }
 605
 606     $this->add('text', 'source', ts('Source'),
 607       CRM_Core_DAO::getAttribute('CRM_Member_DAO_Membership', 'source')
 608     );
 609
 610     //CRM-7362 --add campaigns.
 611     $campaignId = NULL;
 612     if ($this->_id) {
 613       $campaignId = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_Membership', $this->_id, 'campaign_id');
 614     }
 615     CRM_Campaign_BAO_Campaign::addCampaign($this, $campaignId);
 616
 617     if (!$this->_mode) {
 618       $this->add('select', 'status_id', ts('Membership Status'),
 619         array('' => ts('- select -')) + CRM_Member_PseudoConstant::membershipStatus(NULL, NULL, 'label')
 620       );
 621
 622       $statusOverride = $this->addElement('select', 'is_override', ts('Status Override?'),
 623         CRM_Member_StatusOverrideTypes::getSelectOptions()
 624       );
 625       if ($statusOverride && $isUpdateToExistingRecurringMembership) {
 626         $statusOverride->freeze();
 627       }
 628
 629       $this->add('datepicker', 'status_override_end_date', ts('Status Override End Date'), '', FALSE, array('minDate' => time(), 'time' => FALSE));
 630
 631       $this->addElement('checkbox', 'record_contribution', ts('Record Membership Payment?'));
 632
 633       $this->add('text', 'total_amount', ts('Amount'));
 634       $this->addRule('total_amount', ts('Please enter a valid amount.'), 'money');
 635
 636       $this->addDate('receive_date', ts('Received'), FALSE, array('formatType' => 'activityDateTime'));
 637
 638       $this->add('select', 'payment_instrument_id',
 639         ts('Payment Method'),
 640         array('' => ts('- select -')) + CRM_Contribute_PseudoConstant::paymentInstrument(),
 641         FALSE, array('onChange' => "return showHideByValue('payment_instrument_id','4','checkNumber','table-row','select',false);")
 642       );
 643       $this->add('text', 'trxn_id', ts('Transaction ID'));
 644       $this->addRule('trxn_id', ts('Transaction ID already exists in Database.'),
 645         'objectExists', array(
 646           'CRM_Contribute_DAO_Contribution',
 647           $this->_id,
 648           'trxn_id',
 649         )
 650       );
 651
 652       $this->add('select', 'contribution_status_id',
 653         ts('Payment Status'), CRM_Contribute_BAO_Contribution_Utils::getContributionStatuses('membership')
 654       );
 655       $this->add('text', 'check_number', ts('Check Number'),
 656         CRM_Core_DAO::getAttribute('CRM_Contribute_DAO_Contribution', 'check_number')
 657       );
 658     }
 659     else {
 660       //add field for amount to allow an amount to be entered that differs from minimum
 661       $this->add('text', 'total_amount', ts('Amount'));
 662     }
 663     $this->add('select', 'financial_type_id',
 664       ts('Financial Type'),
 665       array('' => ts('- select -')) + CRM_Financial_BAO_FinancialType::getAvailableFinancialTypes($financialTypes, $this->_action)
 666     );
 667
 668     $this->addElement('checkbox', 'is_different_contribution_contact', ts('Record Payment from a Different Contact?'));
 669
 670     $this->addSelect('soft_credit_type_id', array('entity' => 'contribution_soft'));
 671     $this->addEntityRef('soft_credit_contact_id', ts('Payment From'), array('create' => TRUE));
 672
 673     $this->addElement('checkbox',
 674       'send_receipt',
 675       ts('Send Confirmation and Receipt?'), NULL,
 676       array('onclick' => "showEmailOptions()")
 677     );
 678
 679     $this->add('select', 'from_email_address', ts('Receipt From'), $this->_fromEmails);
 680
 681     $this->add('textarea', 'receipt_text', ts('Receipt Message'));
 682
 683     // Retrieve the name and email of the contact - this will be the TO for receipt email
 684     if ($this->_contactID) {
 685       list($this->_memberDisplayName,
 686         $this->_memberEmail
 687         ) = CRM_Contact_BAO_Contact_Location::getEmailDetails($this->_contactID);
 688
 689       $this->assign('emailExists', $this->_memberEmail);
 690       $this->assign('displayName', $this->_memberDisplayName);
 691     }
 692
 693     if ($isUpdateToExistingRecurringMembership && CRM_Member_BAO_Membership::isCancelSubscriptionSupported($this->_id)) {
 694       $this->assign('cancelAutoRenew',
 695         CRM_Utils_System::url('civicrm/contribute/unsubscribe', "reset=1&mid={$this->_id}")
 696       );
 697     }
 698
 699     $this->assign('isRecur', $isUpdateToExistingRecurringMembership);
 700
 701     $this->addFormRule(array('CRM_Member_Form_Membership', 'formRule'), $this);
 702     $mailingInfo = Civi::settings()->get('mailing_backend');
 703     $this->assign('isEmailEnabledForSite', ($mailingInfo['outBound_option'] != 2));
 704
 705     parent::buildQuickForm();
 706   }
 707
 708   /**
 709    * Validation.
 710    *
 711    * @param array $params
 712    *   (ref.) an assoc array of name/value pairs.
 713    *
 714    * @param array $files
 715    * @param CRM_Member_Form_Membership $self
 716    *
 717    * @throws CiviCRM_API3_Exception
 718    * @return bool|array
 719    *   mixed true or array of errors
 720    */
 721   public static function formRule($params, $files, $self) {
 722     $errors = array();
 723
 724     $priceSetId = self::getPriceSetID($params);
 725     $priceSetDetails = self::getPriceSetDetails($params);
 726
 727     $selectedMemberships = self::getSelectedMemberships($priceSetDetails[$priceSetId], $params);
 728
 729     if (!empty($params['price_set_id'])) {
 730       CRM_Price_BAO_PriceField::priceSetValidation($priceSetId, $params, $errors);
 731
 732       $priceFieldIDS = self::getPriceFieldIDs($params, $priceSetDetails[$priceSetId]);
 733
 734       if (!empty($priceFieldIDS)) {
 735         $ids = implode(',', $priceFieldIDS);
 736
 737         $count = CRM_Price_BAO_PriceSet::getMembershipCount($ids);
 738         foreach ($count as $occurrence) {
 739           if ($occurrence > 1) {
 740             $errors['_qf_default'] = ts('Select at most one option associated with the same membership type.');
 741           }
 742         }
 743       }
 744       // Return error if empty $self->_memTypeSelected
 745       if (empty($errors) && empty($selectedMemberships)) {
 746         $errors['_qf_default'] = ts('Select at least one membership option.');
 747       }
 748       if (!$self->_mode && empty($params['record_contribution'])) {
 749         $errors['record_contribution'] = ts('Record Membership Payment is required when you use a price set.');
 750       }
 751     }
 752     else {
 753       if (empty($params['membership_type_id'][1])) {
 754         $errors['membership_type_id'] = ts('Please select a membership type.');
 755       }
 756       $numterms = CRM_Utils_Array::value('num_terms', $params);
 757       if ($numterms && intval($numterms) != $numterms) {
 758         $errors['num_terms'] = ts('Please enter an integer for the number of terms.');
 759       }
 760
 761       if (($self->_mode || isset($params['record_contribution'])) && empty($params['financial_type_id'])) {
 762         $errors['financial_type_id'] = ts('Please enter the financial Type.');
 763       }
 764     }
 765
 766     if (!empty($errors) && (count($selectedMemberships) > 1)) {
 767       $memberOfContacts = CRM_Member_BAO_MembershipType::getMemberOfContactByMemTypes($selectedMemberships);
 768       $duplicateMemberOfContacts = array_count_values($memberOfContacts);
 769       foreach ($duplicateMemberOfContacts as $countDuplicate) {
 770         if ($countDuplicate > 1) {
 771           $errors['_qf_default'] = ts('Please do not select more than one membership associated with the same organization.');
 772         }
 773       }
 774     }
 775
 776     if (!empty($errors)) {
 777       return $errors;
 778     }
 779
 780     if (!empty($params['record_contribution']) && empty($params['payment_instrument_id'])) {
 781       $errors['payment_instrument_id'] = ts('Payment Method is a required field.');
 782     }
 783
 784     if (!empty($params['is_different_contribution_contact'])) {
 785       if (empty($params['soft_credit_type_id'])) {
 786         $errors['soft_credit_type_id'] = ts('Please Select a Soft Credit Type');
 787       }
 788       if (empty($params['soft_credit_contact_id'])) {
 789         $errors['soft_credit_contact_id'] = ts('Please select a contact');
 790       }
 791     }
 792
 793     if (!empty($params['payment_processor_id'])) {
 794       // validate payment instrument (e.g. credit card number)
 795       CRM_Core_Payment_Form::validatePaymentInstrument($params['payment_processor_id'], $params, $errors, NULL);
 796     }
 797
 798     $joinDate = NULL;
 799     if (!empty($params['join_date'])) {
 800
 801       $joinDate = CRM_Utils_Date::processDate($params['join_date']);
 802
 803       foreach ($selectedMemberships as $memType) {
 804         $startDate = NULL;
 805         if (!empty($params['start_date'])) {
 806           $startDate = CRM_Utils_Date::processDate($params['start_date']);
 807         }
 808
 809         // if end date is set, ensure that start date is also set
 810         // and that end date is later than start date
 811         $endDate = NULL;
 812         if (!empty($params['end_date'])) {
 813           $endDate = CRM_Utils_Date::processDate($params['end_date']);
 814         }
 815
 816         $membershipDetails = CRM_Member_BAO_MembershipType::getMembershipTypeDetails($memType);
 817
 818         if ($startDate && CRM_Utils_Array::value('period_type', $membershipDetails) == 'rolling') {
 819           if ($startDate < $joinDate) {
 820             $errors['start_date'] = ts('Start date must be the same or later than Member since.');
 821           }
 822         }
 823
 824         if ($endDate) {
 825           if ($membershipDetails['duration_unit'] == 'lifetime') {
 826             // Check if status is NOT cancelled or similar. For lifetime memberships, there is no automated
 827             // process to update status based on end-date. The user must change the status now.
 828             $result = civicrm_api3('MembershipStatus', 'get', array(
 829               'sequential' => 1,
 830               'is_current_member' => 0,
 831             ));
 832             $tmp_statuses = $result['values'];
 833             $status_ids = array();
 834             foreach ($tmp_statuses as $cur_stat) {
 835               $status_ids[] = $cur_stat['id'];
 836             }
 837
 838             if (empty($params['status_id']) || in_array($params['status_id'], $status_ids) == FALSE) {
 839               $errors['status_id'] = ts('Please enter a status that does NOT represent a current membership status.');
 840             }
 841
 842             if (!empty($params['is_override']) && !CRM_Member_StatusOverrideTypes::isPermanent($params['is_override'])) {
 843               $errors['is_override'] = ts('Because you set an End Date for a lifetime membership, This must be set to "Override Permanently"');
 844             }
 845           }
 846           else {
 847             if (!$startDate) {
 848               $errors['start_date'] = ts('Start date must be set if end date is set.');
 849             }
 850             if ($endDate < $startDate) {
 851               $errors['end_date'] = ts('End date must be the same or later than start date.');
 852             }
 853           }
 854         }
 855
 856         // Default values for start and end dates if not supplied on the form.
 857         $defaultDates = CRM_Member_BAO_MembershipType::getDatesForMembershipType($memType,
 858           $joinDate,
 859           $startDate,
 860           $endDate
 861         );
 862
 863         if (!$startDate) {
 864           $startDate = CRM_Utils_Array::value('start_date',
 865             $defaultDates
 866           );
 867         }
 868         if (!$endDate) {
 869           $endDate = CRM_Utils_Array::value('end_date',
 870             $defaultDates
 871           );
 872         }
 873
 874         //CRM-3724, check for availability of valid membership status.
 875         if ((empty($params['is_override']) || CRM_Member_StatusOverrideTypes::isNo($params['is_override'])) && !isset($errors['_qf_default'])) {
 876           $calcStatus = CRM_Member_BAO_MembershipStatus::getMembershipStatusByDate($startDate,
 877             $endDate,
 878             $joinDate,
 879             'today',
 880             TRUE,
 881             $memType,
 882             $params
 883           );
 884           if (empty($calcStatus)) {
 885             $url = CRM_Utils_System::url('civicrm/admin/member/membershipStatus', 'reset=1&action=browse');
 886             $errors['_qf_default'] = ts('There is no valid Membership Status available for selected membership dates.');
 887             $status = ts('Oops, it looks like there is no valid membership status available for the given membership dates. You can <a href="%1">Configure Membership Status Rules</a>.', array(1 => $url));
 888             if (!$self->_mode) {
 889               $status .= ' ' . ts('OR You can sign up by setting Status Override? to something other than "NO".');
 890             }
 891             CRM_Core_Session::setStatus($status, ts('Membership Status Error'), 'error');
 892           }
 893         }
 894       }
 895     }
 896     else {
 897       $errors['join_date'] = ts('Please enter the Member Since.');
 898     }
 899
 900     if (!empty($params['is_override']) && CRM_Member_StatusOverrideTypes::isOverridden($params['is_override']) && empty($params['status_id'])) {
 901       $errors['status_id'] = ts('Please enter the Membership status.');
 902     }
 903
 904     if (!empty($params['is_override']) && CRM_Member_StatusOverrideTypes::isUntilDate($params['is_override'])) {
 905       if (empty($params['status_override_end_date'])) {
 906         $errors['status_override_end_date'] = ts('Please enter the Membership override end date.');
 907       }
 908     }
 909
 910     //total amount condition arise when membership type having no
 911     //minimum fee
 912     if (isset($params['record_contribution'])) {
 913       if (CRM_Utils_System::isNull($params['total_amount'])) {
 914         $errors['total_amount'] = ts('Please enter the contribution.');
 915       }
 916     }
 917
 918     // validate contribution status for 'Failed'.
 919     if ($self->_onlinePendingContributionId && !empty($params['record_contribution']) &&
 920       (CRM_Utils_Array::value('contribution_status_id', $params) ==
 921         array_search('Failed', CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name'))
 922       )
 923     ) {
 924       $errors['contribution_status_id'] = ts('Please select a valid payment status before updating.');
 925     }
 926
 927     return empty($errors) ? TRUE : $errors;
 928   }
 929
 930   /**
 931    * Process the form submission.
 932    */
 933   public function postProcess() {
 934     if ($this->_action & CRM_Core_Action::DELETE) {
 935       CRM_Member_BAO_Membership::del($this->_id);
 936       return;
 937     }
 938     // get the submitted form values.
 939     $this->_params = $this->controller->exportValues($this->_name);
 940     $this->prepareStatusOverrideValues();
 941
 942     $this->submit();
 943
 944     $this->setUserContext();
 945   }
 946
 947   /**
 948    * Prepares the values related to status override.
 949    */
 950   private function prepareStatusOverrideValues() {
 951     $this->setOverrideDateValue();
 952     $this->convertIsOverrideValue();
 953   }
 954
 955   /**
 956    * Sets status override end date to empty value if
 957    * the selected override option is not 'until date'.
 958    */
 959   private function setOverrideDateValue() {
 960     if (!CRM_Member_StatusOverrideTypes::isUntilDate(CRM_Utils_Array::value('is_override', $this->_params))) {
 961       $this->_params['status_override_end_date'] = '';
 962     }
 963   }
 964
 965   /**
 966    * Convert the value of selected (status override?)
 967    * option to TRUE if it indicate an overridden status
 968    * or FALSE otherwise.
 969    */
 970   private function convertIsOverrideValue() {
 971     $this->_params['is_override'] = CRM_Member_StatusOverrideTypes::isOverridden($this->_params['is_override']);
 972   }
 973
 974   /**
 975    * Send email receipt.
 976    *
 977    * @deprecated
 978    *   This function is shared with Batch_Entry which has limited overlap
 979    *   & needs rationalising.
 980    *
 981    * @param CRM_Core_Form $form
 982    *   Form object.
 983    * @param array $formValues
 984    * @param object $membership
 985    *   Object.
 986    * @param array $customValues
 987    *
 988    * @return bool
 989    *   true if mail was sent successfully
 990    */
 991   public static function emailReceipt(&$form, &$formValues, &$membership, $customValues = NULL) {
 992     // retrieve 'from email id' for acknowledgement
 993     $receiptFrom = CRM_Utils_Array::value('from_email_address', $formValues);
 994
 995     // @todo figure out how much of the stuff below is genuinely shared with the batch form & a logical shared place.
 996     if (!empty($formValues['payment_instrument_id'])) {
 997       $paymentInstrument = CRM_Contribute_PseudoConstant::paymentInstrument();
 998       $formValues['paidBy'] = $paymentInstrument[$formValues['payment_instrument_id']];
 999     }
1000
1001     $form->assign('customValues', $customValues);
1002
1003     if ($form->_mode) {
1004       // @todo move this outside shared code as Batch entry just doesn't
1005       $form->assign('address', CRM_Utils_Address::getFormattedBillingAddressFieldsFromParameters(
1006         $form->_params,
1007         $form->_bltID
1008       ));
1009
1010       $date = CRM_Utils_Date::format($form->_params['credit_card_exp_date']);
1011       $date = CRM_Utils_Date::mysqlToIso($date);
1012       $form->assign('credit_card_exp_date', $date);
1013       $form->assign('credit_card_number',
1014         CRM_Utils_System::mungeCreditCard($form->_params['credit_card_number'])
1015       );
1016       $form->assign('credit_card_type', $form->_params['credit_card_type']);
1017       $form->assign('contributeMode', 'direct');
1018       $form->assign('isAmountzero', 0);
1019       $form->assign('is_pay_later', 0);
1020       $form->assign('isPrimary', 1);
1021     }
1022
1023     $form->assign('module', 'Membership');
1024     $form->assign('contactID', $formValues['contact_id']);
1025
1026     $form->assign('membershipID', CRM_Utils_Array::value('membership_id', $form->_params, CRM_Utils_Array::value('membership_id', $form->_defaultValues)));
1027
1028     if (!empty($formValues['contribution_id'])) {
1029       $form->assign('contributionID', $formValues['contribution_id']);
1030     }
1031     elseif (isset($form->_onlinePendingContributionId)) {
1032       $form->assign('contributionID', $form->_onlinePendingContributionId);
1033     }
1034
1035     if (!empty($formValues['contribution_status_id'])) {
1036       $form->assign('contributionStatusID', $formValues['contribution_status_id']);
1037       $form->assign('contributionStatus', CRM_Contribute_PseudoConstant::contributionStatus($formValues['contribution_status_id'], 'name'));
1038     }
1039
1040     if (!empty($formValues['is_renew'])) {
1041       $form->assign('receiptType', 'membership renewal');
1042     }
1043     else {
1044       $form->assign('receiptType', 'membership signup');
1045     }
1046     $form->assign('receive_date', CRM_Utils_Date::processDate(CRM_Utils_Array::value('receive_date', $formValues)));
1047     $form->assign('formValues', $formValues);
1048
1049     if (empty($lineItem)) {
1050       $form->assign('mem_start_date', CRM_Utils_Date::customFormat($membership->start_date, '%B %E%f, %Y'));
1051       if (!CRM_Utils_System::isNull($membership->end_date)) {
1052         $form->assign('mem_end_date', CRM_Utils_Date::customFormat($membership->end_date, '%B %E%f, %Y'));
1053       }
1054       $form->assign('membership_name', CRM_Member_PseudoConstant::membershipType($membership->membership_type_id));
1055     }
1056
1057     // @todo - if we have to figure out if this is for batch processing it doesn't belong in the shared function.
1058     $isBatchProcess = is_a($form, 'CRM_Batch_Form_Entry');
1059     if ((empty($form->_contributorDisplayName) || empty($form->_contributorEmail)) || $isBatchProcess) {
1060       // in this case the form is being called statically from the batch editing screen
1061       // having one class in the form layer call another statically is not greate
1062       // & we should aim to move this function to the BAO layer in future.
1063       // however, we can assume that the contact_id passed in by the batch
1064       // function will be the recipient
1065       list($form->_contributorDisplayName, $form->_contributorEmail)
1066         = CRM_Contact_BAO_Contact_Location::getEmailDetails($formValues['contact_id']);
1067       if (empty($form->_receiptContactId) || $isBatchProcess) {
1068         $form->_receiptContactId = $formValues['contact_id'];
1069       }
1070     }
1071     // @todo determine isEmailPdf in calling function.
1072     $template = CRM_Core_Smarty::singleton();
1073     $taxAmt = $template->get_template_vars('dataArray');
1074     $eventTaxAmt = $template->get_template_vars('totalTaxAmount');
1075     $prefixValue = Civi::settings()->get('contribution_invoice_settings');
1076     $invoicing = CRM_Utils_Array::value('invoicing', $prefixValue);
1077     if ((!empty($taxAmt) || isset($eventTaxAmt)) && (isset($invoicing) && isset($prefixValue['is_email_pdf']))) {
1078       $isEmailPdf = TRUE;
1079     }
1080     else {
1081       $isEmailPdf = FALSE;
1082     }
1083
1084     list($mailSend, $subject, $message, $html) = CRM_Core_BAO_MessageTemplate::sendTemplate(
1085       array(
1086         'groupName' => 'msg_tpl_workflow_membership',
1087         'valueName' => 'membership_offline_receipt',
1088         'contactId' => $form->_receiptContactId,
1089         'from' => $receiptFrom,
1090         'toName' => $form->_contributorDisplayName,
1091         'toEmail' => $form->_contributorEmail,
1092         'PDFFilename' => ts('receipt') . '.pdf',
1093         'isEmailPdf' => $isEmailPdf,
1094         'contributionId' => $formValues['contribution_id'],
1095         'isTest' => (bool) ($form->_action & CRM_Core_Action::PREVIEW),
1096       )
1097     );
1098
1099     return TRUE;
1100   }
1101
1102   /**
1103    * Submit function.
1104    *
1105    * This is also accessed by unit tests.
1106    */
1107   public function submit() {
1108     $isTest = ($this->_mode == 'test') ? 1 : 0;
1109     $this->storeContactFields($this->_params);
1110     $this->beginPostProcess();
1111     $formValues = $this->_params;
1112     $joinDate = $startDate = $endDate = NULL;
1113     $membershipTypes = $membership = $calcDate = array();
1114     $membershipType = NULL;
1115     $paymentInstrumentID = $this->_paymentProcessor['object']->getPaymentInstrumentID();
1116
1117     $mailSend = FALSE;
1118     $formValues = $this->setPriceSetParameters($formValues);
1119     $params = $softParams = $ids = array();
1120
1121     $this->processBillingAddress();
1122
1123     if ($this->_id) {
1124       $ids['membership'] = $params['id'] = $this->_id;
1125     }
1126     $ids['userId'] = CRM_Core_Session::singleton()->get('userID');
1127
1128     // Set variables that we normally get from context.
1129     // In form mode these are set in preProcess.
1130     //TODO: set memberships, fixme
1131     $this->setContextVariables($formValues);
1132
1133     $this->_memTypeSelected = self::getSelectedMemberships(
1134       $this->_priceSet,
1135       $formValues
1136     );
1137     if (empty($formValues['financial_type_id'])) {
1138       $formValues['financial_type_id'] = $this->_priceSet['financial_type_id'];
1139     }
1140
1141     $config = CRM_Core_Config::singleton();
1142
1143     // @todo this is no longer required if we convert some date fields.
1144     $this->convertDateFieldsToMySQL($formValues);
1145
1146     $membershipTypeValues = array();
1147     foreach ($this->_memTypeSelected as $memType) {
1148       $membershipTypeValues[$memType]['membership_type_id'] = $memType;
1149     }
1150
1151     //take the required membership recur values.
1152     if ($this->_mode && !empty($formValues['auto_renew'])) {
1153       $params['is_recur'] = $formValues['is_recur'] = TRUE;
1154       $mapping = array(
1155         'frequency_interval' => 'duration_interval',
1156         'frequency_unit' => 'duration_unit',
1157       );
1158
1159       $count = 0;
1160       foreach ($this->_memTypeSelected as $memType) {
1161         $recurMembershipTypeValues = CRM_Utils_Array::value($memType,
1162           $this->_recurMembershipTypes, array()
1163         );
1164         foreach ($mapping as $mapVal => $mapParam) {
1165           $membershipTypeValues[$memType][$mapVal] = CRM_Utils_Array::value($mapParam,
1166             $recurMembershipTypeValues
1167           );
1168           if (!$count) {
1169             $formValues[$mapVal] = CRM_Utils_Array::value($mapParam,
1170               $recurMembershipTypeValues
1171             );
1172           }
1173         }
1174         $count++;
1175       }
1176     }
1177
1178     $isQuickConfig = $this->_priceSet['is_quick_config'];
1179
1180     $termsByType = array();
1181
1182     $lineItem = array($this->_priceSetId => array());
1183
1184     CRM_Price_BAO_PriceSet::processAmount($this->_priceSet['fields'],
1185       $formValues, $lineItem[$this->_priceSetId], NULL, $this->_priceSetId);
1186
1187     if (CRM_Utils_Array::value('tax_amount', $formValues)) {
1188       $params['tax_amount'] = $formValues['tax_amount'];
1189     }
1190     $params['total_amount'] = CRM_Utils_Array::value('amount', $formValues);
1191     if (!empty($lineItem[$this->_priceSetId])) {
1192       foreach ($lineItem[$this->_priceSetId] as &$li) {
1193         if (!empty($li['membership_type_id'])) {
1194           if (!empty($li['membership_num_terms'])) {
1195             $termsByType[$li['membership_type_id']] = $li['membership_num_terms'];
1196           }
1197         }
1198
1199         ///CRM-11529 for quick config backoffice transactions
1200         //when financial_type_id is passed in form, update the
1201         //lineitems with the financial type selected in form
1202         $submittedFinancialType = CRM_Utils_Array::value('financial_type_id', $formValues);
1203         if ($isQuickConfig && $submittedFinancialType) {
1204           $li['financial_type_id'] = $submittedFinancialType;
1205         }
1206       }
1207     }
1208
1209     $params['contact_id'] = $this->_contactID;
1210
1211     $fields = array(
1212       'status_id',
1213       'source',
1214       'is_override',
1215       'status_override_end_date',
1216       'campaign_id',
1217     );
1218
1219     foreach ($fields as $f) {
1220       $params[$f] = CRM_Utils_Array::value($f, $formValues);
1221     }
1222
1223     // fix for CRM-3724
1224     // when is_override false ignore is_admin statuses during membership
1225     // status calculation. similarly we did fix for import in CRM-3570.
1226     if (empty($params['is_override'])) {
1227       $params['exclude_is_admin'] = TRUE;
1228     }
1229
1230     // process date params to mysql date format.
1231     $dateTypes = array(
1232       'join_date' => 'joinDate',
1233       'start_date' => 'startDate',
1234       'end_date' => 'endDate',
1235     );
1236     foreach ($dateTypes as $dateField => $dateVariable) {
1237       $$dateVariable = CRM_Utils_Date::processDate($formValues[$dateField]);
1238     }
1239
1240     $memTypeNumTerms = empty($termsByType) ? CRM_Utils_Array::value('num_terms', $formValues) : NULL;
1241
1242     $calcDates = array();
1243     foreach ($this->_memTypeSelected as $memType) {
1244       if (empty($memTypeNumTerms)) {
1245         $memTypeNumTerms = CRM_Utils_Array::value($memType, $termsByType, 1);
1246       }
1247       $calcDates[$memType] = CRM_Member_BAO_MembershipType::getDatesForMembershipType($memType,
1248         $joinDate, $startDate, $endDate, $memTypeNumTerms
1249       );
1250     }
1251
1252     foreach ($calcDates as $memType => $calcDate) {
1253       foreach (array_keys($dateTypes) as $d) {
1254         //first give priority to form values then calDates.
1255         $date = CRM_Utils_Array::value($d, $formValues);
1256         if (!$date) {
1257           $date = CRM_Utils_Array::value($d, $calcDate);
1258         }
1259
1260         $membershipTypeValues[$memType][$d] = CRM_Utils_Date::processDate($date);
1261       }
1262     }
1263
1264     foreach ($this->_memTypeSelected as $memType) {
1265       if (array_key_exists('max_related', $formValues)) {
1266         // max related memberships - take from form or inherit from membership type
1267         $membershipTypeValues[$memType]['max_related'] = CRM_Utils_Array::value('max_related', $formValues);
1268       }
1269       $membershipTypeValues[$memType]['custom'] = CRM_Core_BAO_CustomField::postProcess($formValues,
1270         $this->_id,
1271         'Membership'
1272       );
1273       $membershipTypes[$memType] = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipType',
1274         $memType
1275       );
1276     }
1277
1278     $membershipType = implode(', ', $membershipTypes);
1279
1280     // Retrieve the name and email of the current user - this will be the FROM for the receipt email
1281     list($userName) = CRM_Contact_BAO_Contact_Location::getEmailDetails($ids['userId']);
1282
1283     //CRM-13981, allow different person as a soft-contributor of chosen type
1284     if ($this->_contributorContactID != $this->_contactID) {
1285       $params['contribution_contact_id'] = $this->_contributorContactID;
1286       if (!empty($formValues['soft_credit_type_id'])) {
1287         $softParams['soft_credit_type_id'] = $formValues['soft_credit_type_id'];
1288         $softParams['contact_id'] = $this->_contactID;
1289       }
1290     }
1291
1292     $pendingMembershipStatusId = CRM_Core_PseudoConstant::getKey('CRM_Member_BAO_Membership', 'status_id', 'Pending');
1293
1294     if (!empty($formValues['record_contribution'])) {
1295       $recordContribution = array(
1296         'total_amount',
1297         'financial_type_id',
1298         'payment_instrument_id',
1299         'trxn_id',
1300         'contribution_status_id',
1301         'check_number',
1302         'campaign_id',
1303         'receive_date',
1304         'card_type_id',
1305         'pan_truncation',
1306       );
1307
1308       foreach ($recordContribution as $f) {
1309         $params[$f] = CRM_Utils_Array::value($f, $formValues);
1310       }
1311
1312       if (!$this->_onlinePendingContributionId) {
1313         if (empty($formValues['source'])) {
1314           $params['contribution_source'] = ts('%1 Membership: Offline signup (by %2)', array(
1315             1 => $membershipType,
1316             2 => $userName,
1317           ));
1318         }
1319         else {
1320           $params['contribution_source'] = $formValues['source'];
1321         }
1322       }
1323
1324       $completedContributionStatusId = CRM_Core_PseudoConstant::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Completed');
1325       if (empty($params['is_override']) &&
1326         CRM_Utils_Array::value('contribution_status_id', $params) != $completedContributionStatusId
1327       ) {
1328         $params['status_id'] = $pendingMembershipStatusId;
1329         $params['skipStatusCal'] = TRUE;
1330         $params['is_pay_later'] = 1;
1331         $this->assign('is_pay_later', 1);
1332       }
1333
1334       if (!empty($formValues['send_receipt'])) {
1335         $params['receipt_date'] = CRM_Utils_Array::value('receive_date', $formValues);
1336       }
1337
1338       //insert financial type name in receipt.
1339       $formValues['contributionType_name'] = CRM_Core_DAO::getFieldValue('CRM_Financial_DAO_FinancialType',
1340         $formValues['financial_type_id']
1341       );
1342     }
1343
1344     // process line items, until no previous line items.
1345     if (!empty($lineItem)) {
1346       $params['lineItems'] = $lineItem;
1347       $params['processPriceSet'] = TRUE;
1348     }
1349     $createdMemberships = array();
1350     if ($this->_mode) {
1351       $params['total_amount'] = CRM_Utils_Array::value('total_amount', $formValues, 0);
1352
1353       //CRM-20264 : Store CC type and number (last 4 digit) during backoffice or online payment
1354       $params['card_type_id'] = CRM_Utils_Array::value('card_type_id', $this->_params);
1355       $params['pan_truncation'] = CRM_Utils_Array::value('pan_truncation', $this->_params);
1356
1357       if (!$isQuickConfig) {
1358         $params['financial_type_id'] = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceSet',
1359           $this->_priceSetId,
1360           'financial_type_id'
1361         );
1362       }
1363       else {
1364         $params['financial_type_id'] = CRM_Utils_Array::value('financial_type_id', $formValues);
1365       }
1366
1367       //get the payment processor id as per mode. Try removing in favour of beginPostProcess.
1368       $params['payment_processor_id'] = $formValues['payment_processor_id'] = $this->_paymentProcessor['id'];
1369       $params['register_date'] = date('YmdHis');
1370
1371       // add all the additional payment params we need
1372       // @todo the country & state values should be set by the call to $this->assignBillingAddress.
1373       $formValues["state_province-{$this->_bltID}"] = $formValues["billing_state_province-{$this->_bltID}"]
1374         = CRM_Core_PseudoConstant::stateProvinceAbbreviation($formValues["billing_state_province_id-{$this->_bltID}"]);
1375       $formValues["country-{$this->_bltID}"] = $formValues["billing_country-{$this->_bltID}"] = CRM_Core_PseudoConstant::countryIsoCode($formValues["billing_country_id-{$this->_bltID}"]);
1376
1377       $formValues['amount'] = $params['total_amount'];
1378       // @todo this is a candidate for beginPostProcessFunction.
1379       $formValues['currencyID'] = $config->defaultCurrency;
1380       $formValues['description'] = ts("Contribution submitted by a staff person using member's credit card for signup");
1381       $formValues['invoiceID'] = md5(uniqid(rand(), TRUE));
1382       $formValues['financial_type_id'] = $params['financial_type_id'];
1383
1384       // at this point we've created a contact and stored its address etc
1385       // all the payment processors expect the name and address to be in the
1386       // so we copy stuff over to first_name etc.
1387       $paymentParams = $formValues;
1388       $paymentParams['contactID'] = $this->_contributorContactID;
1389       //CRM-10377 if payment is by an alternate contact then we need to set that person
1390       // as the contact in the payment params
1391       if ($this->_contributorContactID != $this->_contactID) {
1392         if (!empty($formValues['soft_credit_type_id'])) {
1393           $softParams['contact_id'] = $params['contact_id'];
1394           $softParams['soft_credit_type_id'] = $formValues['soft_credit_type_id'];
1395         }
1396       }
1397       if (!empty($formValues['send_receipt'])) {
1398         $paymentParams['email'] = $this->_contributorEmail;
1399       }
1400
1401       // This is a candidate for shared beginPostProcess function.
1402       CRM_Core_Payment_Form::mapParams($this->_bltID, $formValues, $paymentParams, TRUE);
1403       // CRM-7137 -for recurring membership,
1404       // we do need contribution and recurring records.
1405       $result = NULL;
1406       if (!empty($paymentParams['is_recur'])) {
1407         $financialType = new CRM_Financial_DAO_FinancialType();
1408         $financialType->id = $params['financial_type_id'];
1409         $financialType->find(TRUE);
1410         $this->_params = $formValues;
1411
1412         $contribution = CRM_Contribute_Form_Contribution_Confirm::processFormContribution($this,
1413           $paymentParams,
1414           NULL,
1415           array(
1416             'contact_id' => $this->_contributorContactID,
1417             'line_item' => $lineItem,
1418             'is_test' => $isTest,
1419             'campaign_id' => CRM_Utils_Array::value('campaign_id', $paymentParams),
1420             'contribution_page_id' => CRM_Utils_Array::value('contribution_page_id', $formValues),
1421             'source' => CRM_Utils_Array::value('source', $paymentParams, CRM_Utils_Array::value('description', $paymentParams)),
1422             'thankyou_date' => CRM_Utils_Array::value('thankyou_date', $paymentParams),
1423             'payment_instrument_id' => $paymentInstrumentID,
1424           ),
1425           $financialType,
1426           FALSE,
1427           $this->_bltID,
1428           TRUE
1429         );
1430
1431         //create new soft-credit record, CRM-13981
1432         if ($softParams) {
1433           $softParams['contribution_id'] = $contribution->id;
1434           $softParams['currency'] = $contribution->currency;
1435           $softParams['amount'] = $contribution->total_amount;
1436           CRM_Contribute_BAO_ContributionSoft::add($softParams);
1437         }
1438
1439         $paymentParams['contactID'] = $this->_contactID;
1440         $paymentParams['contributionID'] = $contribution->id;
1441         $paymentParams['contributionTypeID'] = $contribution->financial_type_id;
1442         $paymentParams['contributionPageID'] = $contribution->contribution_page_id;
1443         $paymentParams['contributionRecurID'] = $contribution->contribution_recur_id;
1444         $ids['contribution'] = $contribution->id;
1445         $params['contribution_recur_id'] = $paymentParams['contributionRecurID'];
1446       }
1447       $paymentStatus = NULL;
1448
1449       if ($params['total_amount'] > 0.0) {
1450         $payment = $this->_paymentProcessor['object'];
1451         try {
1452           $result = $payment->doPayment($paymentParams);
1453           $formValues = array_merge($formValues, $result);
1454           $paymentStatus = CRM_Core_PseudoConstant::getName('CRM_Contribute_BAO_Contribution', 'contribution_status_id', $formValues['payment_status_id']);
1455           // Assign amount to template if payment was successful.
1456           $this->assign('amount', $params['total_amount']);
1457         }
1458         catch (\Civi\Payment\Exception\PaymentProcessorException $e) {
1459           if (!empty($paymentParams['contributionID'])) {
1460             CRM_Contribute_BAO_Contribution::failPayment($paymentParams['contributionID'], $this->_contactID,
1461               $e->getMessage());
1462           }
1463           if (!empty($paymentParams['contributionRecurID'])) {
1464             CRM_Contribute_BAO_ContributionRecur::deleteRecurContribution($paymentParams['contributionRecurID']);
1465           }
1466
1467           CRM_Core_Session::singleton()->setStatus($e->getMessage());
1468           CRM_Utils_System::redirect(CRM_Utils_System::url('civicrm/contact/view/membership',
1469             "reset=1&action=add&cid={$this->_contactID}&context=membership&mode={$this->_mode}"
1470           ));
1471
1472         }
1473       }
1474
1475       if ($paymentStatus !== 'Completed') {
1476         $params['status_id'] = $pendingMembershipStatusId;
1477         $params['skipStatusCal'] = TRUE;
1478         // unset send-receipt option, since receipt will be sent when ipn is received.
1479         unset($formValues['send_receipt'], $formValues['send_receipt']);
1480         //as membership is pending set dates to null.
1481         $memberDates = array(
1482           'join_date' => 'joinDate',
1483           'start_date' => 'startDate',
1484           'end_date' => 'endDate',
1485         );
1486         foreach ($memberDates as $dv) {
1487           $$dv = NULL;
1488           foreach ($this->_memTypeSelected as $memType) {
1489             $membershipTypeValues[$memType][$dv] = NULL;
1490           }
1491         }
1492       }
1493       $now = date('YmdHis');
1494       $params['receive_date'] = date('YmdHis');
1495       $params['invoice_id'] = $formValues['invoiceID'];
1496       $params['contribution_source'] = ts('%1 Membership Signup: Credit card or direct debit (by %2)',
1497         array(1 => $membershipType, 2 => $userName)
1498       );
1499       $params['source'] = $formValues['source'] ? $formValues['source'] : $params['contribution_source'];
1500       $params['trxn_id'] = CRM_Utils_Array::value('trxn_id', $result);
1501       $params['is_test'] = ($this->_mode == 'live') ? 0 : 1;
1502       if (!empty($formValues['send_receipt'])) {
1503         $params['receipt_date'] = $now;
1504       }
1505       else {
1506         $params['receipt_date'] = NULL;
1507       }
1508
1509       $this->set('params', $formValues);
1510       $this->assign('trxn_id', CRM_Utils_Array::value('trxn_id', $result));
1511       $this->assign('receive_date',
1512         CRM_Utils_Date::mysqlToIso($params['receive_date'])
1513       );
1514
1515       // required for creating membership for related contacts
1516       $params['action'] = $this->_action;
1517
1518       //create membership record.
1519       $count = 0;
1520       foreach ($this->_memTypeSelected as $memType) {
1521         if ($count &&
1522           ($relateContribution = CRM_Member_BAO_Membership::getMembershipContributionId($membership->id))
1523         ) {
1524           $membershipTypeValues[$memType]['relate_contribution_id'] = $relateContribution;
1525         }
1526
1527         $membershipParams = array_merge($membershipTypeValues[$memType], $params);
1528         //CRM-15366
1529         if (!empty($softParams) && empty($paymentParams['is_recur'])) {
1530           $membershipParams['soft_credit'] = $softParams;
1531         }
1532         if (isset($result['fee_amount'])) {
1533           $membershipParams['fee_amount'] = $result['fee_amount'];
1534         }
1535         // This is required to trigger the recording of the membership contribution in the
1536         // CRM_Member_BAO_Membership::Create function.
1537         // @todo stop setting this & 'teach' the create function to respond to something
1538         // appropriate as part of our 2-step always create the pending contribution & then finally add the payment
1539         // process -
1540         // @see http://wiki.civicrm.org/confluence/pages/viewpage.action?pageId=261062657#Payments&AccountsRoadmap-Movetowardsalwaysusinga2-steppaymentprocess
1541         $membershipParams['contribution_status_id'] = CRM_Utils_Array::value('payment_status_id', $result);
1542         if (!empty($paymentParams['is_recur'])) {
1543           // The earlier process created the line items (although we want to get rid of the earlier one in favour
1544           // of a single path!
1545           unset($membershipParams['lineItems']);
1546         }
1547         $membershipParams['payment_instrument_id'] = $paymentInstrumentID;
1548         $membership = CRM_Member_BAO_Membership::create($membershipParams, $ids);
1549         $params['contribution'] = CRM_Utils_Array::value('contribution', $membershipParams);
1550         unset($params['lineItems']);
1551         $this->_membershipIDs[] = $membership->id;
1552         $createdMemberships[$memType] = $membership;
1553         $count++;
1554       }
1555
1556     }
1557     else {
1558       $params['action'] = $this->_action;
1559       if ($this->_onlinePendingContributionId && !empty($formValues['record_contribution'])) {
1560
1561         // update membership as well as contribution object, CRM-4395
1562         $params['contribution_id'] = $this->_onlinePendingContributionId;
1563         $params['componentId'] = $params['id'];
1564         $params['componentName'] = 'contribute';
1565         $result = CRM_Contribute_BAO_Contribution::transitionComponents($params, TRUE);
1566         if (!empty($result) && !empty($params['contribution_id'])) {
1567           $lineItem = array();
1568           $lineItems = CRM_Price_BAO_LineItem::getLineItemsByContributionID($params['contribution_id']);
1569           $itemId = key($lineItems);
1570           $priceSetId = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceField', $lineItems[$itemId]['price_field_id'], 'price_set_id');
1571
1572           $lineItems[$itemId]['unit_price'] = $params['total_amount'];
1573           $lineItems[$itemId]['line_total'] = $params['total_amount'];
1574           $lineItems[$itemId]['id'] = $itemId;
1575           $lineItem[$priceSetId] = $lineItems;
1576           $contributionBAO = new CRM_Contribute_BAO_Contribution();
1577           $contributionBAO->id = $params['contribution_id'];
1578           $contributionBAO->contact_id = $params['contact_id'];
1579           $contributionBAO->find();
1580           CRM_Price_BAO_LineItem::processPriceSet($params['contribution_id'], $lineItem, $contributionBAO, 'civicrm_membership');
1581
1582           //create new soft-credit record, CRM-13981
1583           if ($softParams) {
1584             $softParams['contribution_id'] = $params['contribution_id'];
1585             while ($contributionBAO->fetch()) {
1586               $softParams['currency'] = $contributionBAO->currency;
1587               $softParams['amount'] = $contributionBAO->total_amount;
1588             }
1589             CRM_Contribute_BAO_ContributionSoft::add($softParams);
1590           }
1591         }
1592
1593         //carry updated membership object.
1594         $membership = new CRM_Member_DAO_Membership();
1595         $membership->id = $this->_id;
1596         $membership->find(TRUE);
1597
1598         $cancelled = TRUE;
1599         if ($membership->end_date) {
1600           //display end date w/ status message.
1601           $endDate = $membership->end_date;
1602
1603           if (!in_array($membership->status_id, array(
1604             // CRM-15475
1605             array_search('Cancelled', CRM_Member_PseudoConstant::membershipStatus(NULL, " name = 'Cancelled' ", 'name', FALSE, TRUE)),
1606             array_search('Expired', CRM_Member_PseudoConstant::membershipStatus()),
1607           ))
1608           ) {
1609             $cancelled = FALSE;
1610           }
1611         }
1612         // suppress form values in template.
1613         $this->assign('cancelled', $cancelled);
1614
1615         $createdMemberships[] = $membership;
1616       }
1617       else {
1618         $count = 0;
1619         foreach ($this->_memTypeSelected as $memType) {
1620           if ($count && !empty($formValues['record_contribution']) &&
1621             ($relateContribution = CRM_Member_BAO_Membership::getMembershipContributionId($membership->id))
1622           ) {
1623             $membershipTypeValues[$memType]['relate_contribution_id'] = $relateContribution;
1624           }
1625
1626           $membershipParams = array_merge($params, $membershipTypeValues[$memType]);
1627           if (!empty($formValues['int_amount'])) {
1628             $init_amount = array();
1629             foreach ($formValues as $key => $value) {
1630               if (strstr($key, 'txt-price')) {
1631                 $init_amount[$key] = $value;
1632               }
1633             }
1634             $membershipParams['init_amount'] = $init_amount;
1635           }
1636
1637           if (!empty($softParams)) {
1638             $membershipParams['soft_credit'] = $softParams;
1639           }
1640
1641           $membership = CRM_Member_BAO_Membership::create($membershipParams, $ids);
1642           $params['contribution'] = CRM_Utils_Array::value('contribution', $membershipParams);
1643           unset($params['lineItems']);
1644           // skip line item creation for next interation since line item(s) are already created.
1645           $params['skipLineItem'] = TRUE;
1646
1647           $this->_membershipIDs[] = $membership->id;
1648           $createdMemberships[$memType] = $membership;
1649           $count++;
1650         }
1651       }
1652     }
1653     $isRecur = CRM_Utils_Array::value('is_recur', $params);
1654     if (($this->_action & CRM_Core_Action::UPDATE)) {
1655       $this->addStatusMessage($this->getStatusMessageForUpdate($membership, $endDate));
1656     }
1657     elseif (($this->_action & CRM_Core_Action::ADD)) {
1658       $this->addStatusMessage($this->getStatusMessageForCreate($endDate, $membershipTypes, $createdMemberships,
1659         $isRecur, $calcDates));
1660     }
1661
1662     if (!empty($lineItem[$this->_priceSetId])) {
1663       $invoiceSettings = Civi::settings()->get('contribution_invoice_settings');
1664       $invoicing = CRM_Utils_Array::value('invoicing', $invoiceSettings);
1665       $taxAmount = FALSE;
1666       $totalTaxAmount = 0;
1667       foreach ($lineItem[$this->_priceSetId] as & $priceFieldOp) {
1668         if (!empty($priceFieldOp['membership_type_id'])) {
1669           $priceFieldOp['start_date'] = $membershipTypeValues[$priceFieldOp['membership_type_id']]['start_date'] ? CRM_Utils_Date::customFormat($membershipTypeValues[$priceFieldOp['membership_type_id']]['start_date'], '%B %E%f, %Y') : '-';
1670           $priceFieldOp['end_date'] = $membershipTypeValues[$priceFieldOp['membership_type_id']]['end_date'] ? CRM_Utils_Date::customFormat($membershipTypeValues[$priceFieldOp['membership_type_id']]['end_date'], '%B %E%f, %Y') : '-';
1671         }
1672         else {
1673           $priceFieldOp['start_date'] = $priceFieldOp['end_date'] = 'N/A';
1674         }
1675         if ($invoicing && isset($priceFieldOp['tax_amount'])) {
1676           $taxAmount = TRUE;
1677           $totalTaxAmount += $priceFieldOp['tax_amount'];
1678         }
1679       }
1680       if ($invoicing) {
1681         $dataArray = array();
1682         foreach ($lineItem[$this->_priceSetId] as $key => $value) {
1683           if (isset($value['tax_amount']) && isset($value['tax_rate'])) {
1684             if (isset($dataArray[$value['tax_rate']])) {
1685               $dataArray[$value['tax_rate']] = $dataArray[$value['tax_rate']] + CRM_Utils_Array::value('tax_amount', $value);
1686             }
1687             else {
1688               $dataArray[$value['tax_rate']] = CRM_Utils_Array::value('tax_amount', $value);
1689             }
1690           }
1691         }
1692         if ($taxAmount) {
1693           $this->assign('totalTaxAmount', $totalTaxAmount);
1694           // Not sure why would need this on Submit.... unless it's being used when sending mails in which case this is the wrong place
1695           $this->assign('taxTerm', $this->getSalesTaxTerm());
1696         }
1697         $this->assign('dataArray', $dataArray);
1698       }
1699     }
1700     $this->assign('lineItem', !empty($lineItem) && !$isQuickConfig ? $lineItem : FALSE);
1701
1702     $receiptSend = FALSE;
1703     $contributionId = CRM_Member_BAO_Membership::getMembershipContributionId($membership->id);
1704     $membershipIds = $this->_membershipIDs;
1705     if ($contributionId && !empty($membershipIds)) {
1706       $contributionDetails = CRM_Contribute_BAO_Contribution::getContributionDetails(
1707         CRM_Export_Form_Select::MEMBER_EXPORT, $this->_membershipIDs);
1708       if ($contributionDetails[$membership->id]['contribution_status'] == 'Completed') {
1709         $receiptSend = TRUE;
1710       }
1711     }
1712
1713     $receiptSent = FALSE;
1714     if (!empty($formValues['send_receipt']) && $receiptSend) {
1715       $formValues['contact_id'] = $this->_contactID;
1716       $formValues['contribution_id'] = $contributionId;
1717       // We really don't need a distinct receipt_text_signup vs receipt_text_renewal as they are
1718       // handled in the receipt. But by setting one we avoid breaking templates for now
1719       // although at some point we should switch in the templates.
1720       $formValues['receipt_text_signup'] = $formValues['receipt_text'];
1721       // send email receipt
1722       $this->assignBillingName();
1723       $mailSend = $this->emailMembershipReceipt($formValues, $membership);
1724       $receiptSent = TRUE;
1725     }
1726
1727     // finally set membership id if already not set
1728     if (!$this->_id) {
1729       $this->_id = $membership->id;
1730     }
1731
1732     $this->updateContributionOnMembershipTypeChange($params, $membership);
1733     if ($receiptSent && $mailSend) {
1734       $this->addStatusMessage(ts('A membership confirmation and receipt has been sent to %1.', array(1 => $this->_contributorEmail)));
1735     }
1736
1737     CRM_Core_Session::setStatus($this->getStatusMessage(), ts('Complete'), 'success');
1738     $this->setStatusMessage($membership);
1739   }
1740
1741   /**
1742    * Update related contribution of a membership if update_contribution_on_membership_type_change
1743    *   contribution setting is enabled and type is changed on edit
1744    *
1745    * @param array $inputParams
1746    *      submitted form values
1747    * @param CRM_Member_DAO_Membership $membership
1748    *     Updated membership object
1749    *
1750    */
1751   protected function updateContributionOnMembershipTypeChange($inputParams, $membership) {
1752     if (Civi::settings()->get('update_contribution_on_membership_type_change') &&
1753       ($this->_action & CRM_Core_Action::UPDATE) && // on update
1754       $this->_id && // if ID is present
1755       !in_array($this->_memType, $this->_memTypeSelected) // if selected membership doesn't match with earlier membership
1756     ) {
1757       if (CRM_Utils_Array::value('is_recur', $inputParams)) {
1758         CRM_Core_Session::setStatus(ts('Associated recurring contribution cannot be updated on membership type change.', ts('Error'), 'error'));
1759         return;
1760       }
1761
1762       // fetch lineitems by updated membership ID
1763       $lineItems = CRM_Price_BAO_LineItem::getLineItems($membership->id, 'membership');
1764       // retrieve the related contribution ID
1765       $contributionID = CRM_Core_DAO::getFieldValue(
1766         'CRM_Member_DAO_MembershipPayment',
1767         $membership->id,
1768         'contribution_id',
1769         'membership_id'
1770       );
1771       // get price fields of chosen price-set
1772       $priceSetDetails = CRM_Utils_Array::value(
1773         $this->_priceSetId,
1774         CRM_Price_BAO_PriceSet::getSetDetail(
1775           $this->_priceSetId,
1776           TRUE,
1777           TRUE
1778         )
1779       );
1780
1781       // add price field information in $inputParams
1782       self::addPriceFieldByMembershipType($inputParams, $priceSetDetails['fields'], $membership->membership_type_id);
1783
1784       // update related contribution and financial records
1785       CRM_Price_BAO_LineItem::changeFeeSelections(
1786         $inputParams,
1787         $membership->id,
1788         'membership',
1789         $contributionID,
1790         $priceSetDetails['fields'],
1791         $lineItems
1792       );
1793       CRM_Core_Session::setStatus(ts('Associated contribution is updated on membership type change.'), ts('Success'), 'success');
1794     }
1795   }
1796
1797   /**
1798    * Add selected price field information in $formValues
1799    *
1800    * @param array $formValues
1801    *      submitted form values
1802    * @param array $priceFields
1803    *     Price fields of selected Priceset ID
1804    * @param int $membershipTypeID
1805    *     Selected membership type ID
1806    *
1807    */
1808   public static function addPriceFieldByMembershipType(&$formValues, $priceFields, $membershipTypeID) {
1809     foreach ($priceFields as $priceFieldID => $priceField) {
1810       if (isset($priceField['options']) && count($priceField['options'])) {
1811         foreach ($priceField['options'] as $option) {
1812           if ($option['membership_type_id'] == $membershipTypeID) {
1813             $formValues["price_{$priceFieldID}"] = $option['id'];
1814             break;
1815           }
1816         }
1817       }
1818     }
1819   }
1820   /**
1821    * Set context in session.
1822    */
1823   protected function setUserContext() {
1824     $buttonName = $this->controller->getButtonName();
1825     $session = CRM_Core_Session::singleton();
1826
1827     if ($this->_context == 'standalone') {
1828       if ($buttonName == $this->getButtonName('upload', 'new')) {
1829         $session->replaceUserContext(CRM_Utils_System::url('civicrm/member/add',
1830           'reset=1&action=add&context=standalone'
1831         ));
1832       }
1833       else {
1834         $session->replaceUserContext(CRM_Utils_System::url('civicrm/contact/view',
1835           "reset=1&cid={$this->_contactID}&selectedChild=member"
1836         ));
1837       }
1838     }
1839     elseif ($buttonName == $this->getButtonName('upload', 'new')) {
1840       $session->replaceUserContext(CRM_Utils_System::url('civicrm/contact/view/membership',
1841         "reset=1&action=add&context=membership&cid={$this->_contactID}"
1842       ));
1843     }
1844   }
1845
1846   /**
1847    * Get status message for updating membership.
1848    *
1849    * @param CRM_Member_BAO_Membership $membership
1850    * @param string $endDate
1851    *
1852    * @return string
1853    */
1854   protected function getStatusMessageForUpdate($membership, $endDate) {
1855     // End date can be modified by hooks, so if end date is set then use it.
1856     $endDate = ($membership->end_date) ? $membership->end_date : $endDate;
1857
1858     $statusMsg = ts('Membership for %1 has been updated.', array(1 => $this->_memberDisplayName));
1859     if ($endDate && $endDate !== 'null') {
1860       $endDate = CRM_Utils_Date::customFormat($endDate);
1861       $statusMsg .= ' ' . ts('The membership End Date is %1.', array(1 => $endDate));
1862     }
1863     return $statusMsg;
1864   }
1865
1866   /**
1867    * Get status message for create action.
1868    *
1869    * @param string $endDate
1870    * @param array $membershipTypes
1871    * @param array $createdMemberships
1872    * @param bool $isRecur
1873    * @param array $calcDates
1874    *
1875    * @return array|string
1876    */
1877   protected function getStatusMessageForCreate($endDate, $membershipTypes, $createdMemberships,
1878                                                $isRecur, $calcDates) {
1879     // FIX ME: fix status messages
1880
1881     $statusMsg = array();
1882     foreach ($membershipTypes as $memType => $membershipType) {
1883       $statusMsg[$memType] = ts('%1 membership for %2 has been added.', array(
1884         1 => $membershipType,
1885         2 => $this->_memberDisplayName,
1886       ));
1887
1888       $membership = $createdMemberships[$memType];
1889       $memEndDate = ($membership->end_date) ? $membership->end_date : $endDate;
1890
1891       //get the end date from calculated dates.
1892       if (!$memEndDate && !$isRecur) {
1893         $memEndDate = CRM_Utils_Array::value('end_date', $calcDates[$memType]);
1894       }
1895
1896       if ($memEndDate && $memEndDate !== 'null') {
1897         $memEndDate = CRM_Utils_Date::customFormat($memEndDate);
1898         $statusMsg[$memType] .= ' ' . ts('The new membership End Date is %1.', array(1 => $memEndDate));
1899       }
1900     }
1901     $statusMsg = implode('<br/>', $statusMsg);
1902     return $statusMsg;
1903   }
1904
1905   /**
1906    * @param $membership
1907    */
1908   protected function setStatusMessage($membership) {
1909     //CRM-15187
1910     // display message when membership type is changed
1911     if (($this->_action & CRM_Core_Action::UPDATE) && $this->_id && !in_array($this->_memType, $this->_memTypeSelected)) {
1912       $lineItem = CRM_Price_BAO_LineItem::getLineItems($this->_id, 'membership');
1913       $maxID = max(array_keys($lineItem));
1914       $lineItem = $lineItem[$maxID];
1915       $membershipTypeDetails = $this->allMembershipTypeDetails[$membership->membership_type_id];
1916       if ($membershipTypeDetails['financial_type_id'] != $lineItem['financial_type_id']) {
1917         CRM_Core_Session::setStatus(
1918           ts('The financial types associated with the old and new membership types are different. You may want to edit the contribution associated with this membership to adjust its financial type.'),
1919           ts('Warning')
1920         );
1921       }
1922       if ($membershipTypeDetails['minimum_fee'] != $lineItem['line_total']) {
1923         CRM_Core_Session::setStatus(
1924           ts('The cost of the old and new membership types are different. You may want to edit the contribution associated with this membership to adjust its amount.'),
1925           ts('Warning')
1926         );
1927       }
1928     }
1929   }
1930
1931   /**
1932    * @return bool
1933    */
1934   protected function isUpdateToExistingRecurringMembership() {
1935     $isRecur = FALSE;
1936     if ($this->_action & CRM_Core_Action::UPDATE
1937       && CRM_Core_DAO::getFieldValue('CRM_Member_DAO_Membership', $this->getEntityId(),
1938         'contribution_recur_id')
1939       && !CRM_Member_BAO_Membership::isSubscriptionCancelled($this->getEntityId())) {
1940
1941       $isRecur = TRUE;
1942     }
1943     return $isRecur;
1944   }
1945
1946   /**
1947    * Send a receipt for the membership.
1948    *
1949    * @param array $formValues
1950    * @param \CRM_Member_BAO_Membership $membership
1951    *
1952    * @return bool
1953    */
1954   protected function emailMembershipReceipt($formValues, $membership) {
1955     $customValues = $this->getCustomValuesForReceipt($formValues, $membership);
1956
1957     return self::emailReceipt($this, $formValues, $membership, $customValues);
1958   }
1959
1960   /**
1961    * Filter the custom values from the input parameters (for display in the email).
1962    *
1963    * @todo figure out why the scary code this calls does & document.
1964    *
1965    * @param array $formValues
1966    * @param \CRM_Member_BAO_Membership $membership
1967    * @return array
1968    */
1969   protected function getCustomValuesForReceipt($formValues, $membership) {
1970     $customFields = $customValues = [];
1971     if (property_exists($this, '_groupTree')
1972       && !empty($this->_groupTree)
1973     ) {
1974       foreach ($this->_groupTree as $groupID => $group) {
1975         if ($groupID == 'info') {
1976           continue;
1977         }
1978         foreach ($group['fields'] as $k => $field) {
1979           $field['title'] = $field['label'];
1980           $customFields["custom_{$k}"] = $field;
1981         }
1982       }
1983     }
1984
1985     $members = [['member_id', '=', $membership->id, 0, 0]];
1986     // check whether its a test drive
1987     if ($this->_mode == 'test') {
1988       $members[] = ['member_test', '=', 1, 0, 0];
1989     }
1990
1991     CRM_Core_BAO_UFGroup::getValues($formValues['contact_id'], $customFields, $customValues, FALSE, $members);
1992     return $customValues;
1993   }
1994
1995 }