CRM/Member/Form/Membership.php

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