CRM/Member/Form/Membership.php

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