3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2015 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2015
37 * This class generates form components for offline membership form
40 class CRM_Member_Form_Membership
extends CRM_Member_Form
{
42 protected $_memType = NULL;
44 protected $_onlinePendingContributionId;
48 public $_contributeMode = 'direct';
50 protected $_recurMembershipTypes;
52 protected $_memTypeSelected;
55 * Display name of the member.
59 protected $_memberDisplayName = NULL;
62 * email of the person paying for the membership (used for receipts)
64 protected $_memberEmail = NULL;
67 * Contact ID of the member.
71 public $_contactID = NULL;
74 * Display name of the person paying for the membership (used for receipts)
78 protected $_contributorDisplayName = NULL;
81 * email of the person paying for the membership (used for receipts)
83 protected $_contributorEmail = NULL;
86 * email of the person paying for the membership (used for receipts)
90 protected $_contributorContactID = NULL;
93 * ID of the person the receipt is to go to.
97 protected $_receiptContactId = NULL;
100 * Keep a class variable for ALL membeshipID's so
101 * postProcess hook function can do something with it
105 protected $_membershipIDs = array();
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
113 protected $_dateFields = array(
114 'receive_date' => array('default' => 'now'),
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);
126 parent
::preProcess();
128 $this->_priceSetId
= CRM_Utils_Array
::value('priceSetId', $_GET);
129 $this->set('priceSetId', $this->_priceSetId
);
130 $this->assign('priceSetId', $this->_priceSetId
);
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.'));
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."));
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'));
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'];
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']);
168 $mem['membership_type'] = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType',
169 $mem['membership_type_id'],
172 $mem['membership_status'] = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipStatus',
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' : '')
180 $mem['membershipTab'] = CRM_Utils_System
::url('civicrm/contact/view',
181 "reset=1&force=1&cid={$this->_contactID}&selectedChild=member"
183 $mems_by_org[$mem['member_of_contact_id']] = $mem;
185 $this->assign('existingContactMemberships', $mems_by_org);
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');
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'),
197 $resources->addSetting(array('existingMems' => $passthru));
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);
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
,
215 $this->assign('onlinePendingContributionId', $this->_onlinePendingContributionId
);
217 $this->setPageTitle(ts('Membership'));
221 * Set default values for the form. MobileProvider that in edit/view mode
222 * the default values are retrieved from the database
227 public function setDefaultValues() {
228 if ($this->_cdType
) {
229 return CRM_Custom_Form_CustomData
::setDefaultValues($this);
232 if ($this->_priceSetId
) {
233 return CRM_Price_BAO_PriceSet
::setDefaultPriceSet($this, $defaults);
236 $defaults = parent
::setDefaultValues();
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;
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',
249 'member_of_contact_id',
252 $defaults['membership_type_id'][1] = $this->_memType
;
255 $defaults['membership_type_id'] = $this->_memType
;
258 $defaults['num_terms'] = 1;
260 if (!empty($defaults['id'])) {
261 if ($this->_onlinePendingContributionId
) {
262 $defaults['record_contribution'] = $this->_onlinePendingContributionId
;
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
272 if ($contributionId) {
273 $defaults['record_contribution'] = $contributionId;
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));
282 if (!empty($defaults['record_contribution']) && !$this->_mode
) {
283 $contributionParams = array('id' => $defaults['record_contribution']);
284 $contributionIds = array();
286 //keep main object campaign in hand.
287 $memberCampaignId = CRM_Utils_Array
::value('campaign_id', $defaults);
289 CRM_Contribute_BAO_Contribution
::getValues($contributionParams, $defaults, $contributionIds);
291 //get back original object campaign id.
292 $defaults['campaign_id'] = $memberCampaignId;
294 if (!empty($defaults['receive_date'])) {
295 list($defaults['receive_date']) = CRM_Utils_Date
::setDateDefaults($defaults['receive_date']);
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'];
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'));
308 // User must explicitly choose to send a receipt in both add and update mode.
309 $defaults['send_receipt'] = 0;
311 if ($this->_action
& CRM_Core_Action
::UPDATE
) {
312 // in this mode by default uncheck this checkbox
313 unset($defaults['record_contribution']);
316 if (!empty($defaults['id'])) {
317 $subscriptionCancelled = CRM_Member_BAO_Membership
::isSubscriptionCancelled($this->_id
);
320 $alreadyAutoRenew = FALSE;
321 if (!empty($defaults['contribution_recur_id']) && !$subscriptionCancelled) {
322 $defaults['auto_renew'] = 1;
323 $alreadyAutoRenew = TRUE;
325 $this->assign('alreadyAutoRenew', $alreadyAutoRenew);
327 $this->assign('member_is_test', CRM_Utils_Array
::value('member_is_test', $defaults));
329 $this->assign('membership_status_id', CRM_Utils_Array
::value('status_id', $defaults));
331 if (!empty($defaults['is_pay_later'])) {
332 $this->assign('is_pay_later', TRUE);
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
;
341 if (empty($defaults["billing_state_province_id-{$this->_bltID}"])) {
342 $defaults["billing_state_province_id-{$this->_bltID}"] = $config->defaultContactStateProvince
;
345 $billingDefaults = $this->getProfileDefaults('Billing', $this->_contactID
);
346 $defaults = array_merge($defaults, $billingDefaults);
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' );
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));
362 //setting default join date if there is no join date
363 if (empty($defaults['join_date'])) {
364 $defaults['join_date'] = $now;
367 if (!empty($defaults['membership_end_date'])) {
368 $this->assign('endDate', $defaults['membership_end_date']);
375 * Build the form object.
379 public function buildQuickForm() {
380 if ($this->_cdType
) {
381 return CRM_Custom_Form_CustomData
::buildQuickForm($this);
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));
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;
398 $getOnlyPriceSetElements = TRUE;
399 if (!$this->_priceSetId
) {
400 $this->_priceSetId
= $_POST['price_set_id'];
401 $getOnlyPriceSetElements = FALSE;
404 $this->set('priceSetId', $this->_priceSetId
);
405 CRM_Price_BAO_PriceSet
::buildPriceSet($this);
407 $optionsMembershipTypes = array();
408 foreach ($this->_priceSet
['fields'] as $pField) {
409 if (empty($pField['options'])) {
412 foreach ($pField['options'] as $opId => $opValues) {
413 $optionsMembershipTypes[$opId] = CRM_Utils_Array
::value('membership_type_id', $opValues, 0);
417 $this->assign('autoRenewOption', CRM_Price_BAO_PriceSet
::checkAutoRenewForPriceSet($this->_priceSetId
));
419 $this->assign('optionsMembershipTypes', $optionsMembershipTypes);
420 $this->assign('contributionType', CRM_Utils_Array
::value('financial_type_id', $this->_priceSet
));
422 // get only price set form elements.
423 if ($getOnlyPriceSetElements) {
428 // use to build form during form rule.
429 $this->assign('buildPriceSet', $buildPriceSet);
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;
438 if ($buildPriceSet) {
439 $this->add('select', 'price_set_id', ts('Choose price set'),
441 '' => ts('Choose price set'),
443 NULL, array('onchange' => "buildAmount( this.value );")
446 $this->assign('hasPriceSets', $buildPriceSet);
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
);
454 if ($this->_action
& CRM_Core_Action
::DELETE
) {
455 $this->addButtons(array(
458 'name' => ts('Delete'),
459 'spacing' => ' ',
464 'name' => ts('Cancel'),
471 if ($this->_context
== 'standalone') {
472 $this->addEntityRef('contact_id', ts('Contact'), array(
474 'api' => array('extra' => array('email')),
478 $selOrgMemType[0][0] = $selMemTypeOrg[0] = ts('- select -');
480 $dao = new CRM_Member_DAO_MembershipType();
481 $dao->domain_id
= CRM_Core_Config
::domainID();
484 // retrieve all memberships
485 $allMemberships = CRM_Member_BAO_Membership
::buildMembershipTypeValues($this);
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'])) {
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',
503 $selOrgMemType[$memberOfContactId][0] = ts('- select -');
505 if (empty($selOrgMemType[$memberOfContactId][$key])) {
506 $selOrgMemType[$memberOfContactId][$key] = CRM_Utils_Array
::value('name', $values);
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),
524 $this->assign('allMembershipInfo', json_encode($allMembershipInfo));
526 // show organization by default, if only one organization in
528 if (count($selMemTypeOrg) == 2) {
529 unset($selMemTypeOrg[0], $selOrgMemType[0][0]);
531 //sort membership organization and type, CRM-6099
532 natcasesort($selMemTypeOrg);
533 foreach ($selOrgMemType as $index => $orgMembershipType) {
534 natcasesort($orgMembershipType);
535 $selOrgMemType[$index] = $orgMembershipType;
538 $memTypeJs = array('onChange' => "CRM.buildCustomData( 'Membership', this.value );");
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',
545 ts('Membership renewed automatically'),
547 array('onclick' => "buildReceiptANDNotice( );")
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_key($this->_processors
, $recurring);
555 $autoRenew = array();
556 if (!empty($recurProcessor)) {
557 if (!empty($membershipType)) {
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
;
574 $this->_recurMembershipTypes
[$recurMembershipTypes->id
][$fld] = $recurMembershipTypes->$fld;
580 "CRM.buildCustomData( 'Membership', this.value ); buildAutoRenew(this.value, null );",
585 $allowAutoRenew = FALSE;
586 if ($this->_mode
&& !empty($recurProcessor)) {
587 $allowAutoRenew = TRUE;
589 $this->assign('allowAutoRenew', $allowAutoRenew);
590 $this->assign('autoRenewOptions', json_encode($autoRenew));
591 $this->assign('recurProcessor', json_encode($recurProcessor));
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')
599 $sel = &$this->addElement('hierselect',
600 'membership_type_id',
601 ts('Membership Organization and Type'),
605 $sel->setOptions(array($selMemTypeOrg, $selOrgMemType));
611 $this->applyFilter('__ALL__', 'trim');
613 if ($this->_action
& CRM_Core_Action
::ADD
) {
614 $this->add('text', 'num_terms', ts('Number of Terms'), array('size' => 6));
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'));
621 $elements[] = $endDate;
624 $this->add('text', 'source', ts('Source'),
625 CRM_Core_DAO
::getAttribute('CRM_Member_DAO_Membership', 'source')
628 //CRM-7362 --add campaigns.
631 $campaignId = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership', $this->_id
, 'campaign_id');
633 CRM_Campaign_BAO_Campaign
::addCampaign($this, $campaignId);
636 $this->add('select', 'status_id', ts('Membership Status'),
637 array('' => ts('- select -')) + CRM_Member_PseudoConstant
::membershipStatus(NULL, NULL, 'label')
639 $statusOverride = $this->addElement('checkbox', 'is_override',
640 ts('Status Override?'), NULL,
641 array('onClick' => 'showHideMemberStatus()')
643 if ($statusOverride) {
644 $elements[] = $statusOverride;
647 $this->addElement('checkbox', 'record_contribution', ts('Record Membership Payment?'));
649 $this->add('text', 'total_amount', ts('Amount'));
650 $this->addRule('total_amount', ts('Please enter a valid amount.'), 'money');
652 $this->addDate('receive_date', ts('Received'), FALSE, array('formatType' => 'activityDateTime'));
654 $this->add('select', 'payment_instrument_id',
656 array('' => ts('- select -')) + CRM_Contribute_PseudoConstant
::paymentInstrument(),
657 FALSE, array('onChange' => "return showHideByValue('payment_instrument_id','4','checkNumber','table-row','select',false);")
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')
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(
676 $allowStatuses[$val] = $statuses[$val];
680 $allowStatuses = $statuses;
682 $this->add('select', 'contribution_status_id',
683 ts('Payment Status'), $allowStatuses
685 $this->add('text', 'check_number', ts('Check Number'),
686 CRM_Core_DAO
::getAttribute('CRM_Contribute_DAO_Contribution', 'check_number')
690 //add field for amount to allow an amount to be entered that differs from minimum
691 $this->add('text', 'total_amount', ts('Amount'));
693 $this->add('select', 'financial_type_id',
694 ts('Financial Type'),
695 array('' => ts('- select -')) + CRM_Contribute_PseudoConstant
::financialType()
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));
704 $this->addElement('checkbox',
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);")
710 $this->add('select', 'from_email_address', ts('Receipt From'), $this->_fromEmails
);
712 $this->add('textarea', 'receipt_text_signup', ts('Receipt Message'));
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
,
718 ) = CRM_Contact_BAO_Contact_Location
::getEmailDetails($this->_contactID
);
720 $this->assign('emailExists', $this->_memberEmail
);
721 $this->assign('displayName', $this->_memberDisplayName
);
725 if ($this->_action
& CRM_Core_Action
::UPDATE
) {
726 $recurContributionId = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership', $this->_id
,
727 'contribution_recur_id'
729 if ($recurContributionId && !CRM_Member_BAO_Membership
::isSubscriptionCancelled($this->_id
)) {
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}")
736 foreach ($elements as $elem) {
741 $this->assign('isRecur', $isRecur);
743 $this->addFormRule(array('CRM_Member_Form_Membership', 'formRule'), $this);
745 $mailingInfo = CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::MAILING_PREFERENCES_NAME
,
748 $this->assign('outBound_option', $mailingInfo['outBound_option']);
750 parent
::buildQuickForm();
756 * @param array $params
757 * (ref.) an assoc array of name/value pairs.
762 * @throws CiviCRM_API3_Exception
764 * mixed true or array of errors
766 public static function formRule($params, $files, $self) {
769 $priceSetId = CRM_Utils_Array
::value('price_set_id', $params);
772 CRM_Price_BAO_PriceField
::priceSetValidation($priceSetId, $params, $errors);
774 $priceFieldIDS = array();
775 foreach ($self->_priceSet
['fields'] as $priceIds => $dontCare) {
777 if (!empty($params['price_' . $priceIds])) {
778 if (is_array($params['price_' . $priceIds])) {
779 foreach ($params['price_' . $priceIds] as $priceFldVal => $isSet) {
781 $priceFieldIDS[] = $priceFldVal;
786 $priceFieldIDS[] = $params['price_' . $priceIds];
791 if (!empty($priceFieldIDS)) {
792 $ids = implode(',', $priceFieldIDS);
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.');
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;
808 elseif (empty($params['membership_type_id'][1])) {
809 $errors['membership_type_id'] = ts('Please select a membership type.');
812 $self->_memTypeSelected
[] = $params['membership_type_id'][1];
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.');
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.');
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.');
837 if (!empty($errors)) {
841 if ($priceSetId && !$self->_mode
&& empty($params['record_contribution'])) {
842 $errors['record_contribution'] = ts('Record Membership Payment is required when you using price set.');
845 if (!$priceSetId && $self->_mode
&& empty($params['financial_type_id'])) {
846 $errors['financial_type_id'] = ts('Please enter the financial Type.');
849 if (!empty($params['record_contribution']) && empty($params['payment_instrument_id'])) {
850 $errors['payment_instrument_id'] = ts('Paid By is a required field.');
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');
857 if (empty($params['soft_credit_contact_id'])) {
858 $errors['soft_credit_contact_id'] = ts('Please select a contact');
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);
868 if (!empty($params['join_date'])) {
870 $joinDate = CRM_Utils_Date
::processDate($params['join_date']);
872 foreach ($self->_memTypeSelected
as $memType) {
874 if (!empty($params['start_date'])) {
875 $startDate = CRM_Utils_Date
::processDate($params['start_date']);
878 // if end date is set, ensure that start date is also set
879 // and that end date is later than start date
881 if (!empty($params['end_date'])) {
882 $endDate = CRM_Utils_Date
::processDate($params['end_date']);
885 $membershipDetails = CRM_Member_BAO_MembershipType
::getMembershipTypeDetails($memType);
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.');
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(
899 'is_current_member' => 0,
901 $tmp_statuses = $result['values'];
902 $status_ids = array();
903 foreach ($tmp_statuses as $cur_stat) {
904 $status_ids[] = $cur_stat['id'];
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');
913 $errors['start_date'] = ts('Start date must be set if end date is set.');
915 if ($endDate < $startDate) {
916 $errors['end_date'] = ts('End date must be the same or later than start date.');
921 // Default values for start and end dates if not supplied
923 $defaultDates = CRM_Member_BAO_MembershipType
::getDatesForMembershipType($memType,
930 $startDate = CRM_Utils_Array
::value('start_date',
935 $endDate = CRM_Utils_Array
::value('end_date',
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,
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));
955 $status .= ' ' . ts('OR You can sign up by setting Status Override? to true.');
957 CRM_Core_Session
::setStatus($status, ts('Membership Status Error'), 'error');
963 $errors['join_date'] = ts('Please enter the Member Since.');
966 if (isset($params['is_override']) &&
967 $params['is_override'] && empty($params['status_id'])
969 $errors['status_id'] = ts('Please enter the status.');
972 //total amount condition arise when membership type having no
974 if (isset($params['record_contribution'])) {
975 if (!$params['financial_type_id']) {
976 $errors['financial_type_id'] = ts('Please enter the financial Type.');
978 if (CRM_Utils_System
::isNull($params['total_amount'])) {
979 $errors['total_amount'] = ts('Please enter the contribution.');
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'))
989 $errors['contribution_status_id'] = ts('Please select a valid payment status before updating.');
992 return empty($errors) ?
TRUE : $errors;
996 * Process the form submission.
1001 public function postProcess() {
1002 if ($this->_action
& CRM_Core_Action
::DELETE
) {
1003 CRM_Member_BAO_Membership
::del($this->_id
);
1007 $allMemberStatus = CRM_Member_PseudoConstant
::membershipStatus();
1008 $allContributionStatus = CRM_Contribute_PseudoConstant
::contributionStatus();
1010 $isTest = ($this->_mode
== 'test') ?
1 : 0;
1013 if (!empty($this->_lineItem
)) {
1014 $lineItems = $this->_lineItem
;
1017 $config = CRM_Core_Config
::singleton();
1018 // get the submitted form values.
1019 $this->_params
= $formValues = $this->controller
->exportValues($this->_name
);
1020 $this->convertDateFieldsToMySQL($formValues);
1022 $params = $softParams = $ids = array();
1024 $membershipTypeValues = array();
1025 foreach ($this->_memTypeSelected
as $memType) {
1026 $membershipTypeValues[$memType]['membership_type_id'] = $memType;
1029 //take the required membership recur values.
1030 if ($this->_mode
&& !empty($this->_params
['auto_renew'])) {
1031 $params['is_recur'] = $this->_params
['is_recur'] = $formValues['is_recur'] = TRUE;
1033 'frequency_interval' => 'duration_interval',
1034 'frequency_unit' => 'duration_unit',
1038 foreach ($this->_memTypeSelected
as $memType) {
1039 $recurMembershipTypeValues = CRM_Utils_Array
::value($memType,
1040 $this->_recurMembershipTypes
, array()
1042 foreach ($mapping as $mapVal => $mapParam) {
1043 $membershipTypeValues[$memType][$mapVal] = CRM_Utils_Array
::value($mapParam,
1044 $recurMembershipTypeValues
1047 $this->_params
[$mapVal] = $formValues[$mapVal] = CRM_Utils_Array
::value($mapParam,
1048 $recurMembershipTypeValues
1056 // process price set and get total amount and line items.
1057 $lineItem = array();
1059 if (!$priceSetId = CRM_Utils_Array
::value('price_set_id', $formValues)) {
1060 CRM_Member_BAO_Membership
::createLineItems($this, $formValues['membership_type_id'], $priceSetId);
1063 if ($this->_priceSetId
&& CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet', $this->_priceSetId
, 'is_quick_config')) {
1067 $termsByType = array();
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'];
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'];
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;
1094 $this->storeContactFields($formValues);
1096 $params['contact_id'] = $this->_contactID
;
1105 foreach ($fields as $f) {
1106 $params[$f] = CRM_Utils_Array
::value($f, $formValues);
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;
1116 // process date params to mysql date format.
1118 'join_date' => 'joinDate',
1119 'start_date' => 'startDate',
1120 'end_date' => 'endDate',
1122 foreach ($dateTypes as $dateField => $dateVariable) {
1123 $
$dateVariable = CRM_Utils_Date
::processDate($formValues[$dateField]);
1126 $memTypeNumTerms = empty($termsByType) ? CRM_Utils_Array
::value('num_terms', $formValues) : NULL;
1128 $calcDates = array();
1129 foreach ($this->_memTypeSelected
as $memType) {
1130 if (empty($memTypeNumTerms)) {
1131 $memTypeNumTerms = CRM_Utils_Array
::value($memType, $termsByType, 1);
1133 $calcDates[$memType] = CRM_Member_BAO_MembershipType
::getDatesForMembershipType($memType,
1134 $joinDate, $startDate, $endDate, $memTypeNumTerms
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);
1143 $date = CRM_Utils_Array
::value($d, $calcDate);
1146 $membershipTypeValues[$memType][$d] = CRM_Utils_Date
::processDate($date);
1147 //$params[$d] = CRM_Utils_Date::processDate( $date );
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);
1159 $ids['membership'] = $params['id'] = $this->_id
;
1162 $session = CRM_Core_Session
::singleton();
1163 $ids['userId'] = $session->get('userID');
1165 // membership type custom data
1166 foreach ($this->_memTypeSelected
as $memType) {
1167 $customFields = CRM_Core_BAO_CustomField
::getFields('Membership', FALSE, FALSE,
1171 $customFields = CRM_Utils_Array
::crmArrayMerge($customFields,
1172 CRM_Core_BAO_CustomField
::getFields('Membership',
1178 $membershipTypeValues[$memType]['custom'] = CRM_Core_BAO_CustomField
::postProcess($formValues,
1185 foreach ($this->_memTypeSelected
as $memType) {
1186 $membershipTypes[$memType] = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType',
1191 $membershipType = implode(', ', $membershipTypes);
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']);
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
;
1204 if (!empty($formValues['record_contribution'])) {
1205 $recordContribution = array(
1207 'financial_type_id',
1208 'payment_instrument_id',
1210 'contribution_status_id',
1216 foreach ($recordContribution as $f) {
1217 $params[$f] = CRM_Utils_Array
::value($f, $formValues);
1220 if (!$this->_onlinePendingContributionId
) {
1221 if (empty($formValues['source'])) {
1222 $params['contribution_source'] = ts('%1 Membership: Offline signup (by %2)', array(
1223 1 => $membershipType,
1228 $params['contribution_source'] = $formValues['source'];
1232 if (empty($params['is_override']) &&
1233 CRM_Utils_Array
::value('contribution_status_id', $params) == array_search('Pending', CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name'))
1235 $params['status_id'] = array_search('Pending', $allMemberStatus);
1236 $params['skipStatusCal'] = TRUE;
1237 $params['is_pay_later'] = 1;
1238 $this->assign('is_pay_later', 1);
1241 if (!empty($formValues['send_receipt'])) {
1242 $params['receipt_date'] = CRM_Utils_Array
::value('receive_date', $formValues);
1245 //insert financial type name in receipt.
1246 $formValues['contributionType_name'] = CRM_Core_DAO
::getFieldValue('CRM_Financial_DAO_FinancialType',
1247 $formValues['financial_type_id']
1251 // process line items, until no previous line items.
1252 if (!empty($lineItem)) {
1253 $params['lineItems'] = $lineItem;
1254 $params['processPriceSet'] = TRUE;
1256 $createdMemberships = array();
1258 if (empty($formValues['total_amount']) && !$priceSetId) {
1259 // if total amount not provided minimum for membership type is used
1260 $params['total_amount'] = $formValues['total_amount'] = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType',
1261 $formValues['membership_type_id'][1], 'minimum_fee'
1265 $params['total_amount'] = CRM_Utils_Array
::value('total_amount', $formValues, 0);
1268 if ($priceSetId && !$isQuickConfig) {
1269 $params['financial_type_id'] = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet',
1275 $params['financial_type_id'] = CRM_Utils_Array
::value('financial_type_id', $formValues);
1278 $this->_paymentProcessor
= CRM_Financial_BAO_PaymentProcessor
::getPayment($formValues['payment_processor_id'],
1282 //get the payment processor id as per mode.
1283 $params['payment_processor_id'] = $this->_params
['payment_processor_id'] = $formValues['payment_processor_id'] = $this->_paymentProcessor
['id'];
1285 $now = date('YmdHis');
1288 // set email for primary location.
1289 $fields['email-Primary'] = 1;
1290 $formValues['email-5'] = $formValues['email-Primary'] = $this->_memberEmail
;
1291 $params['register_date'] = $now;
1293 // now set the values for the billing location.
1294 foreach ($this->_fields
as $name => $dontCare) {
1298 // also add location name to the array
1299 $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 $formValues["address_name-{$this->_bltID}"] = trim($formValues["address_name-{$this->_bltID}"]);
1303 $fields["address_name-{$this->_bltID}"] = 1;
1304 //ensure we don't over-write the payer's email with the member's email
1305 if ($this->_contributorContactID
== $this->_contactID
) {
1306 $fields["email-{$this->_bltID}"] = 1;
1309 $ctype = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $this->_contactID
, 'contact_type');
1311 $nameFields = array('first_name', 'middle_name', 'last_name');
1313 foreach ($nameFields as $name) {
1315 if (array_key_exists("billing_$name", $formValues)) {
1316 $formValues[$name] = $formValues["billing_{$name}"];
1317 $formValues['preserveDBName'] = TRUE;
1320 if ($this->_contributorContactID
== $this->_contactID
) {
1321 //see CRM-12869 for discussion of why we don't do this for separate payee payments
1322 CRM_Contact_BAO_Contact
::createProfileContact($formValues, $fields,
1323 $this->_contributorContactID
, NULL, NULL, $ctype
1327 // add all the additional payment params we need
1328 $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}"]);
1329 $this->_params
["country-{$this->_bltID}"] = $this->_params
["billing_country-{$this->_bltID}"] = CRM_Core_PseudoConstant
::countryIsoCode($this->_params
["billing_country_id-{$this->_bltID}"]);
1331 $this->_params
['year'] = CRM_Core_Payment_Form
::getCreditCardExpirationYear($this->_params
);
1332 $this->_params
['month'] = CRM_Core_Payment_Form
::getCreditCardExpirationMonth($this->_params
);
1333 $this->_params
['ip_address'] = CRM_Utils_System
::ipAddress();
1334 $this->_params
['amount'] = $params['total_amount'];
1335 $this->_params
['currencyID'] = $config->defaultCurrency
;
1336 $this->_params
['description'] = ts('Office Credit Card Membership Signup Contribution');
1337 $this->_params
['payment_action'] = 'Sale';
1338 $this->_params
['invoiceID'] = md5(uniqid(rand(), TRUE));
1339 $this->_params
['financial_type_id'] = $params['financial_type_id'];
1341 // at this point we've created a contact and stored its address etc
1342 // all the payment processors expect the name and address to be in the
1343 // so we copy stuff over to first_name etc.
1344 $paymentParams = $this->_params
;
1345 $paymentParams['contactID'] = $this->_contributorContactID
;
1346 //CRM-10377 if payment is by an alternate contact then we need to set that person
1347 // as the contact in the payment params
1348 if ($this->_contributorContactID
!= $this->_contactID
) {
1349 if (!empty($this->_params
['soft_credit_type_id'])) {
1350 $softParams['contact_id'] = $params['contact_id'];
1351 $softParams['soft_credit_type_id'] = $this->_params
['soft_credit_type_id'];
1354 if (!empty($this->_params
['send_receipt'])) {
1355 $paymentParams['email'] = $this->_contributorEmail
;
1358 CRM_Core_Payment_Form
::mapParams($this->_bltID
, $this->_params
, $paymentParams, TRUE);
1360 // CRM-7137 -for recurring membership,
1361 // we do need contribution and recuring records.
1363 if (!empty($paymentParams['is_recur'])) {
1364 $contributionType = new CRM_Financial_DAO_FinancialType();
1365 $contributionType->id
= $params['financial_type_id'];
1366 if (!$contributionType->find(TRUE)) {
1367 CRM_Core_Error
::fatal('Could not find a system table');
1370 $contribution = CRM_Contribute_Form_Contribution_Confirm
::processContribution($this,
1373 $this->_contributorContactID
,
1381 //create new soft-credit record, CRM-13981
1383 $softParams['contribution_id'] = $contribution->id
;
1384 $softParams['currency'] = $contribution->currency
;
1385 $softParams['amount'] = $contribution->total_amount
;
1386 CRM_Contribute_BAO_ContributionSoft
::add($softParams);
1389 $paymentParams['contactID'] = $this->_contactID
;
1390 $paymentParams['contributionID'] = $contribution->id
;
1391 $paymentParams['contributionTypeID'] = $contribution->financial_type_id
;
1392 $paymentParams['contributionPageID'] = $contribution->contribution_page_id
;
1393 $paymentParams['contributionRecurID'] = $contribution->contribution_recur_id
;
1394 $ids['contribution'] = $contribution->id
;
1395 $params['contribution_recur_id'] = $paymentParams['contributionRecurID'];
1398 if ($params['total_amount'] > 0.0) {
1399 $payment = CRM_Core_Payment
::singleton($this->_mode
, $this->_paymentProcessor
, $this);
1400 $result = $payment->doDirectPayment($paymentParams);
1403 if (is_a($result, 'CRM_Core_Error')) {
1404 //make sure to cleanup db for recurring case.
1405 if (!empty($paymentParams['contributionID'])) {
1406 CRM_Contribute_BAO_Contribution
::deleteContribution($paymentParams['contributionID']);
1408 if (!empty($paymentParams['contributionRecurID'])) {
1409 CRM_Contribute_BAO_ContributionRecur
::deleteRecurContribution($paymentParams['contributionRecurID']);
1412 CRM_Core_Error
::displaySessionError($result);
1413 CRM_Utils_System
::redirect(CRM_Utils_System
::url('civicrm/contact/view/membership',
1414 "reset=1&action=add&cid={$this->_contactID}&context=&mode={$this->_mode}"
1419 $this->_params
= array_merge($this->_params
, $result);
1420 //assign amount to template if payment was successful
1421 $this->assign('amount', $params['total_amount']);
1424 // if the payment processor returns a contribution_status_id -> use it!
1425 if (isset($result['contribution_status_id'])) {
1426 $params['contribution_status_id'] = $result['contribution_status_id'];
1428 elseif (isset($result['payment_status_id'])) {
1429 // CRM-16737 $result['contribution_status_id'] is deprecated in favour
1430 // of payment_status_id as the payment processor only knows whether the payment is complete
1431 // not whether payment completes the contribution
1432 $params['contribution_status_id'] = $params['payment_status_id'];
1434 // do what used to happen previously
1436 $params['contribution_status_id'] = !empty($paymentParams['is_recur']) ?
2 : 1;
1438 if ($params['contribution_status_id'] != array_search('Completed', $allContributionStatus)) {
1439 $params['status_id'] = array_search('Pending', $allMemberStatus);
1440 $params['skipStatusCal'] = TRUE;
1441 // unset send-receipt option, since receipt will be sent when ipn is received.
1442 unset($this->_params
['send_receipt'], $formValues['send_receipt']);
1443 //as membership is pending set dates to null.
1444 $memberDates = array(
1445 'join_date' => 'joinDate',
1446 'start_date' => 'startDate',
1447 'end_date' => 'endDate',
1449 foreach ($memberDates as $dp => $dv) {
1451 foreach ($this->_memTypeSelected
as $memType) {
1452 $membershipTypeValues[$memType][$dv] = NULL;
1456 $params['receive_date'] = $now;
1457 $params['invoice_id'] = $this->_params
['invoiceID'];
1458 $params['contribution_source'] = ts('%1 Membership Signup: Credit card or direct debit (by %2)',
1459 array(1 => $membershipType, 2 => $userName)
1461 $params['source'] = $formValues['source'] ?
$formValues['source'] : $params['contribution_source'];
1462 $params['trxn_id'] = CRM_Utils_Array
::value('trxn_id', $result);
1463 $params['payment_instrument_id'] = 1;
1464 $params['is_test'] = ($this->_mode
== 'live') ?
0 : 1;
1465 if (!empty($this->_params
['send_receipt'])) {
1466 $params['receipt_date'] = $now;
1469 $params['receipt_date'] = NULL;
1472 $this->set('params', $this->_params
);
1473 $this->assign('trxn_id', CRM_Utils_Array
::value('trxn_id', $result));
1474 $this->assign('receive_date',
1475 CRM_Utils_Date
::mysqlToIso($params['receive_date'])
1478 // required for creating membership for related contacts
1479 $params['action'] = $this->_action
;
1481 //create membership record.
1483 foreach ($this->_memTypeSelected
as $memType) {
1485 ($relateContribution = CRM_Member_BAO_Membership
::getMembershipContributionId($membership->id
))
1487 $membershipTypeValues[$memType]['relate_contribution_id'] = $relateContribution;
1490 $membershipParams = array_merge($membershipTypeValues[$memType], $params);
1492 if (!empty($softParams) && empty($paymentParams['is_recur'])) {
1493 $membershipParams['soft_credit'] = $softParams;
1495 $membership = CRM_Member_BAO_Membership
::create($membershipParams, $ids);
1496 $params['contribution'] = CRM_Utils_Array
::value('contribution', $membershipParams);
1497 unset($params['lineItems']);
1498 $this->_membershipIDs
[] = $membership->id
;
1499 $createdMemberships[$memType] = $membership;
1505 $params['action'] = $this->_action
;
1506 if ($this->_onlinePendingContributionId
&& !empty($formValues['record_contribution'])) {
1508 // update membership as well as contribution object, CRM-4395
1509 $params['contribution_id'] = $this->_onlinePendingContributionId
;
1510 $params['componentId'] = $params['id'];
1511 $params['componentName'] = 'contribute';
1512 $result = CRM_Contribute_BAO_Contribution
::transitionComponents($params, TRUE);
1513 if (!empty($result) && !empty($params['contribution_id'])) {
1514 $lineItem = array();
1515 $lineItems = CRM_Price_BAO_LineItem
::getLineItems($params['contribution_id'], 'contribution', NULL, TRUE, TRUE);
1516 $itemId = key($lineItems);
1517 $priceSetId = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceField', $lineItems[$itemId]['price_field_id'], 'price_set_id');
1519 if ($itemId && !empty($lineItems[$itemId]['price_field_id'])) {
1520 $fieldType = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceField', $lineItems[$itemId]['price_field_id'], 'html_type');
1522 $lineItems[$itemId]['unit_price'] = $params['total_amount'];
1523 $lineItems[$itemId]['line_total'] = $params['total_amount'];
1524 $lineItems[$itemId]['id'] = $itemId;
1525 $lineItem[$priceSetId] = $lineItems;
1526 $contributionBAO = new CRM_Contribute_BAO_Contribution();
1527 $contributionBAO->id
= $params['contribution_id'];
1528 $contributionBAO->contact_id
= $params['contact_id'];
1529 $contributionBAO->find();
1530 CRM_Price_BAO_LineItem
::processPriceSet($params['contribution_id'], $lineItem, $contributionBAO, 'civicrm_membership');
1532 //create new soft-credit record, CRM-13981
1534 $softParams['contribution_id'] = $params['contribution_id'];
1535 while ($contributionBAO->fetch()) {
1536 $softParams['currency'] = $contributionBAO->currency
;
1537 $softParams['amount'] = $contributionBAO->total_amount
;
1539 CRM_Contribute_BAO_ContributionSoft
::add($softParams);
1543 //carry updated membership object.
1544 $membership = new CRM_Member_DAO_Membership();
1545 $membership->id
= $this->_id
;
1546 $membership->find(TRUE);
1549 if ($membership->end_date
) {
1550 //display end date w/ status message.
1551 $endDate = $membership->end_date
;
1553 if (!in_array($membership->status_id
, array(
1555 array_search('Cancelled', CRM_Member_PseudoConstant
::membershipStatus(NULL, " name = 'Cancelled' ", 'name', FALSE, TRUE)),
1556 array_search('Expired', CRM_Member_PseudoConstant
::membershipStatus()),
1562 // suppress form values in template.
1563 $this->assign('cancelled', $cancelled);
1565 // FIX ME: need to recheck this
1566 // here we might updated dates, so get from object.
1567 foreach ($calcDates[$membership->membership_type_id
] as $date => & $val) {
1568 if ($membership->$date) {
1569 $val = $membership->$date;
1573 $createdMemberships[] = $membership;
1577 foreach ($this->_memTypeSelected
as $memType) {
1578 if ($count && !empty($formValues['record_contribution']) &&
1579 ($relateContribution = CRM_Member_BAO_Membership
::getMembershipContributionId($membership->id
))
1581 $membershipTypeValues[$memType]['relate_contribution_id'] = $relateContribution;
1584 $membershipParams = array_merge($params, $membershipTypeValues[$memType]);
1585 if (!empty($formValues['int_amount'])) {
1586 $init_amount = array();
1587 foreach ($formValues as $key => $value) {
1588 if (strstr($key, 'txt-price')) {
1589 $init_amount[$key] = $value;
1592 $membershipParams['init_amount'] = $init_amount;
1595 if (!empty($softParams)) {
1596 $membershipParams['soft_credit'] = $softParams;
1599 $membership = CRM_Member_BAO_Membership
::create($membershipParams, $ids);
1600 $params['contribution'] = CRM_Utils_Array
::value('contribution', $membershipParams);
1601 unset($params['lineItems']);
1603 $this->_membershipIDs
[] = $membership->id
;
1604 $createdMemberships[$memType] = $membership;
1610 if (!empty($lineItem[$priceSetId])) {
1611 $invoiceSettings = CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::CONTRIBUTE_PREFERENCES_NAME
, 'contribution_invoice_settings');
1612 $invoicing = CRM_Utils_Array
::value('invoicing', $invoiceSettings);
1614 $totalTaxAmount = 0;
1615 foreach ($lineItem[$priceSetId] as & $priceFieldOp) {
1616 if (!empty($priceFieldOp['membership_type_id'])) {
1617 $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') : '-';
1618 $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') : '-';
1621 $priceFieldOp['start_date'] = $priceFieldOp['end_date'] = 'N/A';
1623 if ($invoicing && isset($priceFieldOp['tax_amount'])) {
1625 $totalTaxAmount +
= $priceFieldOp['tax_amount'];
1629 $dataArray = array();
1630 foreach ($lineItem[$priceSetId] as $key => $value) {
1631 if (isset($value['tax_amount']) && isset($value['tax_rate'])) {
1632 if (isset($dataArray[$value['tax_rate']])) {
1633 $dataArray[$value['tax_rate']] = $dataArray[$value['tax_rate']] + CRM_Utils_Array
::value('tax_amount', $value);
1636 $dataArray[$value['tax_rate']] = CRM_Utils_Array
::value('tax_amount', $value);
1641 $this->assign('totalTaxAmount', $totalTaxAmount);
1642 $this->assign('taxTerm', CRM_Utils_Array
::value('tax_term', $invoiceSettings));
1644 $this->assign('dataArray', $dataArray);
1647 $this->assign('lineItem', !empty($lineItem) && !$isQuickConfig ?
$lineItem : FALSE);
1649 $receiptSend = FALSE;
1650 $contributionId = CRM_Member_BAO_Membership
::getMembershipContributionId($membership->id
);
1651 $membershipIds = $this->_membershipIDs
;
1652 if ($contributionId && !empty($membershipIds)) {
1653 $contributionDetails = CRM_Contribute_BAO_Contribution
::getContributionDetails(
1654 CRM_Export_Form_Select
::MEMBER_EXPORT
, $this->_membershipIDs
);
1655 if ($contributionDetails[$membership->id
]['contribution_status'] == 'Completed') {
1656 $receiptSend = TRUE;
1660 if (!empty($formValues['send_receipt']) && $receiptSend) {
1661 $formValues['contact_id'] = $this->_contactID
;
1662 $formValues['contribution_id'] = $contributionId;
1664 // send email receipt
1665 $mailSend = self
::emailReceipt($this, $formValues, $membership);
1668 if (($this->_action
& CRM_Core_Action
::UPDATE
)) {
1669 //end date can be modified by hooks, so if end date is set then use it.
1670 $endDate = ($membership->end_date
) ?
$membership->end_date
: $endDate;
1672 $statusMsg = ts('Membership for %1 has been updated.', array(1 => $this->_memberDisplayName
));
1673 if ($endDate && $endDate !== 'null') {
1674 $endDate = CRM_Utils_Date
::customFormat($endDate);
1675 $statusMsg .= ' ' . ts('The membership End Date is %1.', array(1 => $endDate));
1678 $statusMsg .= ' ' . ts('A confirmation and receipt has been sent to %1.', array(1 => $this->_contributorEmail
));
1681 elseif (($this->_action
& CRM_Core_Action
::ADD
)) {
1682 // FIX ME: fix status messages
1684 $statusMsg = array();
1685 foreach ($membershipTypes as $memType => $membershipType) {
1686 $statusMsg[$memType] = ts('%1 membership for %2 has been added.', array(
1687 1 => $membershipType,
1688 2 => $this->_memberDisplayName
,
1691 $membership = $createdMemberships[$memType];
1692 $memEndDate = ($membership->end_date
) ?
$membership->end_date
: $endDate;
1694 //get the end date from calculated dates.
1695 if (!$memEndDate && empty($params['is_recur'])) {
1696 $memEndDate = CRM_Utils_Array
::value('end_date', $calcDates[$memType]);
1699 if ($memEndDate && $memEndDate !== 'null') {
1700 $memEndDate = CRM_Utils_Date
::customFormat($memEndDate);
1701 $statusMsg[$memType] .= ' ' . ts('The new membership End Date is %1.', array(1 => $memEndDate));
1704 $statusMsg = implode('<br/>', $statusMsg);
1705 if ($receiptSend && !empty($mailSend)) {
1706 $statusMsg .= ' ' . ts('A membership confirmation and receipt has been sent to %1.', array(1 => $this->_contributorEmail
));
1710 // finally set membership id if already not set
1712 $this->_id
= $membership->id
;
1715 CRM_Core_Session
::setStatus($statusMsg, ts('Complete'), 'success');
1717 $buttonName = $this->controller
->getButtonName();
1718 if ($this->_context
== 'standalone') {
1719 if ($buttonName == $this->getButtonName('upload', 'new')) {
1720 $session->replaceUserContext(CRM_Utils_System
::url('civicrm/member/add',
1721 'reset=1&action=add&context=standalone'
1725 $session->replaceUserContext(CRM_Utils_System
::url('civicrm/contact/view',
1726 "reset=1&cid={$this->_contactID}&selectedChild=member"
1730 elseif ($buttonName == $this->getButtonName('upload', 'new')) {
1731 $session->replaceUserContext(CRM_Utils_System
::url('civicrm/contact/view/membership',
1732 "reset=1&action=add&context=membership&cid={$this->_contactID}"
1738 * Send email receipt.
1740 * @param CRM_Core_Form $form
1742 * @param array $formValues
1743 * @param object $membership
1747 * true if mail was sent successfully
1749 public static function emailReceipt(&$form, &$formValues, &$membership) {
1750 // retrieve 'from email id' for acknowledgement
1751 $receiptFrom = $formValues['from_email_address'];
1753 if (!empty($formValues['payment_instrument_id'])) {
1754 $paymentInstrument = CRM_Contribute_PseudoConstant
::paymentInstrument();
1755 $formValues['paidBy'] = $paymentInstrument[$formValues['payment_instrument_id']];
1758 // retrieve custom data
1759 $customFields = $customValues = array();
1760 if (property_exists($form, '_groupTree')
1761 && !empty($form->_groupTree
)
1763 foreach ($form->_groupTree
as $groupID => $group) {
1764 if ($groupID == 'info') {
1767 foreach ($group['fields'] as $k => $field) {
1768 $field['title'] = $field['label'];
1769 $customFields["custom_{$k}"] = $field;
1774 $members = array(array('member_id', '=', $membership->id
, 0, 0));
1775 // check whether its a test drive
1776 if ($form->_mode
== 'test') {
1777 $members[] = array('member_test', '=', 1, 0, 0);
1780 CRM_Core_BAO_UFGroup
::getValues($formValues['contact_id'], $customFields, $customValues, FALSE, $members);
1783 if (!empty($form->_params
['billing_first_name'])) {
1784 $name = $form->_params
['billing_first_name'];
1787 if (!empty($form->_params
['billing_middle_name'])) {
1788 $name .= " {$form->_params['billing_middle_name']}";
1791 if (!empty($form->_params
['billing_last_name'])) {
1792 $name .= " {$form->_params['billing_last_name']}";
1795 $form->assign('billingName', $name);
1797 // assign the address formatted up for display
1798 $addressParts = array(
1799 "street_address-{$form->_bltID}",
1800 "city-{$form->_bltID}",
1801 "postal_code-{$form->_bltID}",
1802 "state_province-{$form->_bltID}",
1803 "country-{$form->_bltID}",
1805 $addressFields = array();
1806 foreach ($addressParts as $part) {
1807 list($n, $id) = explode('-', $part);
1808 if (isset($form->_params
['billing_' . $part])) {
1809 $addressFields[$n] = $form->_params
['billing_' . $part];
1812 $form->assign('address', CRM_Utils_Address
::format($addressFields));
1814 $date = CRM_Utils_Date
::format($form->_params
['credit_card_exp_date']);
1815 $date = CRM_Utils_Date
::mysqlToIso($date);
1816 $form->assign('credit_card_exp_date', $date);
1817 $form->assign('credit_card_number',
1818 CRM_Utils_System
::mungeCreditCard($form->_params
['credit_card_number'])
1820 $form->assign('credit_card_type', $form->_params
['credit_card_type']);
1821 $form->assign('contributeMode', 'direct');
1822 $form->assign('isAmountzero', 0);
1823 $form->assign('is_pay_later', 0);
1824 $form->assign('isPrimary', 1);
1827 $form->assign('module', 'Membership');
1828 $form->assign('contactID', $formValues['contact_id']);
1830 $form->assign('membershipID', CRM_Utils_Array
::value('membership_id', $form->_params
, CRM_Utils_Array
::value('membership_id', $form->_defaultValues
)));
1832 if (!empty($formValues['contribution_id'])) {
1833 $form->assign('contributionID', $formValues['contribution_id']);
1835 elseif (isset($form->_onlinePendingContributionId
)) {
1836 $form->assign('contributionID', $form->_onlinePendingContributionId
);
1839 if (!empty($formValues['contribution_status_id'])) {
1840 $form->assign('contributionStatusID', $formValues['contribution_status_id']);
1841 $form->assign('contributionStatus', CRM_Contribute_PseudoConstant
::contributionStatus($formValues['contribution_status_id'], 'name'));
1844 if (!empty($formValues['is_renew'])) {
1845 $form->assign('receiptType', 'membership renewal');
1848 $form->assign('receiptType', 'membership signup');
1850 $form->assign('receive_date', CRM_Utils_Date
::processDate(CRM_Utils_Array
::value('receive_date', $formValues)));
1851 $form->assign('formValues', $formValues);
1853 if (empty($lineItem)) {
1854 $form->assign('mem_start_date', CRM_Utils_Date
::customFormat($membership->start_date
, '%B %E%f, %Y'));
1855 if (!CRM_Utils_System
::isNull($membership->end_date
)) {
1856 $form->assign('mem_end_date', CRM_Utils_Date
::customFormat($membership->end_date
, '%B %E%f, %Y'));
1858 $form->assign('membership_name', CRM_Member_PseudoConstant
::membershipType($membership->membership_type_id
));
1861 $form->assign('customValues', $customValues);
1862 $isBatchProcess = is_a($form, 'CRM_Batch_Form_Entry');
1863 if ((empty($form->_contributorDisplayName
) ||
empty($form->_contributorEmail
)) ||
$isBatchProcess) {
1864 // in this case the form is being called statically from the batch editing screen
1865 // having one class in the form layer call another statically is not greate
1866 // & we should aim to move this function to the BAO layer in future.
1867 // however, we can assume that the contact_id passed in by the batch
1868 // function will be the recipient
1869 list($form->_contributorDisplayName
, $form->_contributorEmail
)
1870 = CRM_Contact_BAO_Contact_Location
::getEmailDetails($formValues['contact_id']);
1871 if (empty($form->_receiptContactId
) ||
$isBatchProcess) {
1872 $form->_receiptContactId
= $formValues['contact_id'];
1875 $template = CRM_Core_Smarty
::singleton();
1876 $taxAmt = $template->get_template_vars('dataArray');
1877 $eventTaxAmt = $template->get_template_vars('totalTaxAmount');
1878 $prefixValue = CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::CONTRIBUTE_PREFERENCES_NAME
, 'contribution_invoice_settings');
1879 $invoicing = CRM_Utils_Array
::value('invoicing', $prefixValue);
1880 if ((!empty($taxAmt) ||
isset($eventTaxAmt)) && (isset($invoicing) && isset($prefixValue['is_email_pdf']))) {
1884 $isEmailPdf = FALSE;
1887 list($mailSend, $subject, $message, $html) = CRM_Core_BAO_MessageTemplate
::sendTemplate(
1889 'groupName' => 'msg_tpl_workflow_membership',
1890 'valueName' => 'membership_offline_receipt',
1891 'contactId' => $form->_receiptContactId
,
1892 'from' => $receiptFrom,
1893 'toName' => $form->_contributorDisplayName
,
1894 'toEmail' => $form->_contributorEmail
,
1895 'PDFFilename' => ts('receipt') . '.pdf',
1896 'isEmailPdf' => $isEmailPdf,
1897 'contributionId' => $formValues['contribution_id'],
1898 'isTest' => (bool) ($form->_action
& CRM_Core_Action
::PREVIEW
),