3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
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-2014
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
57 protected $_memberDisplayName = NULL;
60 * email of the person paying for the membership (used for receipts)
62 protected $_memberEmail = NULL;
65 * Contact ID of the member
67 public $_contactID = NULL;
70 * Display name of the person paying for the membership (used for receipts)
72 protected $_contributorDisplayName = NULL;
75 * email of the person paying for the membership (used for receipts)
77 protected $_contributorEmail = NULL;
80 * email of the person paying for the membership (used for receipts)
82 protected $_contributorContactID = NULL;
85 * ID of the person the receipt is to go to
87 protected $_receiptContactId = NULL;
90 * Keep a class variable for ALL membeshipID's so
91 * postProcess hook function can do something with it
93 protected $_membershipIDs = array();
96 * An array to hold a list of datefields on the form
97 * so that they can be converted to ISO in a consistent manner
101 protected $_dateFields = array(
102 'receive_date' => array('default' => 'now'),
105 public function preProcess() {
106 //custom data related code
107 $this->_cdType
= CRM_Utils_Array
::value('type', $_GET);
108 $this->assign('cdType', FALSE);
109 if ($this->_cdType
) {
110 $this->assign('cdType', TRUE);
111 return CRM_Custom_Form_CustomData
::preProcess($this);
114 parent
::preProcess();
116 $this->_priceSetId
= CRM_Utils_Array
::value('priceSetId', $_GET);
117 $this->set('priceSetId', $this->_priceSetId
);
118 $this->assign('priceSetId', $this->_priceSetId
);
120 // check for edit permission
121 if (!CRM_Core_Permission
::checkActionPermission('CiviMember', $this->_action
)) {
122 CRM_Core_Error
::fatal(ts('You do not have permission to access this page.'));
125 if ($this->_action
& CRM_Core_Action
::DELETE
) {
126 $contributionID = CRM_Member_BAO_Membership
::getMembershipContributionId($this->_id
);
127 // check delete permission for contribution
128 if ($this->_id
&& $contributionID && !CRM_Core_Permission
::checkActionPermission('CiviContribute', $this->_action
)) {
129 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."));
133 if ($this->_action
& CRM_Core_Action
::ADD
) {
134 if (!CRM_Member_BAO_Membership
::statusAvailabilty($this->_contactID
)) {
135 // all possible statuses are disabled - redirect back to contact form
136 CRM_Core_Error
::statusBounce(ts('There are no configured membership statuses. You cannot add this membership until your membership statuses are correctly configured'));
139 if ($this->_contactID
) {
140 //check whether contact has a current membership so we can alert user that they may want to do a renewal instead
141 $contactMemberships = array();
142 $memParams = array('contact_id' => $this->_contactID
);
143 CRM_Member_BAO_Membership
::getValues($memParams, $contactMemberships, TRUE);
144 $cMemTypes = array();
145 foreach ($contactMemberships as $mem) {
146 $cMemTypes[] = $mem['membership_type_id'];
148 if (count($cMemTypes) > 0) {
149 $memberorgs = CRM_Member_BAO_MembershipType
::getMemberOfContactByMemTypes($cMemTypes);
150 $mems_by_org = array();
151 foreach ($contactMemberships as $memid => $mem) {
152 $mem['member_of_contact_id'] = CRM_Utils_Array
::value($mem['membership_type_id'], $memberorgs);
153 if (!empty($mem['membership_end_date'])) {
154 $mem['membership_end_date'] = CRM_Utils_Date
::customformat($mem['membership_end_date']);
156 $mem['membership_type'] = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType',
157 $mem['membership_type_id'],
160 $mem['membership_status'] = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipStatus',
164 $mem['renewUrl'] = CRM_Utils_System
::url('civicrm/contact/view/membership',
165 "reset=1&action=renew&cid={$this->_contactID}&id={$mem['id']}&context=membership&selectedChild=member"
166 . ($this->_mode ?
'&mode=live' : '')
168 $mem['membershipTab'] = CRM_Utils_System
::url('civicrm/contact/view',
169 "reset=1&force=1&cid={$this->_contactID}&selectedChild=member"
171 $mems_by_org[$mem['member_of_contact_id']] = $mem;
173 $this->assign('existingContactMemberships', $mems_by_org);
177 // In standalone mode we don't have a contact id yet so lookup will be done client-side with this script:
178 $resources = CRM_Core_Resources
::singleton();
179 $resources->addScriptFile('civicrm', 'templates/CRM/Member/Form/MembershipStandalone.js');
181 'typeorgs' => CRM_Member_BAO_MembershipType
::getMembershipTypeOrganization(),
182 'memtypes' => CRM_Core_PseudoConstant
::get('CRM_Member_BAO_Membership', 'membership_type_id'),
183 'statuses' => CRM_Core_PseudoConstant
::get('CRM_Member_BAO_Membership', 'status_id'),
185 $resources->addSetting(array('existingMems' => $passthru));
189 // when custom data is included in this page
190 if (!empty($_POST['hidden_custom'])) {
191 CRM_Custom_Form_CustomData
::preProcess($this);
192 CRM_Custom_Form_CustomData
::buildQuickForm($this);
193 CRM_Custom_Form_CustomData
::setDefaultValues($this);
196 // CRM-4395, get the online pending contribution id.
197 $this->_onlinePendingContributionId
= NULL;
198 if (!$this->_mode
&& $this->_id
&& ($this->_action
& CRM_Core_Action
::UPDATE
)) {
199 $this->_onlinePendingContributionId
= CRM_Contribute_BAO_Contribution
::checkOnlinePendingContribution($this->_id
,
203 $this->assign('onlinePendingContributionId', $this->_onlinePendingContributionId
);
205 $this->setPageTitle(ts('Membership'));
209 * Set default values for the form. MobileProvider that in edit/view mode
210 * the default values are retrieved from the database
215 public function setDefaultValues() {
216 if ($this->_cdType
) {
217 return CRM_Custom_Form_CustomData
::setDefaultValues($this);
220 if ($this->_priceSetId
) {
221 return CRM_Price_BAO_PriceSet
::setDefaultPriceSet($this, $defaults);
224 $defaults = parent
::setDefaultValues();
226 //setting default join date and receive date
227 list($now, $currentTime) = CRM_Utils_Date
::setDateDefaults();
228 if ($this->_action
== CRM_Core_Action
::ADD
) {
229 $defaults['receive_date'] = $now;
230 $defaults['receive_date_time'] = $currentTime;
233 if (is_numeric($this->_memType
)) {
234 $defaults['membership_type_id'] = array();
235 $defaults['membership_type_id'][0] = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType',
237 'member_of_contact_id',
240 $defaults['membership_type_id'][1] = $this->_memType
;
243 $defaults['membership_type_id'] = $this->_memType
;
246 $defaults['num_terms'] = 1;
248 if (!empty($defaults['id'])) {
249 if ($this->_onlinePendingContributionId
) {
250 $defaults['record_contribution'] = $this->_onlinePendingContributionId
;
253 $contributionId = CRM_Core_DAO
::singleValueQuery("
254 SELECT contribution_id
255 FROM civicrm_membership_payment
256 WHERE membership_id = $this->_id
257 ORDER BY contribution_id
260 if ($contributionId) {
261 $defaults['record_contribution'] = $contributionId;
266 //set Soft Credit Type to Gift by default
267 $scTypes = CRM_Core_OptionGroup
::values("soft_credit_type");
268 $defaults['soft_credit_type_id'] = CRM_Utils_Array
::value(ts('Gift'), array_flip($scTypes));
270 if (!empty($defaults['record_contribution']) && !$this->_mode
) {
271 $contributionParams = array('id' => $defaults['record_contribution']);
272 $contributionIds = array();
274 //keep main object campaign in hand.
275 $memberCampaignId = CRM_Utils_Array
::value('campaign_id', $defaults);
277 CRM_Contribute_BAO_Contribution
::getValues($contributionParams, $defaults, $contributionIds);
279 //get back original object campaign id.
280 $defaults['campaign_id'] = $memberCampaignId;
282 if (!empty($defaults['receive_date'])) {
283 list($defaults['receive_date']) = CRM_Utils_Date
::setDateDefaults($defaults['receive_date']);
286 // Contribution::getValues() over-writes the membership record's source field value - so we need to restore it.
287 if (!empty($defaults['membership_source'])) {
288 $defaults['source'] = $defaults['membership_source'];
292 if (empty($defaults['payment_instrument_id'])) {
293 $defaults['payment_instrument_id'] = key(CRM_Core_OptionGroup
::values('payment_instrument', FALSE, FALSE, FALSE, 'AND is_default = 1'));
296 // User must explicitly choose to send a receipt in both add and update mode.
297 $defaults['send_receipt'] = 0;
299 if ($this->_action
& CRM_Core_Action
::UPDATE
) {
300 // in this mode by default uncheck this checkbox
301 unset($defaults['record_contribution']);
304 if (!empty($defaults['id'])) {
305 $subscriptionCancelled = CRM_Member_BAO_Membership
::isSubscriptionCancelled($this->_id
);
308 $alreadyAutoRenew = FALSE;
309 if (!empty($defaults['contribution_recur_id']) && !$subscriptionCancelled) {
310 $defaults['auto_renew'] = 1;
311 $alreadyAutoRenew = TRUE;
313 $this->assign('alreadyAutoRenew', $alreadyAutoRenew);
315 $this->assign('member_is_test', CRM_Utils_Array
::value('member_is_test', $defaults));
317 $this->assign('membership_status_id', CRM_Utils_Array
::value('status_id', $defaults));
319 if (!empty($defaults['is_pay_later'])) {
320 $this->assign('is_pay_later', TRUE);
323 // set default country from config if no country set
324 $config = CRM_Core_Config
::singleton();
325 if (empty($defaults["billing_country_id-{$this->_bltID}"])) {
326 $defaults["billing_country_id-{$this->_bltID}"] = $config->defaultContactCountry
;
329 if (empty($defaults["billing_state_province_id-{$this->_bltID}"])) {
330 $defaults["billing_state_province_id-{$this->_bltID}"] = $config->defaultContactStateProvince
;
333 $billingDefaults = $this->getProfileDefaults('Billing', $this->_contactID
);
334 $defaults = array_merge($defaults, $billingDefaults);
336 // // hack to simplify credit card entry for testing
337 // $defaults['credit_card_type'] = 'Visa';
338 // $defaults['credit_card_number'] = '4807731747657838';
339 // $defaults['cvv2'] = '000';
340 // $defaults['credit_card_exp_date'] = array( 'Y' => '2012', 'M' => '05' );
343 $dates = array('join_date', 'start_date', 'end_date');
344 foreach ($dates as $key) {
345 if (!empty($defaults[$key])) {
346 list($defaults[$key]) = CRM_Utils_Date
::setDateDefaults(CRM_Utils_Array
::value($key, $defaults));
350 //setting default join date if there is no join date
351 if (empty($defaults['join_date'])) {
352 $defaults['join_date'] = $now;
355 if (!empty($defaults['membership_end_date'])) {
356 $this->assign('endDate', $defaults['membership_end_date']);
363 * Build the form object
367 public function buildQuickForm() {
368 if ($this->_cdType
) {
369 return CRM_Custom_Form_CustomData
::buildQuickForm($this);
372 $this->assign('taxRates', json_encode(CRM_Core_PseudoConstant
::getTaxRates()));
373 $config = CRM_Core_Config
::singleton();
374 $this->assign('currency', $config->defaultCurrencySymbol
);
375 $invoiceSettings = CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::CONTRIBUTE_PREFERENCES_NAME
, 'contribution_invoice_settings');
376 $invoicing = CRM_Utils_Array
::value('invoicing', $invoiceSettings);
377 if (isset($invoicing)) {
378 $this->assign('taxTerm', CRM_Utils_Array
::value('tax_term', $invoiceSettings));
380 // build price set form.
381 $buildPriceSet = FALSE;
382 if ($this->_priceSetId ||
!empty($_POST['price_set_id'])) {
383 if (!empty($_POST['price_set_id'])) {
384 $buildPriceSet = TRUE;
386 $getOnlyPriceSetElements = TRUE;
387 if (!$this->_priceSetId
) {
388 $this->_priceSetId
= $_POST['price_set_id'];
389 $getOnlyPriceSetElements = FALSE;
392 $this->set('priceSetId', $this->_priceSetId
);
393 CRM_Price_BAO_PriceSet
::buildPriceSet($this);
395 $optionsMembershipTypes = array();
396 foreach ($this->_priceSet
['fields'] as $pField) {
397 if (empty($pField['options'])) {
400 foreach ($pField['options'] as $opId => $opValues) {
401 $optionsMembershipTypes[$opId] = CRM_Utils_Array
::value('membership_type_id', $opValues, 0);
405 $this->assign('autoRenewOption', CRM_Price_BAO_PriceSet
::checkAutoRenewForPriceSet($this->_priceSetId
));
407 $this->assign('optionsMembershipTypes', $optionsMembershipTypes);
408 $this->assign('contributionType', CRM_Utils_Array
::value('financial_type_id', $this->_priceSet
));
410 // get only price set form elements.
411 if ($getOnlyPriceSetElements) {
416 // use to build form during form rule.
417 $this->assign('buildPriceSet', $buildPriceSet);
419 if ($this->_action
& CRM_Core_Action
::ADD
) {
420 $buildPriceSet = FALSE;
421 $priceSets = CRM_Price_BAO_PriceSet
::getAssoc(FALSE, 'CiviMember');
422 if (!empty($priceSets)) {
423 $buildPriceSet = TRUE;
426 if ($buildPriceSet) {
427 $this->add('select', 'price_set_id', ts('Choose price set'),
429 '' => ts('Choose price set'),
431 NULL, array('onchange' => "buildAmount( this.value );")
434 $this->assign('hasPriceSets', $buildPriceSet);
437 //need to assign custom data type and subtype to the template
438 $this->assign('customDataType', 'Membership');
439 $this->assign('customDataSubType', $this->_memType
);
440 $this->assign('entityID', $this->_id
);
442 if ($this->_action
& CRM_Core_Action
::DELETE
) {
443 $this->addButtons(array(
446 'name' => ts('Delete'),
447 'spacing' => ' ',
452 'name' => ts('Cancel'),
459 if ($this->_context
== 'standalone') {
460 $this->addEntityRef('contact_id', ts('Contact'), array('create' => TRUE, 'api' => array('extra' => array('email'))), TRUE);
463 $selOrgMemType[0][0] = $selMemTypeOrg[0] = ts('- select -');
465 $dao = new CRM_Member_DAO_MembershipType();
466 $dao->domain_id
= CRM_Core_Config
::domainID();
469 // retrieve all memberships
470 $allMemberships = CRM_Member_BAO_Membership
::buildMembershipTypeValues($this);
472 $allMembershipInfo = $membershipType = array();
473 foreach ($allMemberships as $key => $values) {
474 if (!empty($values['is_active'])) {
475 $membershipType[$key] = CRM_Utils_Array
::value('name', $values);
476 if ($this->_mode
&& empty($values['minimum_fee'])) {
480 $memberOfContactId = CRM_Utils_Array
::value('member_of_contact_id', $values);
481 if (empty($selMemTypeOrg[$memberOfContactId])) {
482 $selMemTypeOrg[$memberOfContactId] = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact',
488 $selOrgMemType[$memberOfContactId][0] = ts('- select -');
490 if (empty($selOrgMemType[$memberOfContactId][$key])) {
491 $selOrgMemType[$memberOfContactId][$key] = CRM_Utils_Array
::value('name', $values);
495 // build membership info array, which is used when membership type is selected to:
496 // - set the payment information block
497 // - set the max related block
498 $allMembershipInfo[$key] = array(
499 'financial_type_id' => CRM_Utils_Array
::value('financial_type_id', $values),
500 'total_amount' => CRM_Utils_Money
::format($values['minimum_fee'], NULL, '%a'),
501 'total_amount_numeric' => CRM_Utils_Array
::value('minimum_fee', $values),
502 'auto_renew' => CRM_Utils_Array
::value('auto_renew', $values),
503 'has_related' => isset($values['relationship_type_id']),
504 'max_related' => CRM_Utils_Array
::value('max_related', $values),
509 $this->assign('allMembershipInfo', json_encode($allMembershipInfo));
511 // show organization by default, if only one organization in
513 if (count($selMemTypeOrg) == 2) {
514 unset($selMemTypeOrg[0], $selOrgMemType[0][0]);
516 //sort membership organization and type, CRM-6099
517 natcasesort($selMemTypeOrg);
518 foreach ($selOrgMemType as $index => $orgMembershipType) {
519 natcasesort($orgMembershipType);
520 $selOrgMemType[$index] = $orgMembershipType;
523 $memTypeJs = array('onChange' => "CRM.buildCustomData( 'Membership', this.value );");
525 //build the form for auto renew.
526 $recurProcessor = $autoRenew = array();
527 if ($this->_mode ||
($this->_action
& CRM_Core_Action
::UPDATE
)) {
528 $autoRenewElement = $this->addElement('checkbox',
530 ts('Membership renewed automatically'),
532 array('onclick' => "buildReceiptANDNotice( );")
536 //get the valid recurring processors.
537 $recurring = CRM_Core_PseudoConstant
::paymentProcessor(FALSE, FALSE, 'is_recur = 1');
538 $recurProcessor = array_intersect_assoc($this->_processors
, $recurring);
539 $autoRenew = array();
540 if (!empty($recurProcessor)) {
541 if (!empty($membershipType)) {
547 FROM civicrm_membership_type
548 WHERE id IN ( ' . implode(' , ', array_keys($membershipType)) . ' )';
549 $recurMembershipTypes = CRM_Core_DAO
::executeQuery($sql);
550 while ($recurMembershipTypes->fetch()) {
551 $autoRenew[$recurMembershipTypes->id
] = $recurMembershipTypes->auto_renew
;
558 $this->_recurMembershipTypes
[$recurMembershipTypes->id
][$fld] = $recurMembershipTypes->$fld;
564 "CRM.buildCustomData( 'Membership', this.value ); buildAutoRenew(this.value, null );",
569 $allowAutoRenew = FALSE;
570 if ($this->_mode
&& !empty($recurProcessor)) {
571 $allowAutoRenew = TRUE;
573 $this->assign('allowAutoRenew', $allowAutoRenew);
574 $this->assign('autoRenewOptions', json_encode($autoRenew));
575 $this->assign('recurProcessor', json_encode($recurProcessor));
577 // for max_related: a little JS to show/hide & set default value
578 $memTypeJs['onChange'] = "buildMaxRelated(this.value,true); " . $memTypeJs['onChange'];
579 $this->add('text', 'max_related', ts('Max related'),
580 CRM_Core_DAO
::getAttribute('CRM_Member_DAO_Membership', 'max_related')
583 $sel = & $this->addElement('hierselect',
584 'membership_type_id',
585 ts('Membership Organization and Type'),
589 $sel->setOptions(array($selMemTypeOrg, $selOrgMemType));
595 $this->applyFilter('__ALL__', 'trim');
597 if ($this->_action
& CRM_Core_Action
::ADD
) {
598 $this->add('text', 'num_terms', ts('Number of Terms'), array('size' => 6));
601 $this->addDate('join_date', ts('Member Since'), FALSE, array('formatType' => 'activityDate'));
602 $this->addDate('start_date', ts('Start Date'), FALSE, array('formatType' => 'activityDate'));
603 $endDate = $this->addDate('end_date', ts('End Date'), FALSE, array('formatType' => 'activityDate'));
605 $elements[] = $endDate;
608 $this->add('text', 'source', ts('Source'),
609 CRM_Core_DAO
::getAttribute('CRM_Member_DAO_Membership', 'source')
612 //CRM-7362 --add campaigns.
615 $campaignId = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership', $this->_id
, 'campaign_id');
617 CRM_Campaign_BAO_Campaign
::addCampaign($this, $campaignId);
620 $this->add('select', 'status_id', ts('Membership Status'),
621 array('' => ts('- select -')) + CRM_Member_PseudoConstant
::membershipStatus(NULL, NULL, 'label')
623 $statusOverride = $this->addElement('checkbox', 'is_override',
624 ts('Status Override?'), NULL,
625 array('onClick' => 'showHideMemberStatus()')
627 if ($statusOverride) {
628 $elements[] = $statusOverride;
631 $this->addElement('checkbox', 'record_contribution', ts('Record Membership Payment?'));
633 $this->add('text', 'total_amount', ts('Amount'));
634 $this->addRule('total_amount', ts('Please enter a valid amount.'), 'money');
636 $this->addDate('receive_date', ts('Received'), FALSE, array('formatType' => 'activityDateTime'));
638 $this->add('select', 'payment_instrument_id',
640 array('' => ts('- select -')) + CRM_Contribute_PseudoConstant
::paymentInstrument(),
641 FALSE, array('onChange' => "return showHideByValue('payment_instrument_id','4','checkNumber','table-row','select',false);")
643 $this->add('text', 'trxn_id', ts('Transaction ID'));
644 $this->addRule('trxn_id', ts('Transaction ID already exists in Database.'),
645 'objectExists', array('CRM_Contribute_DAO_Contribution', $this->_id
, 'trxn_id')
648 $allowStatuses = array();
649 $statuses = CRM_Contribute_PseudoConstant
::contributionStatus();
650 if ($this->_onlinePendingContributionId
) {
651 $statusNames = CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name');
652 foreach ($statusNames as $val => $name) {
653 if (in_array($name, array(
660 $allowStatuses[$val] = $statuses[$val];
664 $allowStatuses = $statuses;
666 $this->add('select', 'contribution_status_id',
667 ts('Payment Status'), $allowStatuses
669 $this->add('text', 'check_number', ts('Check Number'),
670 CRM_Core_DAO
::getAttribute('CRM_Contribute_DAO_Contribution', 'check_number')
674 //add field for amount to allow an amount to be entered that differs from minimum
675 $this->add('text', 'total_amount', ts('Amount'));
677 $this->add('select', 'financial_type_id',
678 ts('Financial Type'),
679 array('' => ts('- select -')) + CRM_Contribute_PseudoConstant
::financialType()
682 //CRM-10223 - allow contribution to be recorded against different contact
683 // causes a conflict in standalone mode so skip in standalone for now
684 $this->addElement('checkbox', 'is_different_contribution_contact', ts('Record Payment from a Different Contact?'));
685 $this->addSelect('soft_credit_type_id', array('entity' => 'contribution_soft'));
686 $this->addEntityRef('soft_credit_contact_id', ts('Payment From'), array('create' => TRUE));
688 $this->addElement('checkbox',
690 ts('Send Confirmation and Receipt?'), NULL,
691 array('onclick' => "showHideByValue( 'send_receipt', '', 'notice', 'table-row', 'radio', false); showHideByValue( 'send_receipt', '', 'fromEmail', 'table-row', 'radio', false);")
694 $this->add('select', 'from_email_address', ts('Receipt From'), $this->_fromEmails
);
696 $this->add('textarea', 'receipt_text_signup', ts('Receipt Message'));
698 // Retrieve the name and email of the contact - this will be the TO for receipt email
699 if ($this->_contactID
) {
700 list($this->_memberDisplayName
,
702 ) = CRM_Contact_BAO_Contact_Location
::getEmailDetails($this->_contactID
);
704 $this->assign('emailExists', $this->_memberEmail
);
705 $this->assign('displayName', $this->_memberDisplayName
);
709 if ($this->_action
& CRM_Core_Action
::UPDATE
) {
710 $recurContributionId = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership', $this->_id
,
711 'contribution_recur_id'
713 if ($recurContributionId && !CRM_Member_BAO_Membership
::isSubscriptionCancelled($this->_id
)) {
715 if (CRM_Member_BAO_Membership
::isCancelSubscriptionSupported($this->_id
)) {
716 $this->assign('cancelAutoRenew',
717 CRM_Utils_System
::url('civicrm/contribute/unsubscribe', "reset=1&mid={$this->_id}")
720 foreach ($elements as $elem) {
725 $this->assign('isRecur', $isRecur);
727 $this->addFormRule(array('CRM_Member_Form_Membership', 'formRule'), $this);
729 $mailingInfo = CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::MAILING_PREFERENCES_NAME
,
732 $this->assign('outBound_option', $mailingInfo['outBound_option']);
734 parent
::buildQuickForm();
740 * @param array $params
741 * (ref.) an assoc array of name/value pairs.
746 * @throws CiviCRM_API3_Exception
747 * @return mixed true or array of errors
750 public static function formRule($params, $files, $self) {
753 $priceSetId = CRM_Utils_Array
::value('price_set_id', $params);
756 CRM_Price_BAO_PriceField
::priceSetValidation($priceSetId, $params, $errors);
758 $priceFieldIDS = array();
759 foreach ($self->_priceSet
['fields'] as $priceIds => $dontCare) {
761 if (!empty($params['price_' . $priceIds])) {
762 if (is_array($params['price_' . $priceIds])) {
763 foreach ($params['price_' . $priceIds] as $priceFldVal => $isSet) {
765 $priceFieldIDS[] = $priceFldVal;
770 $priceFieldIDS[] = $params['price_' . $priceIds];
775 if (!empty($priceFieldIDS)) {
776 $ids = implode(',', $priceFieldIDS);
778 $count = CRM_Price_BAO_PriceSet
::getMembershipCount($ids);
779 foreach ($count as $id => $occurance) {
780 if ($occurance > 1) {
781 $errors['_qf_default'] = ts('Select at most one option associated with the same membership type.');
785 foreach ($priceFieldIDS as $priceFieldId) {
786 if ($id = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceFieldValue', $priceFieldId, 'membership_type_id')) {
787 $self->_memTypeSelected
[$id] = $id;
792 elseif (empty($params['membership_type_id'][1])) {
793 $errors['membership_type_id'] = ts('Please select a membership type.');
796 $self->_memTypeSelected
[] = $params['membership_type_id'][1];
800 $numterms = CRM_Utils_Array
::value('num_terms', $params);
801 if ($numterms && intval($numterms) != $numterms) {
802 $errors['num_terms'] = ts('Please enter an integer for the number of terms.');
806 // Return error if empty $self->_memTypeSelected
807 if ($priceSetId && empty($errors) && empty($self->_memTypeSelected
)) {
808 $errors['_qf_default'] = ts('Select at least one membership option.');
811 if (!empty($errors) && (count($self->_memTypeSelected
) > 1)) {
812 $memberOfContacts = CRM_Member_BAO_MembershipType
::getMemberOfContactByMemTypes($self->_memTypeSelected
);
813 $duplicateMemberOfContacts = array_count_values($memberOfContacts);
814 foreach ($duplicateMemberOfContacts as $countDuplicate) {
815 if ($countDuplicate > 1) {
816 $errors['_qf_default'] = ts('Please do not select more than one membership associated with the same organization.');
821 if (!empty($errors)) {
825 if ($priceSetId && !$self->_mode
&& empty($params['record_contribution'])) {
826 $errors['record_contribution'] = ts('Record Membership Payment is required when you using price set.');
829 if (!$priceSetId && $self->_mode
&& empty($params['financial_type_id'])) {
830 $errors['financial_type_id'] = ts('Please enter the financial Type.');
833 if (!empty($params['record_contribution']) && empty($params['payment_instrument_id'])) {
834 $errors['payment_instrument_id'] = ts('Paid By is a required field.');
837 if (!empty($params['is_different_contribution_contact'])) {
838 if (empty($params['soft_credit_type_id'])) {
839 $errors['soft_credit_type_id'] = ts('Please Select a Soft Credit Type');
841 if (empty($params['soft_credit_contact_id'])) {
842 $errors['soft_credit_contact_id'] = ts('Please select a contact');
846 if (!empty($params['payment_processor_id'])) {
847 // make sure that credit card number and cvv are valid
848 CRM_Core_Payment_Form
::validateCreditCard($params, $errors);
852 if (!empty($params['join_date'])) {
854 $joinDate = CRM_Utils_Date
::processDate($params['join_date']);
856 foreach ($self->_memTypeSelected
as $memType) {
858 if (!empty($params['start_date'])) {
859 $startDate = CRM_Utils_Date
::processDate($params['start_date']);
862 // if end date is set, ensure that start date is also set
863 // and that end date is later than start date
865 if (!empty($params['end_date'])) {
866 $endDate = CRM_Utils_Date
::processDate($params['end_date']);
869 $membershipDetails = CRM_Member_BAO_MembershipType
::getMembershipTypeDetails($memType);
871 if ($startDate && CRM_Utils_Array
::value('period_type', $membershipDetails) == 'rolling') {
872 if ($startDate < $joinDate) {
873 $errors['start_date'] = ts('Start date must be the same or later than Member since.');
878 if ($membershipDetails['duration_unit'] == 'lifetime') {
879 // Check if status is NOT cancelled or similar. For lifetime memberships, there is no automated
880 // process to update status based on end-date. The user must change the status now.
881 $result = civicrm_api3('MembershipStatus', 'get', array(
883 'is_current_member' => 0,
885 $tmp_statuses = $result['values'];
886 $status_ids = array();
887 foreach ($tmp_statuses as $cur_stat) {
888 $status_ids[] = $cur_stat['id'];
890 if (empty($params['status_id']) ||
in_array($params['status_id'], $status_ids) == FALSE) {
891 $errors['status_id'] = ts('Please enter a status that does NOT represent a current membership status.');
892 $errors['is_override'] = ts('This must be checked because you set an End Date for a lifetime membership');
897 $errors['start_date'] = ts('Start date must be set if end date is set.');
899 if ($endDate < $startDate) {
900 $errors['end_date'] = ts('End date must be the same or later than start date.');
905 // Default values for start and end dates if not supplied
907 $defaultDates = CRM_Member_BAO_MembershipType
::getDatesForMembershipType($memType,
914 $startDate = CRM_Utils_Array
::value('start_date',
919 $endDate = CRM_Utils_Array
::value('end_date',
924 //CRM-3724, check for availability of valid membership status.
925 if (empty($params['is_override']) && !isset($errors['_qf_default'])) {
926 $calcStatus = CRM_Member_BAO_MembershipStatus
::getMembershipStatusByDate($startDate,
934 if (empty($calcStatus)) {
935 $url = CRM_Utils_System
::url('civicrm/admin/member/membershipStatus', 'reset=1&action=browse');
936 $errors['_qf_default'] = ts('There is no valid Membership Status available for selected membership dates.');
937 $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));
939 $status .= ' ' . ts('OR You can sign up by setting Status Override? to true.');
941 CRM_Core_Session
::setStatus($status, ts('Membership Status Error'), 'error');
947 $errors['join_date'] = ts('Please enter the Member Since.');
950 if (isset($params['is_override']) &&
951 $params['is_override'] && empty($params['status_id'])) {
952 $errors['status_id'] = ts('Please enter the status.');
955 //total amount condition arise when membership type having no
957 if (isset($params['record_contribution'])) {
958 if (!$params['financial_type_id']) {
959 $errors['financial_type_id'] = ts('Please enter the financial Type.');
961 if (CRM_Utils_System
::isNull($params['total_amount'])) {
962 $errors['total_amount'] = ts('Please enter the contribution.');
966 // validate contribution status for 'Failed'.
967 if ($self->_onlinePendingContributionId
&& !empty($params['record_contribution']) &&
968 (CRM_Utils_Array
::value('contribution_status_id', $params) ==
969 array_search('Failed', CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name'))
972 $errors['contribution_status_id'] = ts('Please select a valid payment status before updating.');
975 return empty($errors) ?
TRUE : $errors;
979 * Process the form submission
984 public function postProcess() {
985 if ($this->_action
& CRM_Core_Action
::DELETE
) {
986 CRM_Member_BAO_Membership
::del($this->_id
);
990 $isTest = ($this->_mode
== 'test') ?
1 : 0;
993 if (!empty($this->_lineItem
)) {
994 $lineItems = $this->_lineItem
;
997 $config = CRM_Core_Config
::singleton();
998 // get the submitted form values.
999 $this->_params
= $formValues = $this->controller
->exportValues($this->_name
);
1000 $this->convertDateFieldsToMySQL($formValues);
1002 $params = $softParams = $ids = array();
1004 $membershipTypeValues = array();
1005 foreach ($this->_memTypeSelected
as $memType) {
1006 $membershipTypeValues[$memType]['membership_type_id'] = $memType;
1009 //take the required membership recur values.
1010 if ($this->_mode
&& !empty($this->_params
['auto_renew'])) {
1011 $params['is_recur'] = $this->_params
['is_recur'] = $formValues['is_recur'] = TRUE;
1013 'frequency_interval' => 'duration_interval',
1014 'frequency_unit' => 'duration_unit',
1018 foreach ($this->_memTypeSelected
as $memType) {
1019 $recurMembershipTypeValues = CRM_Utils_Array
::value($memType,
1020 $this->_recurMembershipTypes
, array()
1022 foreach ($mapping as $mapVal => $mapParam) {
1023 $membershipTypeValues[$memType][$mapVal] = CRM_Utils_Array
::value($mapParam,
1024 $recurMembershipTypeValues
1027 $this->_params
[$mapVal] = $formValues[$mapVal] = CRM_Utils_Array
::value($mapParam,
1028 $recurMembershipTypeValues
1035 // unset send-receipt option, since receipt will be sent when ipn is received.
1036 unset($this->_params
['send_receipt'], $formValues['send_receipt']);
1039 // process price set and get total amount and line items.
1040 $lineItem = array();
1042 if (!$priceSetId = CRM_Utils_Array
::value('price_set_id', $formValues)) {
1043 CRM_Member_BAO_Membership
::createLineItems($this, $formValues['membership_type_id'], $priceSetId);
1046 if ($this->_priceSetId
&& CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet', $this->_priceSetId
, 'is_quick_config')) {
1050 $termsByType = array();
1052 CRM_Price_BAO_PriceSet
::processAmount($this->_priceSet
['fields'],
1053 $this->_params
, $lineItem[$priceSetId]);
1054 if (CRM_Utils_Array
::value('tax_amount', $this->_params
)) {
1055 $params['tax_amount'] = $this->_params
['tax_amount'];
1057 $params['total_amount'] = CRM_Utils_Array
::value('amount', $this->_params
);
1058 $submittedFinancialType = CRM_Utils_Array
::value('financial_type_id', $formValues);
1059 if (!empty($lineItem[$priceSetId])) {
1060 foreach ($lineItem[$priceSetId] as &$li) {
1061 if (!empty($li['membership_type_id'])) {
1062 if (!empty($li['membership_num_terms'])) {
1063 $termsByType[$li['membership_type_id']] = $li['membership_num_terms'];
1067 ///CRM-11529 for quick config backoffice transactions
1068 //when financial_type_id is passed in form, update the
1069 //lineitems with the financial type selected in form
1070 if ($isQuickConfig && $submittedFinancialType) {
1071 $li['financial_type_id'] = $submittedFinancialType;
1077 $this->storeContactFields($formValues);
1079 $params['contact_id'] = $this->_contactID
;
1088 foreach ($fields as $f) {
1089 $params[$f] = CRM_Utils_Array
::value($f, $formValues);
1093 // when is_override false ignore is_admin statuses during membership
1094 // status calculation. similarly we did fix for import in CRM-3570.
1095 if (empty($params['is_override'])) {
1096 $params['exclude_is_admin'] = TRUE;
1099 // process date params to mysql date format.
1101 'join_date' => 'joinDate',
1102 'start_date' => 'startDate',
1103 'end_date' => 'endDate',
1105 foreach ($dateTypes as $dateField => $dateVariable) {
1106 $
$dateVariable = CRM_Utils_Date
::processDate($formValues[$dateField]);
1109 $memTypeNumTerms = empty($termsByType) ? CRM_Utils_Array
::value('num_terms', $formValues) : NULL;
1111 $calcDates = array();
1112 foreach ($this->_memTypeSelected
as $memType) {
1113 if (empty($memTypeNumTerms)) {
1114 $memTypeNumTerms = CRM_Utils_Array
::value($memType, $termsByType, 1);
1116 $calcDates[$memType] = CRM_Member_BAO_MembershipType
::getDatesForMembershipType($memType,
1117 $joinDate, $startDate, $endDate, $memTypeNumTerms
1121 foreach ($calcDates as $memType => $calcDate) {
1122 foreach (array_keys($dateTypes) as $d) {
1123 //first give priority to form values then calDates.
1124 $date = CRM_Utils_Array
::value($d, $formValues);
1126 $date = CRM_Utils_Array
::value($d, $calcDate);
1129 $membershipTypeValues[$memType][$d] = CRM_Utils_Date
::processDate($date);
1130 //$params[$d] = CRM_Utils_Date::processDate( $date );
1134 // max related memberships - take from form or inherit from membership type
1135 foreach ($this->_memTypeSelected
as $memType) {
1136 if (array_key_exists('max_related', $formValues)) {
1137 $membershipTypeValues[$memType]['max_related'] = CRM_Utils_Array
::value('max_related', $formValues);
1142 $ids['membership'] = $params['id'] = $this->_id
;
1145 $session = CRM_Core_Session
::singleton();
1146 $ids['userId'] = $session->get('userID');
1148 // membership type custom data
1149 foreach ($this->_memTypeSelected
as $memType) {
1150 $customFields = CRM_Core_BAO_CustomField
::getFields('Membership', FALSE, FALSE,
1154 $customFields = CRM_Utils_Array
::crmArrayMerge($customFields,
1155 CRM_Core_BAO_CustomField
::getFields('Membership',
1161 $membershipTypeValues[$memType]['custom'] = CRM_Core_BAO_CustomField
::postProcess($formValues,
1168 foreach ($this->_memTypeSelected
as $memType) {
1169 $membershipTypes[$memType] = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType',
1174 $membershipType = implode(', ', $membershipTypes);
1176 // Retrieve the name and email of the current user - this will be the FROM for the receipt email
1177 list($userName, $userEmail) = CRM_Contact_BAO_Contact_Location
::getEmailDetails($ids['userId']);
1179 //CRM-13981, allow different person as a soft-contributor of chosen type
1180 if ($this->_contributorContactID
!= $this->_contactID
) {
1181 $params['contribution_contact_id'] = $this->_contributorContactID
;
1182 if (!empty($this->_params
['soft_credit_type_id'])) {
1183 $softParams['soft_credit_type_id'] = $this->_params
['soft_credit_type_id'];
1184 $softParams['contact_id'] = $this->_contactID
;
1187 if (!empty($formValues['record_contribution'])) {
1188 $recordContribution = array(
1190 'financial_type_id',
1191 'payment_instrument_id',
1193 'contribution_status_id',
1199 foreach ($recordContribution as $f) {
1200 $params[$f] = CRM_Utils_Array
::value($f, $formValues);
1203 if (!$this->_onlinePendingContributionId
) {
1204 if (empty($formValues['source'])) {
1205 $params['contribution_source'] = ts('%1 Membership: Offline signup (by %2)', array(1 => $membershipType, 2 => $userName));
1208 $params['contribution_source'] = $formValues['source'];
1212 if (empty($params['is_override']) &&
1213 CRM_Utils_Array
::value('contribution_status_id', $params) == array_search('Pending', CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name'))
1215 $allStatus = CRM_Member_PseudoConstant
::membershipStatus();
1216 $params['status_id'] = array_search('Pending', $allStatus);
1217 $params['skipStatusCal'] = TRUE;
1218 $params['is_pay_later'] = 1;
1219 $this->assign('is_pay_later', 1);
1222 if (!empty($formValues['send_receipt'])) {
1223 $params['receipt_date'] = CRM_Utils_Array
::value('receive_date', $formValues);
1226 //insert financial type name in receipt.
1227 $formValues['contributionType_name'] = CRM_Core_DAO
::getFieldValue('CRM_Financial_DAO_FinancialType',
1228 $formValues['financial_type_id']
1232 // process line items, until no previous line items.
1233 if (!empty($lineItem)) {
1234 $params['lineItems'] = $lineItem;
1235 $params['processPriceSet'] = TRUE;
1237 $createdMemberships = array();
1239 if (empty($formValues['total_amount']) && !$priceSetId) {
1240 // if total amount not provided minimum for membership type is used
1241 $params['total_amount'] = $formValues['total_amount'] = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType',
1242 $formValues['membership_type_id'][1], 'minimum_fee'
1246 $params['total_amount'] = CRM_Utils_Array
::value('total_amount', $formValues, 0);
1249 if ($priceSetId && !$isQuickConfig) {
1250 $params['financial_type_id'] = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet',
1256 $params['financial_type_id'] = CRM_Utils_Array
::value('financial_type_id', $formValues);
1259 $this->_paymentProcessor
= CRM_Financial_BAO_PaymentProcessor
::getPayment($formValues['payment_processor_id'],
1263 //get the payment processor id as per mode.
1264 $params['payment_processor_id'] = $this->_params
['payment_processor_id'] = $formValues['payment_processor_id'] = $this->_paymentProcessor
['id'];
1266 $now = date('YmdHis');
1269 // set email for primary location.
1270 $fields['email-Primary'] = 1;
1271 $formValues['email-5'] = $formValues['email-Primary'] = $this->_memberEmail
;
1272 $params['register_date'] = $now;
1274 // now set the values for the billing location.
1275 foreach ($this->_fields
as $name => $dontCare) {
1279 // also add location name to the array
1280 $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);
1282 $formValues["address_name-{$this->_bltID}"] = trim($formValues["address_name-{$this->_bltID}"]);
1284 $fields["address_name-{$this->_bltID}"] = 1;
1285 //ensure we don't over-write the payer's email with the member's email
1286 if ($this->_contributorContactID
== $this->_contactID
) {
1287 $fields["email-{$this->_bltID}"] = 1;
1290 $ctype = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $this->_contactID
, 'contact_type');
1292 $nameFields = array('first_name', 'middle_name', 'last_name');
1294 foreach ($nameFields as $name) {
1296 if (array_key_exists("billing_$name", $formValues)) {
1297 $formValues[$name] = $formValues["billing_{$name}"];
1298 $formValues['preserveDBName'] = TRUE;
1301 if ($this->_contributorContactID
== $this->_contactID
) {
1302 //see CRM-12869 for discussion of why we don't do this for separate payee payments
1303 CRM_Contact_BAO_Contact
::createProfileContact($formValues, $fields,
1304 $this->_contributorContactID
, NULL, NULL, $ctype
1308 // add all the additional payment params we need
1309 $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}"]);
1310 $this->_params
["country-{$this->_bltID}"] = $this->_params
["billing_country-{$this->_bltID}"] = CRM_Core_PseudoConstant
::countryIsoCode($this->_params
["billing_country_id-{$this->_bltID}"]);
1312 $this->_params
['year'] = CRM_Core_Payment_Form
::getCreditCardExpirationYear($this->_params
);
1313 $this->_params
['month'] = CRM_Core_Payment_Form
::getCreditCardExpirationMonth($this->_params
);
1314 $this->_params
['ip_address'] = CRM_Utils_System
::ipAddress();
1315 $this->_params
['amount'] = $params['total_amount'];
1316 $this->_params
['currencyID'] = $config->defaultCurrency
;
1317 $this->_params
['description'] = ts('Office Credit Card Membership Signup Contribution');
1318 $this->_params
['payment_action'] = 'Sale';
1319 $this->_params
['invoiceID'] = md5(uniqid(rand(), TRUE));
1320 $this->_params
['financial_type_id'] = $params['financial_type_id'];
1322 // at this point we've created a contact and stored its address etc
1323 // all the payment processors expect the name and address to be in the
1324 // so we copy stuff over to first_name etc.
1325 $paymentParams = $this->_params
;
1326 $paymentParams['contactID'] = $this->_contributorContactID
;
1327 //CRM-10377 if payment is by an alternate contact then we need to set that person
1328 // as the contact in the payment params
1329 if ($this->_contributorContactID
!= $this->_contactID
) {
1330 if (!empty($this->_params
['soft_credit_type_id'])) {
1331 $softParams['contact_id'] = $params['contact_id'];
1332 $softParams['soft_credit_type_id'] = $this->_params
['soft_credit_type_id'];
1335 if (!empty($this->_params
['send_receipt'])) {
1336 $paymentParams['email'] = $this->_contributorEmail
;
1339 CRM_Core_Payment_Form
::mapParams($this->_bltID
, $this->_params
, $paymentParams, TRUE);
1341 // CRM-7137 -for recurring membership,
1342 // we do need contribution and recuring records.
1344 if (!empty($paymentParams['is_recur'])) {
1345 $allStatus = CRM_Member_PseudoConstant
::membershipStatus();
1347 $contributionType = new CRM_Financial_DAO_FinancialType();
1348 $contributionType->id
= $params['financial_type_id'];
1349 if (!$contributionType->find(TRUE)) {
1350 CRM_Core_Error
::fatal('Could not find a system table');
1353 $contribution = CRM_Contribute_Form_Contribution_Confirm
::processContribution($this,
1356 $this->_contributorContactID
,
1364 //create new soft-credit record, CRM-13981
1366 $softParams['contribution_id'] = $contribution->id
;
1367 $softParams['currency'] = $contribution->currency
;
1368 $softParams['amount'] = $contribution->total_amount
;
1369 CRM_Contribute_BAO_ContributionSoft
::add($softParams);
1372 $paymentParams['contactID'] = $this->_contactID
;
1373 $paymentParams['contributionID'] = $contribution->id
;
1374 $paymentParams['contributionTypeID'] = $contribution->financial_type_id
;
1375 $paymentParams['contributionPageID'] = $contribution->contribution_page_id
;
1376 $paymentParams['contributionRecurID'] = $contribution->contribution_recur_id
;
1377 $ids['contribution'] = $contribution->id
;
1378 $params['contribution_recur_id'] = $paymentParams['contributionRecurID'];
1379 $params['status_id'] = array_search('Pending', $allStatus);
1380 $params['skipStatusCal'] = TRUE;
1382 //as membership is pending set dates to null.
1383 $memberDates = array(
1384 'join_date' => 'joinDate',
1385 'start_date' => 'startDate',
1386 'end_date' => 'endDate',
1389 foreach ($memberDates as $dp => $dv) {
1391 foreach ($this->_memTypeSelected
as $memType) {
1392 $membershipTypeValues[$memType][$dv] = NULL;
1397 if ($params['total_amount'] > 0.0) {
1398 $payment = CRM_Core_Payment
::singleton($this->_mode
, $this->_paymentProcessor
, $this);
1399 $result = $payment->doDirectPayment($paymentParams);
1402 if (is_a($result, 'CRM_Core_Error')) {
1403 //make sure to cleanup db for recurring case.
1404 if (!empty($paymentParams['contributionID'])) {
1405 CRM_Contribute_BAO_Contribution
::deleteContribution($paymentParams['contributionID']);
1407 if (!empty($paymentParams['contributionRecurID'])) {
1408 CRM_Contribute_BAO_ContributionRecur
::deleteRecurContribution($paymentParams['contributionRecurID']);
1411 CRM_Core_Error
::displaySessionError($result);
1412 CRM_Utils_System
::redirect(CRM_Utils_System
::url('civicrm/contact/view/membership',
1413 "reset=1&action=add&cid={$this->_contactID}&context=&mode={$this->_mode}"
1418 $this->_params
= array_merge($this->_params
, $result);
1419 //assign amount to template if payment was successful
1420 $this->assign('amount', $params['total_amount']);
1423 $params['contribution_status_id'] = !empty($paymentParams['is_recur']) ?
2 : 1;
1424 $params['receive_date'] = $now;
1425 $params['invoice_id'] = $this->_params
['invoiceID'];
1426 $params['contribution_source'] = ts('%1 Membership Signup: Credit card or direct debit (by %2)',
1427 array(1 => $membershipType, 2 => $userName)
1429 $params['source'] = $formValues['source'] ?
$formValues['source'] : $params['contribution_source'];
1430 $params['trxn_id'] = CRM_Utils_Array
::value('trxn_id', $result);
1431 $params['payment_instrument_id'] = 1;
1432 $params['is_test'] = ($this->_mode
== 'live') ?
0 : 1;
1433 if (!empty($this->_params
['send_receipt'])) {
1434 $params['receipt_date'] = $now;
1437 $params['receipt_date'] = NULL;
1440 $this->set('params', $this->_params
);
1441 $this->assign('trxn_id', CRM_Utils_Array
::value('trxn_id', $result));
1442 $this->assign('receive_date',
1443 CRM_Utils_Date
::mysqlToIso($params['receive_date'])
1446 // required for creating membership for related contacts
1447 $params['action'] = $this->_action
;
1449 //create membership record.
1451 foreach ($this->_memTypeSelected
as $memType) {
1453 ($relateContribution = CRM_Member_BAO_Membership
::getMembershipContributionId($membership->id
))
1455 $membershipTypeValues[$memType]['relate_contribution_id'] = $relateContribution;
1458 $membershipParams = array_merge($membershipTypeValues[$memType], $params);
1460 if (!empty($softParams) && empty($paymentParams['is_recur'])) {
1461 $membershipParams['soft_credit'] = $softParams;
1463 $membership = CRM_Member_BAO_Membership
::create($membershipParams, $ids);
1464 $params['contribution'] = CRM_Utils_Array
::value('contribution', $membershipParams);
1465 unset($params['lineItems']);
1466 $this->_membershipIDs
[] = $membership->id
;
1467 $createdMemberships[$memType] = $membership;
1473 $params['action'] = $this->_action
;
1474 if ($this->_onlinePendingContributionId
&& !empty($formValues['record_contribution'])) {
1476 // update membership as well as contribution object, CRM-4395
1477 $params['contribution_id'] = $this->_onlinePendingContributionId
;
1478 $params['componentId'] = $params['id'];
1479 $params['componentName'] = 'contribute';
1480 $result = CRM_Contribute_BAO_Contribution
::transitionComponents($params, TRUE);
1481 if (!empty($result) && !empty($params['contribution_id'])) {
1482 $lineItem = array();
1483 $lineItems = CRM_Price_BAO_LineItem
::getLineItems($params['contribution_id'], 'contribution', NULL, TRUE, TRUE);
1484 $itemId = key($lineItems);
1485 $priceSetId = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceField', $lineItems[$itemId]['price_field_id'], 'price_set_id');
1487 if ($itemId && !empty($lineItems[$itemId]['price_field_id'])) {
1488 $fieldType = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceField', $lineItems[$itemId]['price_field_id'], 'html_type');
1490 $lineItems[$itemId]['unit_price'] = $params['total_amount'];
1491 $lineItems[$itemId]['line_total'] = $params['total_amount'];
1492 $lineItems[$itemId]['id'] = $itemId;
1493 $lineItem[$priceSetId] = $lineItems;
1494 $contributionBAO = new CRM_Contribute_BAO_Contribution();
1495 $contributionBAO->id
= $params['contribution_id'];
1496 $contributionBAO->contact_id
= $params['contact_id'];
1497 $contributionBAO->find();
1498 CRM_Price_BAO_LineItem
::processPriceSet($params['contribution_id'], $lineItem, $contributionBAO, 'civicrm_membership');
1500 //create new soft-credit record, CRM-13981
1502 $softParams['contribution_id'] = $params['contribution_id'];
1503 while ($contributionBAO->fetch()) {
1504 $softParams['currency'] = $contributionBAO->currency
;
1505 $softParams['amount'] = $contributionBAO->total_amount
;
1507 CRM_Contribute_BAO_ContributionSoft
::add($softParams);
1511 //carry updated membership object.
1512 $membership = new CRM_Member_DAO_Membership();
1513 $membership->id
= $this->_id
;
1514 $membership->find(TRUE);
1517 if ($membership->end_date
) {
1518 //display end date w/ status message.
1519 $endDate = $membership->end_date
;
1521 if (!in_array($membership->status_id
, array(
1523 array_search('Cancelled', CRM_Member_PseudoConstant
::membershipStatus(NULL, " name = 'Cancelled' ", 'name', FALSE, TRUE)),
1524 array_search('Expired', CRM_Member_PseudoConstant
::membershipStatus()),
1530 // suppress form values in template.
1531 $this->assign('cancelled', $cancelled);
1533 // FIX ME: need to recheck this
1534 // here we might updated dates, so get from object.
1535 foreach ($calcDates[$membership->membership_type_id
] as $date => & $val) {
1536 if ($membership->$date) {
1537 $val = $membership->$date;
1541 $createdMemberships[] = $membership;
1545 foreach ($this->_memTypeSelected
as $memType) {
1546 if ($count && !empty($formValues['record_contribution']) &&
1547 ($relateContribution = CRM_Member_BAO_Membership
::getMembershipContributionId($membership->id
))
1549 $membershipTypeValues[$memType]['relate_contribution_id'] = $relateContribution;
1552 $membershipParams = array_merge($params, $membershipTypeValues[$memType]);
1553 if (!empty($formValues['int_amount'])) {
1554 $init_amount = array();
1555 foreach ($formValues as $key => $value) {
1556 if (strstr($key, 'txt-price')) {
1557 $init_amount[$key] = $value;
1560 $membershipParams['init_amount'] = $init_amount;
1563 if (!empty($softParams)) {
1564 $membershipParams['soft_credit'] = $softParams;
1567 $membership = CRM_Member_BAO_Membership
::create($membershipParams, $ids);
1568 $params['contribution'] = CRM_Utils_Array
::value('contribution', $membershipParams);
1569 unset($params['lineItems']);
1571 $this->_membershipIDs
[] = $membership->id
;
1572 $createdMemberships[$memType] = $membership;
1578 if (!empty($lineItem[$priceSetId])) {
1579 $invoiceSettings = CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::CONTRIBUTE_PREFERENCES_NAME
, 'contribution_invoice_settings');
1580 $invoicing = CRM_Utils_Array
::value('invoicing', $invoiceSettings);
1582 $totalTaxAmount = 0;
1583 foreach ($lineItem[$priceSetId] as & $priceFieldOp) {
1584 if (!empty($priceFieldOp['membership_type_id'])) {
1585 $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') : '-';
1586 $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') : '-';
1589 $priceFieldOp['start_date'] = $priceFieldOp['end_date'] = 'N/A';
1591 if ($invoicing && isset($priceFieldOp['tax_amount'])) {
1593 $totalTaxAmount +
= $priceFieldOp['tax_amount'];
1597 $dataArray = array();
1598 foreach ($lineItem[$priceSetId] as $key => $value) {
1599 if (isset($value['tax_amount']) && isset($value['tax_rate'])) {
1600 if (isset($dataArray[$value['tax_rate']])) {
1601 $dataArray[$value['tax_rate']] = $dataArray[$value['tax_rate']] + CRM_Utils_Array
::value('tax_amount', $value);
1604 $dataArray[$value['tax_rate']] = CRM_Utils_Array
::value('tax_amount', $value);
1609 $this->assign('totalTaxAmount', $totalTaxAmount);
1610 $this->assign('taxTerm', CRM_Utils_Array
::value('tax_term', $invoiceSettings));
1612 $this->assign('dataArray', $dataArray);
1615 $this->assign('lineItem', !empty($lineItem) && !$isQuickConfig ?
$lineItem : FALSE);
1617 $receiptSend = FALSE;
1618 if (!empty($formValues['send_receipt'])) {
1619 $receiptSend = TRUE;
1621 $formValues['contact_id'] = $this->_contactID
;
1623 $formValues['contribution_id'] = CRM_Member_BAO_Membership
::getMembershipContributionId($membership->id
);
1624 // send email receipt
1625 $mailSend = self
::emailReceipt($this, $formValues, $membership);
1628 if (($this->_action
& CRM_Core_Action
::UPDATE
)) {
1629 //end date can be modified by hooks, so if end date is set then use it.
1630 $endDate = ($membership->end_date
) ?
$membership->end_date
: $endDate;
1632 $statusMsg = ts('Membership for %1 has been updated.', array(1 => $this->_memberDisplayName
));
1633 if ($endDate && $endDate !== 'null') {
1634 $endDate = CRM_Utils_Date
::customFormat($endDate);
1635 $statusMsg .= ' ' . ts('The membership End Date is %1.', array(1 => $endDate));
1638 $statusMsg .= ' ' . ts('A confirmation and receipt has been sent to %1.', array(1 => $this->_contributorEmail
));
1641 elseif (($this->_action
& CRM_Core_Action
::ADD
)) {
1642 // FIX ME: fix status messages
1644 $statusMsg = array();
1645 foreach ($membershipTypes as $memType => $membershipType) {
1646 $statusMsg[$memType] = ts('%1 membership for %2 has been added.', array(
1647 1 => $membershipType,
1648 2 => $this->_memberDisplayName
,
1651 $membership = $createdMemberships[$memType];
1652 $memEndDate = ($membership->end_date
) ?
$membership->end_date
: $endDate;
1654 //get the end date from calculated dates.
1655 if (!$memEndDate && empty($params['is_recur'])) {
1656 $memEndDate = CRM_Utils_Array
::value('end_date', $calcDates[$memType]);
1659 if ($memEndDate && $memEndDate !== 'null') {
1660 $memEndDate = CRM_Utils_Date
::customFormat($memEndDate);
1661 $statusMsg[$memType] .= ' ' . ts('The new membership End Date is %1.', array(1 => $memEndDate));
1664 $statusMsg = implode('<br/>', $statusMsg);
1665 if ($receiptSend && $mailSend) {
1666 $statusMsg .= ' ' . ts('A membership confirmation and receipt has been sent to %1.', array(1 => $this->_contributorEmail
));
1670 // finally set membership id if already not set
1672 $this->_id
= $membership->id
;
1675 CRM_Core_Session
::setStatus($statusMsg, ts('Complete'), 'success');
1677 $buttonName = $this->controller
->getButtonName();
1678 if ($this->_context
== 'standalone') {
1679 if ($buttonName == $this->getButtonName('upload', 'new')) {
1680 $session->replaceUserContext(CRM_Utils_System
::url('civicrm/member/add',
1681 'reset=1&action=add&context=standalone'
1685 $session->replaceUserContext(CRM_Utils_System
::url('civicrm/contact/view',
1686 "reset=1&cid={$this->_contactID}&selectedChild=member"
1690 elseif ($buttonName == $this->getButtonName('upload', 'new')) {
1691 $session->replaceUserContext(CRM_Utils_System
::url('civicrm/contact/view/membership',
1692 "reset=1&action=add&context=membership&cid={$this->_contactID}"
1698 * Send email receipt
1700 * @param CRM_Core_Form $form
1702 * @param array $formValues
1703 * @param object $membership
1707 * true if mail was sent successfully
1710 public static function emailReceipt(&$form, &$formValues, &$membership) {
1711 // retrieve 'from email id' for acknowledgement
1712 $receiptFrom = $formValues['from_email_address'];
1714 if (!empty($formValues['payment_instrument_id'])) {
1715 $paymentInstrument = CRM_Contribute_PseudoConstant
::paymentInstrument();
1716 $formValues['paidBy'] = $paymentInstrument[$formValues['payment_instrument_id']];
1719 // retrieve custom data
1720 $customFields = $customValues = array();
1721 if (property_exists($form, '_groupTree')
1722 && !empty($form->_groupTree
)
1724 foreach ($form->_groupTree
as $groupID => $group) {
1725 if ($groupID == 'info') {
1728 foreach ($group['fields'] as $k => $field) {
1729 $field['title'] = $field['label'];
1730 $customFields["custom_{$k}"] = $field;
1735 $members = array(array('member_id', '=', $membership->id
, 0, 0));
1736 // check whether its a test drive
1737 if ($form->_mode
== 'test') {
1738 $members[] = array('member_test', '=', 1, 0, 0);
1741 CRM_Core_BAO_UFGroup
::getValues($formValues['contact_id'], $customFields, $customValues, FALSE, $members);
1744 if (!empty($form->_params
['billing_first_name'])) {
1745 $name = $form->_params
['billing_first_name'];
1748 if (!empty($form->_params
['billing_middle_name'])) {
1749 $name .= " {$form->_params['billing_middle_name']}";
1752 if (!empty($form->_params
['billing_last_name'])) {
1753 $name .= " {$form->_params['billing_last_name']}";
1756 $form->assign('billingName', $name);
1758 // assign the address formatted up for display
1759 $addressParts = array(
1760 "street_address-{$form->_bltID}",
1761 "city-{$form->_bltID}",
1762 "postal_code-{$form->_bltID}",
1763 "state_province-{$form->_bltID}",
1764 "country-{$form->_bltID}",
1766 $addressFields = array();
1767 foreach ($addressParts as $part) {
1768 list($n, $id) = explode('-', $part);
1769 if (isset($form->_params
['billing_' . $part])) {
1770 $addressFields[$n] = $form->_params
['billing_' . $part];
1773 $form->assign('address', CRM_Utils_Address
::format($addressFields));
1775 $date = CRM_Utils_Date
::format($form->_params
['credit_card_exp_date']);
1776 $date = CRM_Utils_Date
::mysqlToIso($date);
1777 $form->assign('credit_card_exp_date', $date);
1778 $form->assign('credit_card_number',
1779 CRM_Utils_System
::mungeCreditCard($form->_params
['credit_card_number'])
1781 $form->assign('credit_card_type', $form->_params
['credit_card_type']);
1782 $form->assign('contributeMode', 'direct');
1783 $form->assign('isAmountzero', 0);
1784 $form->assign('is_pay_later', 0);
1785 $form->assign('isPrimary', 1);
1788 $form->assign('module', 'Membership');
1789 $form->assign('contactID', $formValues['contact_id']);
1791 $form->assign('membershipID', CRM_Utils_Array
::value('membership_id', $form->_params
, CRM_Utils_Array
::value('membership_id', $form->_defaultValues
)));
1793 if (!empty($formValues['contribution_id'])) {
1794 $form->assign('contributionID', $formValues['contribution_id']);
1796 elseif (isset($form->_onlinePendingContributionId
)) {
1797 $form->assign('contributionID', $form->_onlinePendingContributionId
);
1800 if (!empty($formValues['contribution_status_id'])) {
1801 $form->assign('contributionStatusID', $formValues['contribution_status_id']);
1802 $form->assign('contributionStatus', CRM_Contribute_PseudoConstant
::contributionStatus($formValues['contribution_status_id'], 'name'));
1805 if (!empty($formValues['is_renew'])) {
1806 $form->assign('receiptType', 'membership renewal');
1809 $form->assign('receiptType', 'membership signup');
1811 $form->assign('receive_date', CRM_Utils_Date
::processDate(CRM_Utils_Array
::value('receive_date', $formValues)));
1812 $form->assign('formValues', $formValues);
1814 if (empty($lineItem)) {
1815 $form->assign('mem_start_date', CRM_Utils_Date
::customFormat($membership->start_date
, '%B %E%f, %Y'));
1816 if (!CRM_Utils_System
::isNull($membership->end_date
)) {
1817 $form->assign('mem_end_date', CRM_Utils_Date
::customFormat($membership->end_date
, '%B %E%f, %Y'));
1819 $form->assign('membership_name', CRM_Member_PseudoConstant
::membershipType($membership->membership_type_id
));
1822 $form->assign('customValues', $customValues);
1823 $isBatchProcess = is_a($form, 'CRM_Batch_Form_Entry');
1824 if ((empty($form->_contributorDisplayName
) ||
empty($form->_contributorEmail
)) ||
$isBatchProcess) {
1825 // in this case the form is being called statically from the batch editing screen
1826 // having one class in the form layer call another statically is not greate
1827 // & we should aim to move this function to the BAO layer in future.
1828 // however, we can assume that the contact_id passed in by the batch
1829 // function will be the recipient
1831 $form->_contributorDisplayName
,
1832 $form->_contributorEmail
1833 ) = CRM_Contact_BAO_Contact_Location
::getEmailDetails(
1834 $formValues['contact_id']
1836 if (empty($form->_receiptContactId
) ||
$isBatchProcess) {
1837 $form->_receiptContactId
= $formValues['contact_id'];
1840 $template = CRM_Core_Smarty
::singleton();
1841 $taxAmt = $template->get_template_vars('dataArray');
1842 $eventTaxAmt = $template->get_template_vars('totalTaxAmount');
1843 $prefixValue = CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::CONTRIBUTE_PREFERENCES_NAME
, 'contribution_invoice_settings');
1844 $invoicing = CRM_Utils_Array
::value('invoicing', $prefixValue);
1845 if ((!empty($taxAmt) ||
isset($eventTaxAmt)) && (isset($invoicing) && isset($prefixValue['is_email_pdf']))) {
1849 $isEmailPdf = FALSE;
1852 list($mailSend, $subject, $message, $html) = CRM_Core_BAO_MessageTemplate
::sendTemplate(
1854 'groupName' => 'msg_tpl_workflow_membership',
1855 'valueName' => 'membership_offline_receipt',
1856 'contactId' => $form->_receiptContactId
,
1857 'from' => $receiptFrom,
1858 'toName' => $form->_contributorDisplayName
,
1859 'toEmail' => $form->_contributorEmail
,
1860 'PDFFilename' => ts('receipt') . '.pdf',
1861 'isEmailPdf' => $isEmailPdf,
1862 'contributionId' => $formValues['contribution_id'],
1863 'isTest' => (bool) ($form->_action
& CRM_Core_Action
::PREVIEW
),