CRM/Member/Form/Membership.php

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