3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
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 protected $_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);
115 $this->_priceSetId
= CRM_Utils_Array
::value('priceSetId', $_GET);
116 $this->set('priceSetId', $this->_priceSetId
);
117 $this->assign('priceSetId', $this->_priceSetId
);
120 $this->_action
= CRM_Utils_Request
::retrieve('action', 'String', $this, FALSE, 'add');
121 $this->_id
= CRM_Utils_Request
::retrieve('id', 'Positive', $this);
122 $this->_contactID
= CRM_Utils_Request
::retrieve('cid', 'Positive', $this);
123 $this->_processors
= array();
124 CRM_Core_Resources
::singleton()->addSetting(array('ids' => array('contact' => $this->_contactID
)));
126 // check for edit permission
127 if (!CRM_Core_Permission
::checkActionPermission('CiviMember', $this->_action
)) {
128 CRM_Core_Error
::fatal(ts('You do not have permission to access this page'));
131 if ($this->_action
& CRM_Core_Action
::DELETE
) {
132 $contributionID = CRM_Member_BAO_Membership
::getMembershipContributionId($this->_id
);
133 // check delete permission for contribution
134 if ($this->_id
&& $contributionID && !CRM_Core_Permission
::checkActionPermission('CiviContribute', $this->_action
)) {
135 CRM_Core_Error
::fatal(ts("This Membership is linked to a contribution. You must have 'delete in CiviContribute' permission in order to delete this record."));
139 $this->_context
= CRM_Utils_Request
::retrieve('context', 'String', $this);
140 $this->assign('context', $this->_context
);
143 $this->_memType
= CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership', $this->_id
, 'membership_type_id');
144 $this->_membershipIDs
[] = $this->_id
;
147 $this->_mode
= CRM_Utils_Request
::retrieve('mode', 'String', $this);
148 $this->assign('membershipMode', $this->_mode
);
151 $this->_paymentProcessor
= array('billing_mode' => 1);
152 $validProcessors = array();
153 $processors = CRM_Core_PseudoConstant
::paymentProcessor(FALSE, FALSE, 'billing_mode IN ( 1, 3 )');
155 foreach ($processors as $ppID => $label) {
156 $paymentProcessor = CRM_Financial_BAO_PaymentProcessor
::getPayment($ppID, $this->_mode
);
157 if ($paymentProcessor['payment_processor_type'] == 'PayPal' && !$paymentProcessor['user_name']) {
160 elseif ($paymentProcessor['payment_processor_type'] == 'Dummy' && $this->_mode
== 'live') {
164 $paymentObject = CRM_Core_Payment
::singleton($this->_mode
, $paymentProcessor, $this);
165 $error = $paymentObject->checkConfig();
167 $validProcessors[$ppID] = $label;
169 $paymentObject = NULL;
172 if (empty($validProcessors)) {
173 CRM_Core_Error
::fatal(ts('Could not find valid payment processor for this page'));
176 $this->_processors
= $validProcessors;
178 // also check for billing information
179 // get the billing location type
180 $locationTypes = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Address', 'location_type_id', array(), 'validate');
181 // CRM-8108 remove ts around Billing location type
182 //$this->_bltID = array_search( ts('Billing'), $locationTypes );
183 $this->_bltID
= array_search('Billing', $locationTypes);
184 if (!$this->_bltID
) {
185 CRM_Core_Error
::fatal(ts('Please set a location type of %1', array(1 => 'Billing')));
187 $this->set('bltID', $this->_bltID
);
188 $this->assign('bltID', $this->_bltID
);
190 $this->_fields
= array();
192 CRM_Core_Payment_Form
::setCreditCardFields($this);
194 // this required to show billing block
195 $this->assign_by_ref('paymentProcessor', $paymentProcessor);
196 $this->assign('hidePayPalExpress', TRUE);
199 if ($this->_action
& CRM_Core_Action
::ADD
) {
200 if (!CRM_Member_BAO_Membership
::statusAvailabilty($this->_contactID
)) {
201 // all possible statuses are disabled - redirect back to contact form
202 CRM_Core_Error
::statusBounce(ts('There are no configured membership statuses. You cannot add this membership until your membership statuses are correctly configured'));
205 if ($this->_contactID
) {
206 //check whether contact has a current membership so we can alert user that they may want to do a renewal instead
207 $contactMemberships = array();
208 $memParams = array('contact_id' => $this->_contactID
);
209 CRM_Member_BAO_Membership
::getValues($memParams, $contactMemberships, TRUE);
210 $cMemTypes = array();
211 foreach ($contactMemberships as $mem) {
212 $cMemTypes[] = $mem['membership_type_id'];
214 if (count($cMemTypes) > 0) {
215 $memberorgs = CRM_Member_BAO_MembershipType
::getMemberOfContactByMemTypes($cMemTypes);
216 $mems_by_org = array();
217 foreach ($contactMemberships as $memid => $mem) {
218 $mem['member_of_contact_id'] = CRM_Utils_Array
::value($mem['membership_type_id'], $memberorgs);
219 if (!empty($mem['membership_end_date'])) {
220 $mem['membership_end_date'] = CRM_Utils_Date
::customformat($mem['membership_end_date']);
222 $mem['membership_type'] = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType',
223 $mem['membership_type_id'],
226 $mem['membership_status'] = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipStatus',
231 $mem['renewUrl'] = CRM_Utils_System
::url('civicrm/contact/view/membership',
232 "reset=1&action=renew&cid={$this->_contactID}&id={$mem['id']}&context=membership&selectedChild=member&mode=live"
236 $mem['renewUrl'] = CRM_Utils_System
::url('civicrm/contact/view/membership',
237 "reset=1&action=renew&cid={$this->_contactID}&id={$mem['id']}&context=membership&selectedChild=member"
240 $mem['membershipTab'] = CRM_Utils_System
::url('civicrm/contact/view',
241 "reset=1&force=1&cid={$this->_contactID}&selectedChild=member"
243 $mems_by_org[$mem['member_of_contact_id']] = $mem;
245 $resources = CRM_Core_Resources
::singleton();
246 $resources->addSetting(array('existingMems' => array('memberorgs' => $mems_by_org)));
247 $resources->addScriptFile('civicrm', 'templates/CRM/Member/Form/Membership.js');
251 $resources = CRM_Core_Resources
::singleton();
252 $resources->addScriptFile('civicrm', 'templates/CRM/Member/Form/MembershipStandalone.js');
254 $membershipStatus = new CRM_Member_DAO_MembershipStatus();
255 $membershipStatus->is_current_member
= 1;
256 $membershipStatus->find();
257 $membershipStatus->selectAdd();
258 $membershipStatus->selectAdd('id');
259 while ($membershipStatus->fetch()) {
260 $statuses[$membershipStatus->id
] = $membershipStatus->label
;
262 $membershipStatus->free();
264 'typeorgs' => CRM_Member_BAO_MembershipType
::getMembershipTypeOrganization(),
265 'memtypes' => CRM_Member_BAO_MembershipType
::getMembershipTypes(FALSE),
266 'statuses' => $statuses,
268 $resources->addSetting(array('existingMems' => $passthru));
272 // when custom data is included in this page
273 if (!empty($_POST['hidden_custom'])) {
274 CRM_Custom_Form_CustomData
::preProcess($this);
275 CRM_Custom_Form_CustomData
::buildQuickForm($this);
276 CRM_Custom_Form_CustomData
::setDefaultValues($this);
279 // CRM-4395, get the online pending contribution id.
280 $this->_onlinePendingContributionId
= NULL;
281 if (!$this->_mode
&& $this->_id
&& ($this->_action
& CRM_Core_Action
::UPDATE
)) {
282 $this->_onlinePendingContributionId
= CRM_Contribute_BAO_Contribution
::checkOnlinePendingContribution($this->_id
,
286 $this->assign('onlinePendingContributionId', $this->_onlinePendingContributionId
);
287 $this->_fromEmails
= CRM_Core_BAO_Email
::getFromEmail();
290 if ($this->_contactID
) {
291 $displayName = CRM_Contact_BAO_Contact
::displayName($this->_contactID
);
293 // Check if this is default domain contact CRM-10482
294 if (CRM_Contact_BAO_Contact
::checkDomainContact($this->_contactID
)) {
295 $displayName .= ' (' . ts('default organization') . ')';
298 // omitting contactImage from title for now since the summary overlay css doesn't work outside of our crm-container
299 CRM_Utils_System
::setTitle(ts('Membership for') . ' ' . $displayName);
301 parent
::preProcess();
305 * This function sets the default values for the form. MobileProvider that in edit/view mode
306 * the default values are retrieved from the database
312 public function setDefaultValues() {
313 if ($this->_cdType
) {
314 return CRM_Custom_Form_CustomData
::setDefaultValues($this);
317 if ($this->_priceSetId
) {
318 return CRM_Price_BAO_PriceSet
::setDefaultPriceSet($this, $defaults);
321 $defaults = parent
::setDefaultValues();
323 //setting default join date and receive date
324 list($now, $currentTime) = CRM_Utils_Date
::setDateDefaults();
325 if ($this->_action
== CRM_Core_Action
::ADD
) {
326 $defaults['receive_date'] = $now;
327 $defaults['receive_date_time'] = $currentTime;
330 if (is_numeric($this->_memType
)) {
331 $defaults['membership_type_id'] = array();
332 $defaults['membership_type_id'][0] = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType',
334 'member_of_contact_id',
337 $defaults['membership_type_id'][1] = $this->_memType
;
340 $defaults['membership_type_id'] = $this->_memType
;
343 $defaults['num_terms'] = 1;
345 if (!empty($defaults['id'])) {
346 if ($this->_onlinePendingContributionId
) {
347 $defaults['record_contribution'] = $this->_onlinePendingContributionId
;
350 $contributionId = CRM_Core_DAO
::singleValueQuery("
351 SELECT contribution_id
352 FROM civicrm_membership_payment
353 WHERE membership_id = $this->_id
354 ORDER BY contribution_id
357 if ($contributionId) {
358 $defaults['record_contribution'] = $contributionId;
363 //set Soft Credit Type to Gift by default
364 $scTypes = CRM_Core_OptionGroup
::values("soft_credit_type");
365 $defaults['soft_credit_type_id'] = CRM_Utils_Array
::value(ts('Gift'), array_flip($scTypes));
367 if (!empty($defaults['record_contribution']) && !$this->_mode
) {
368 $contributionParams = array('id' => $defaults['record_contribution']);
369 $contributionIds = array();
371 //keep main object campaign in hand.
372 $memberCampaignId = CRM_Utils_Array
::value('campaign_id', $defaults);
374 CRM_Contribute_BAO_Contribution
::getValues($contributionParams, $defaults, $contributionIds);
376 //get back original object campaign id.
377 $defaults['campaign_id'] = $memberCampaignId;
379 if (!empty($defaults['receive_date'])) {
380 list($defaults['receive_date']) = CRM_Utils_Date
::setDateDefaults($defaults['receive_date']);
383 // Contribution::getValues() over-writes the membership record's source field value - so we need to restore it.
384 if (!empty($defaults['membership_source'])) {
385 $defaults['source'] = $defaults['membership_source'];
389 if (empty($defaults['payment_instrument_id'])) {
390 $defaults['payment_instrument_id'] = key(CRM_Core_OptionGroup
::values('payment_instrument', FALSE, FALSE, FALSE, 'AND is_default = 1'));
393 // User must explicitly choose to send a receipt in both add and update mode.
394 $defaults['send_receipt'] = 0;
396 if ($this->_action
& CRM_Core_Action
::UPDATE
) {
397 // in this mode by default uncheck this checkbox
398 unset($defaults['record_contribution']);
401 if (!empty($defaults['id'])) {
402 $subscriptionCancelled = CRM_Member_BAO_Membership
::isSubscriptionCancelled($this->_id
);
405 $alreadyAutoRenew = FALSE;
406 if (!empty($defaults['contribution_recur_id']) && !$subscriptionCancelled) {
407 $defaults['auto_renew'] = 1;
408 $alreadyAutoRenew = TRUE;
410 $this->assign('alreadyAutoRenew', $alreadyAutoRenew);
412 $this->assign('member_is_test', CRM_Utils_Array
::value('member_is_test', $defaults));
414 $this->assign('membership_status_id', CRM_Utils_Array
::value('status_id', $defaults));
416 if (!empty($defaults['is_pay_later'])) {
417 $this->assign('is_pay_later', TRUE);
420 // set default country from config if no country set
421 $config = CRM_Core_Config
::singleton();
422 if (empty($defaults["billing_country_id-{$this->_bltID}"])) {
423 $defaults["billing_country_id-{$this->_bltID}"] = $config->defaultContactCountry
;
426 if (empty($defaults["billing_state_province_id-{$this->_bltID}"])) {
427 $defaults["billing_state_province_id-{$this->_bltID}"] = $config->defaultContactStateProvince
;
430 $billingDefaults = $this->getProfileDefaults('Billing', $this->_contactID
);
431 $defaults = array_merge($defaults, $billingDefaults);
433 // now fix all state country selectors, set correct state based on country
434 CRM_Core_BAO_Address
::fixAllStateSelects($this, $defaults);
436 // // hack to simplify credit card entry for testing
437 // $defaults['credit_card_type'] = 'Visa';
438 // $defaults['credit_card_number'] = '4807731747657838';
439 // $defaults['cvv2'] = '000';
440 // $defaults['credit_card_exp_date'] = array( 'Y' => '2012', 'M' => '05' );
443 $dates = array('join_date', 'start_date', 'end_date');
444 foreach ($dates as $key) {
445 if (!empty($defaults[$key])) {
446 list($defaults[$key]) = CRM_Utils_Date
::setDateDefaults(CRM_Utils_Array
::value($key, $defaults));
450 //setting default join date if there is no join date
451 if (empty($defaults['join_date'])) {
452 $defaults['join_date'] = $now;
455 if (!empty($defaults['membership_end_date'])) {
456 $this->assign('endDate', $defaults['membership_end_date']);
463 * Function to build the form
468 public function buildQuickForm() {
469 if ($this->_cdType
) {
470 return CRM_Custom_Form_CustomData
::buildQuickForm($this);
473 $this->assign('taxRates', json_encode(CRM_Core_PseudoConstant
::getTaxRates()));
474 // build price set form.
475 $buildPriceSet = FALSE;
476 if ($this->_priceSetId ||
!empty($_POST['price_set_id'])) {
477 if (!empty($_POST['price_set_id'])) {
478 $buildPriceSet = TRUE;
480 $getOnlyPriceSetElements = TRUE;
481 if (!$this->_priceSetId
) {
482 $this->_priceSetId
= $_POST['price_set_id'];
483 $getOnlyPriceSetElements = FALSE;
486 $this->set('priceSetId', $this->_priceSetId
);
487 CRM_Price_BAO_PriceSet
::buildPriceSet($this);
489 $optionsMembershipTypes = array();
490 foreach ($this->_priceSet
['fields'] as $pField) {
491 if (empty($pField['options'])) {
494 foreach ($pField['options'] as $opId => $opValues) {
495 $optionsMembershipTypes[$opId] = CRM_Utils_Array
::value('membership_type_id', $opValues, 0);
499 $this->assign('autoRenewOption', CRM_Price_BAO_PriceSet
::checkAutoRenewForPriceSet($this->_priceSetId
));
501 $this->assign('optionsMembershipTypes', $optionsMembershipTypes);
502 $this->assign('contributionType', CRM_Utils_Array
::value('financial_type_id', $this->_priceSet
));
504 // get only price set form elements.
505 if ($getOnlyPriceSetElements) {
510 // use to build form during form rule.
511 $this->assign('buildPriceSet', $buildPriceSet);
513 if ($this->_action
& CRM_Core_Action
::ADD
) {
514 $buildPriceSet = FALSE;
515 $priceSets = CRM_Price_BAO_PriceSet
::getAssoc(FALSE, 'CiviMember');
516 if (!empty($priceSets)) {
517 $buildPriceSet = TRUE;
520 if ($buildPriceSet) {
521 $this->add('select', 'price_set_id', ts('Choose price set'),
523 '' => ts('Choose price set')
525 NULL, array('onchange' => "buildAmount( this.value );")
528 $this->assign('hasPriceSets', $buildPriceSet);
531 //need to assign custom data type and subtype to the template
532 $this->assign('customDataType', 'Membership');
533 $this->assign('customDataSubType', $this->_memType
);
534 $this->assign('entityID', $this->_id
);
536 if ($this->_action
& CRM_Core_Action
::DELETE
) {
537 $this->addButtons(array(
540 'name' => ts('Delete'),
541 'spacing' => ' ',
546 'name' => ts('Cancel'),
553 if ($this->_context
== 'standalone') {
554 $this->addEntityRef('contact_id', ts('Contact'), array('create' => TRUE), TRUE);
557 $selOrgMemType[0][0] = $selMemTypeOrg[0] = ts('- select -');
559 $dao = new CRM_Member_DAO_MembershipType();
560 $dao->domain_id
= CRM_Core_Config
::domainID();
563 // retrieve all memberships
564 $allMemberships = CRM_Member_BAO_Membership
::buildMembershipTypeValues($this);
566 $allMembershipInfo = $membershipType = array();
567 foreach ($allMemberships as $key => $values) {
568 if (!empty($values['is_active'])) {
569 $membershipType[$key] = CRM_Utils_Array
::value('name', $values);
570 if ($this->_mode
&& empty($values['minimum_fee'])) {
574 $memberOfContactId = CRM_Utils_Array
::value('member_of_contact_id', $values);
575 if (empty($selMemTypeOrg[$memberOfContactId])) {
576 $selMemTypeOrg[$memberOfContactId] = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact',
582 $selOrgMemType[$memberOfContactId][0] = ts('- select -');
584 if (empty($selOrgMemType[$memberOfContactId][$key])) {
585 $selOrgMemType[$memberOfContactId][$key] = CRM_Utils_Array
::value('name', $values);
589 // build membership info array, which is used when membership type is selected to:
590 // - set the payment information block
591 // - set the max related block
592 $allMembershipInfo[$key] = array(
593 'financial_type_id' => CRM_Utils_Array
::value('financial_type_id', $values),
594 'total_amount' => CRM_Utils_Money
::format($values['minimum_fee'], NULL, '%a'),
595 'total_amount_numeric' => CRM_Utils_Array
::value('minimum_fee', $values),
596 'auto_renew' => CRM_Utils_Array
::value('auto_renew', $values),
597 'has_related' => isset($values['relationship_type_id']),
598 'max_related' => CRM_Utils_Array
::value('max_related', $values),
603 $this->assign('allMembershipInfo', json_encode($allMembershipInfo));
605 // show organization by default, if only one organization in
607 if (count($selMemTypeOrg) == 2) {
608 unset($selMemTypeOrg[0], $selOrgMemType[0][0]);
610 //sort membership organization and type, CRM-6099
611 natcasesort($selMemTypeOrg);
612 foreach ($selOrgMemType as $index => $orgMembershipType) {
613 natcasesort($orgMembershipType);
614 $selOrgMemType[$index] = $orgMembershipType;
617 $memTypeJs = array('onChange' => "CRM.buildCustomData( 'Membership', this.value );");
619 //build the form for auto renew.
620 $recurProcessor = $autoRenew = array();
621 if ($this->_mode ||
($this->_action
& CRM_Core_Action
::UPDATE
)) {
622 $autoRenewElement = $this->addElement('checkbox',
624 ts('Membership renewed automatically'),
626 array('onclick' => "buildReceiptANDNotice( );")
630 //get the valid recurring processors.
631 $recurring = CRM_Core_PseudoConstant
::paymentProcessor(FALSE, FALSE, 'is_recur = 1');
632 $recurProcessor = array_intersect_assoc($this->_processors
, $recurring);
633 $autoRenew = array();
634 if (!empty($recurProcessor)) {
635 if (!empty($membershipType)) {
641 FROM civicrm_membership_type
642 WHERE id IN ( ' . implode(' , ', array_keys($membershipType)) . ' )';
643 $recurMembershipTypes = CRM_Core_DAO
::executeQuery($sql);
644 while ($recurMembershipTypes->fetch()) {
645 $autoRenew[$recurMembershipTypes->id
] = $recurMembershipTypes->auto_renew
;
652 $this->_recurMembershipTypes
[$recurMembershipTypes->id
][$fld] = $recurMembershipTypes->$fld;
658 "CRM.buildCustomData( 'Membership', this.value ); buildAutoRenew(this.value, null );",
663 $allowAutoRenew = FALSE;
664 if ($this->_mode
&& !empty($recurProcessor)) {
665 $allowAutoRenew = TRUE;
667 $this->assign('allowAutoRenew', $allowAutoRenew);
668 $this->assign('autoRenewOptions', json_encode($autoRenew));
669 $this->assign('recurProcessor', json_encode($recurProcessor));
671 // for max_related: a little JS to show/hide & set default value
672 $memTypeJs['onChange'] = "buildMaxRelated(this.value,true); " . $memTypeJs['onChange'];
673 $this->add('text', 'max_related', ts('Max related'),
674 CRM_Core_DAO
::getAttribute('CRM_Member_DAO_Membership', 'max_related')
677 $sel = & $this->addElement('hierselect',
678 'membership_type_id',
679 ts('Membership Organization and Type'),
683 $sel->setOptions(array($selMemTypeOrg, $selOrgMemType));
689 $this->applyFilter('__ALL__', 'trim');
691 if ($this->_action
& CRM_Core_Action
::ADD
) {
692 $this->add('text', 'num_terms', ts('Number of Terms'), array('size' => 6));
695 $this->addDate('join_date', ts('Member Since'), FALSE, array('formatType' => 'activityDate'));
696 $this->addDate('start_date', ts('Start Date'), FALSE, array('formatType' => 'activityDate'));
697 $endDate = $this->addDate('end_date', ts('End Date'), FALSE, array('formatType' => 'activityDate'));
699 $elements[] = $endDate;
702 $this->add('text', 'source', ts('Source'),
703 CRM_Core_DAO
::getAttribute('CRM_Member_DAO_Membership', 'source')
706 //CRM-7362 --add campaigns.
709 $campaignId = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership', $this->_id
, 'campaign_id');
711 CRM_Campaign_BAO_Campaign
::addCampaign($this, $campaignId);
714 $this->add('select', 'status_id', ts('Membership Status'),
715 array('' => ts('- select -')) + CRM_Member_PseudoConstant
::membershipStatus(NULL, NULL, 'label')
717 $statusOverride = $this->addElement('checkbox', 'is_override',
718 ts('Status Override?'), NULL,
719 array('onClick' => 'showHideMemberStatus()')
721 if ($statusOverride) {
722 $elements[] = $statusOverride;
725 $this->addElement('checkbox', 'record_contribution', ts('Record Membership Payment?'));
727 $this->add('text', 'total_amount', ts('Amount'));
728 $this->addRule('total_amount', ts('Please enter a valid amount.'), 'money');
730 $this->addDate('receive_date', ts('Received'), FALSE, array('formatType' => 'activityDateTime'));
732 $this->add('select', 'payment_instrument_id',
734 array('' => ts('- select -')) + CRM_Contribute_PseudoConstant
::paymentInstrument(),
735 FALSE, array('onChange' => "return showHideByValue('payment_instrument_id','4','checkNumber','table-row','select',false);")
737 $this->add('text', 'trxn_id', ts('Transaction ID'));
738 $this->addRule('trxn_id', ts('Transaction ID already exists in Database.'),
739 'objectExists', array('CRM_Contribute_DAO_Contribution', $this->_id
, 'trxn_id')
742 $allowStatuses = array();
743 $statuses = CRM_Contribute_PseudoConstant
::contributionStatus();
744 if ($this->_onlinePendingContributionId
) {
745 $statusNames = CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name');
746 foreach ($statusNames as $val => $name) {
747 if (in_array($name, array(
754 $allowStatuses[$val] = $statuses[$val];
758 $allowStatuses = $statuses;
760 $this->add('select', 'contribution_status_id',
761 ts('Payment Status'), $allowStatuses
763 $this->add('text', 'check_number', ts('Check Number'),
764 CRM_Core_DAO
::getAttribute('CRM_Contribute_DAO_Contribution', 'check_number')
768 //add field for amount to allow an amount to be entered that differs from minimum
769 $this->add('text', 'total_amount', ts('Amount'));
771 $this->add('select', 'financial_type_id',
772 ts('Financial Type'),
773 array('' => ts('- select -')) + CRM_Contribute_PseudoConstant
::financialType()
776 //CRM-10223 - allow contribution to be recorded against different contact
777 // causes a conflict in standalone mode so skip in standalone for now
778 $this->addElement('checkbox', 'is_different_contribution_contact', ts('Record Payment from a Different Contact?'));
779 $this->addSelect('soft_credit_type_id', array('entity' => 'contribution_soft'));
780 $this->addEntityRef('soft_credit_contact_id', ts('Payment From'), array('create' => TRUE));
783 $this->addElement('checkbox',
785 ts('Send Confirmation and Receipt?'), NULL,
786 array('onclick' => "showHideByValue( 'send_receipt', '', 'notice', 'table-row', 'radio', false); showHideByValue( 'send_receipt', '', 'fromEmail', 'table-row', 'radio', false);")
789 $this->add('select', 'from_email_address', ts('Receipt From'), $this->_fromEmails
);
791 $this->add('textarea', 'receipt_text_signup', ts('Receipt Message'));
794 $this->add('select', 'payment_processor_id',
795 ts('Payment Processor'),
796 $this->_processors
, TRUE,
797 array('onChange' => "buildAutoRenew( null, this.value );")
799 CRM_Core_Payment_Form
::buildCreditCard($this, TRUE);
802 // Retrieve the name and email of the contact - this will be the TO for receipt email
803 if ($this->_contactID
) {
804 list($this->_memberDisplayName
,
806 ) = CRM_Contact_BAO_Contact_Location
::getEmailDetails($this->_contactID
);
808 $this->assign('emailExists', $this->_memberEmail
);
809 $this->assign('displayName', $this->_memberDisplayName
);
813 if ($this->_action
& CRM_Core_Action
::UPDATE
) {
814 $recurContributionId = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership', $this->_id
,
815 'contribution_recur_id'
817 if ($recurContributionId && !CRM_Member_BAO_Membership
::isSubscriptionCancelled($this->_id
)) {
819 if (CRM_Member_BAO_Membership
::isCancelSubscriptionSupported($this->_id
)) {
820 $this->assign('cancelAutoRenew',
821 CRM_Utils_System
::url('civicrm/contribute/unsubscribe', "reset=1&mid={$this->_id}")
824 foreach ($elements as $elem) {
829 $this->assign('isRecur', $isRecur);
831 $this->addFormRule(array('CRM_Member_Form_Membership', 'formRule'), $this);
833 $mailingInfo = CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::MAILING_PREFERENCES_NAME
,
836 $this->assign('outBound_option', $mailingInfo['outBound_option']);
838 parent
::buildQuickForm();
842 * Function for validation
844 * @param array $params (ref.) an assoc array of name/value pairs
849 * @throws CiviCRM_API3_Exception
850 * @return mixed true or array of errors
854 static function formRule($params, $files, $self) {
857 $priceSetId = CRM_Utils_Array
::value('price_set_id', $params);
860 CRM_Price_BAO_PriceField
::priceSetValidation($priceSetId, $params, $errors);
862 $priceFieldIDS = array();
863 foreach ($self->_priceSet
['fields'] as $priceIds => $dontCare) {
865 if (!empty($params['price_' . $priceIds])) {
866 if (is_array($params['price_' . $priceIds])) {
867 foreach ($params['price_' . $priceIds] as $priceFldVal => $isSet) {
869 $priceFieldIDS[] = $priceFldVal;
874 $priceFieldIDS[] = $params['price_' . $priceIds];
879 if (!empty($priceFieldIDS)) {
880 $ids = implode(',', $priceFieldIDS);
882 $count = CRM_Price_BAO_PriceSet
::getMembershipCount($ids);
883 foreach ($count as $id => $occurance) {
884 if ($occurance > 1) {
885 $errors['_qf_default'] = ts('Select at most one option associated with the same membership type.');
889 foreach ($priceFieldIDS as $priceFieldId) {
890 if ($id = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceFieldValue', $priceFieldId, 'membership_type_id')) {
891 $self->_memTypeSelected
[$id] = $id;
896 elseif (empty($params['membership_type_id'][1])) {
897 $errors['membership_type_id'] = ts('Please select a membership type.');
900 $self->_memTypeSelected
[] = $params['membership_type_id'][1];
904 $numterms = CRM_Utils_Array
::value('num_terms', $params);
905 if ($numterms && intval($numterms) != $numterms) {
906 $errors['num_terms'] = ts('Please enter an integer for the number of terms.');
910 // Return error if empty $self->_memTypeSelected
911 if ($priceSetId && empty($errors) && empty($self->_memTypeSelected
)) {
912 $errors['_qf_default'] = ts('Select at least one membership option.');
915 if (!empty($errors) && (count($self->_memTypeSelected
) > 1)) {
916 $memberOfContacts = CRM_Member_BAO_MembershipType
::getMemberOfContactByMemTypes($self->_memTypeSelected
);
917 $duplicateMemberOfContacts = array_count_values($memberOfContacts);
918 foreach ($duplicateMemberOfContacts as $countDuplicate) {
919 if ($countDuplicate > 1) {
920 $errors['_qf_default'] = ts('Please do not select more than one membership associated with the same organization.');
925 if (!empty($errors)) {
929 if ($priceSetId && !$self->_mode
&& empty($params['record_contribution'])) {
930 $errors['record_contribution'] = ts('Record Membership Payment is required when you using price set.');
933 if (!$priceSetId && $self->_mode
&& empty($params['financial_type_id'])) {
934 $errors['financial_type_id'] = ts('Please enter the financial Type.');
937 if (!empty($params['record_contribution']) && empty($params['payment_instrument_id'])) {
938 $errors['payment_instrument_id'] = ts('Paid By is a required field.');
941 if (!empty($params['is_different_contribution_contact'])) {
942 if (empty($params['soft_credit_type_id'])) {
943 $errors['soft_credit_type_id'] = ts('Please Select a Soft Credit Type');
945 if (empty($params['soft_credit_contact_id'])) {
946 $errors['soft_credit_contact_id'] = ts('Please select a contact');
950 if (!empty($params['payment_processor_id'])) {
951 // make sure that credit card number and cvv are valid
952 CRM_Core_Payment_Form
::validateCreditCard($params, $errors);
956 if (!empty($params['join_date'])) {
958 $joinDate = CRM_Utils_Date
::processDate($params['join_date']);
960 foreach ($self->_memTypeSelected
as $memType) {
962 if (!empty($params['start_date'])) {
963 $startDate = CRM_Utils_Date
::processDate($params['start_date']);
966 // if end date is set, ensure that start date is also set
967 // and that end date is later than start date
969 if (!empty($params['end_date'])) {
970 $endDate = CRM_Utils_Date
::processDate($params['end_date']);
973 $membershipDetails = CRM_Member_BAO_MembershipType
::getMembershipTypeDetails($memType);
975 if ($startDate && CRM_Utils_Array
::value('period_type', $membershipDetails) == 'rolling') {
976 if ($startDate < $joinDate) {
977 $errors['start_date'] = ts('Start date must be the same or later than Member since.');
982 if ($membershipDetails['duration_unit'] == 'lifetime') {
983 // Check if status is NOT cancelled or similar. For lifetime memberships, there is no automated
984 // process to update status based on end-date. The user must change the status now.
985 $result = civicrm_api3('MembershipStatus', 'get', array(
987 'is_current_member' => 0,
989 $tmp_statuses = $result['values'];
990 $status_ids = array();
991 foreach($tmp_statuses as $cur_stat) {
992 $status_ids[] = $cur_stat['id'];
994 if (empty($params['status_id']) ||
in_array( $params['status_id'] , $status_ids) == false) {
995 $errors['status_id'] = ts('Please enter a status that does NOT represent a current membership status.');
996 $errors['is_override'] = ts('This must be checked because you set an End Date for a lifetime membership');
1001 $errors['start_date'] = ts('Start date must be set if end date is set.');
1003 if ($endDate < $startDate) {
1004 $errors['end_date'] = ts('End date must be the same or later than start date.');
1009 // Default values for start and end dates if not supplied
1011 $defaultDates = CRM_Member_BAO_MembershipType
::getDatesForMembershipType($memType,
1018 $startDate = CRM_Utils_Array
::value('start_date',
1023 $endDate = CRM_Utils_Array
::value('end_date',
1028 //CRM-3724, check for availability of valid membership status.
1029 if (empty($params['is_override']) && !isset($errors['_qf_default'])) {
1030 $calcStatus = CRM_Member_BAO_MembershipStatus
::getMembershipStatusByDate($startDate,
1038 if (empty($calcStatus)) {
1039 $url = CRM_Utils_System
::url('civicrm/admin/member/membershipStatus', 'reset=1&action=browse');
1040 $errors['_qf_default'] = ts('There is no valid Membership Status available for selected membership dates.');
1041 $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));
1042 if (!$self->_mode
) {
1043 $status .= ' ' . ts('OR You can sign up by setting Status Override? to true.');
1045 CRM_Core_Session
::setStatus($status, ts('Membership Status Error'), 'error');
1051 $errors['join_date'] = ts('Please enter the Member Since.');
1054 if (isset($params['is_override']) &&
1055 $params['is_override'] && empty($params['status_id'])) {
1056 $errors['status_id'] = ts('Please enter the status.');
1059 //total amount condition arise when membership type having no
1061 if (isset($params['record_contribution'])) {
1062 if (!$params['financial_type_id']) {
1063 $errors['financial_type_id'] = ts('Please enter the financial Type.');
1065 if (CRM_Utils_System
::isNull($params['total_amount'])) {
1066 $errors['total_amount'] = ts('Please enter the contribution.');
1070 // validate contribution status for 'Failed'.
1071 if ($self->_onlinePendingContributionId
&& !empty($params['record_contribution']) &&
1072 (CRM_Utils_Array
::value('contribution_status_id', $params) ==
1073 array_search('Failed', CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name'))
1076 $errors['contribution_status_id'] = ts('Please select a valid payment status before updating.');
1079 return empty($errors) ?
TRUE : $errors;
1083 * Function to process the form
1089 public function postProcess() {
1090 if ($this->_action
& CRM_Core_Action
::DELETE
) {
1091 CRM_Member_BAO_Membership
::del($this->_id
);
1095 $config = CRM_Core_Config
::singleton();
1096 // get the submitted form values.
1097 $this->_params
= $formValues = $this->controller
->exportValues($this->_name
);
1098 $this->convertDateFieldsToMySQL($formValues);
1100 $params = $softParams = $ids = array();
1102 $membershipTypeValues = array();
1103 foreach ($this->_memTypeSelected
as $memType) {
1104 $membershipTypeValues[$memType]['membership_type_id'] = $memType;
1107 //take the required membership recur values.
1108 if ($this->_mode
&& !empty($this->_params
['auto_renew'])) {
1109 $params['is_recur'] = $this->_params
['is_recur'] = $formValues['is_recur'] = TRUE;
1111 'frequency_interval' => 'duration_interval',
1112 'frequency_unit' => 'duration_unit',
1116 foreach ($this->_memTypeSelected
as $memType) {
1117 $recurMembershipTypeValues = CRM_Utils_Array
::value($memType,
1118 $this->_recurMembershipTypes
, array()
1120 foreach ($mapping as $mapVal => $mapParam) {
1121 $membershipTypeValues[$memType][$mapVal] = CRM_Utils_Array
::value($mapParam,
1122 $recurMembershipTypeValues
1125 $this->_params
[$mapVal] = $formValues[$mapVal] = CRM_Utils_Array
::value($mapParam,
1126 $recurMembershipTypeValues
1133 // unset send-receipt option, since receipt will be sent when ipn is received.
1134 unset($this->_params
['send_receipt'], $formValues['send_receipt']);
1137 // process price set and get total amount and line items.
1138 $lineItem = array();
1140 if (!$priceSetId = CRM_Utils_Array
::value('price_set_id', $formValues)) {
1141 CRM_Member_BAO_Membership
::createLineItems($this, $formValues['membership_type_id'], $priceSetId);
1144 if ($this->_priceSetId
&& CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet', $this->_priceSetId
, 'is_quick_config')) {
1148 $termsByType = array();
1150 CRM_Price_BAO_PriceSet
::processAmount($this->_priceSet
['fields'],
1151 $this->_params
, $lineItem[$priceSetId]);
1152 if (CRM_Utils_Array
::value('tax_amount', $this->_params
)) {
1153 $params['tax_amount'] = $this->_params
['tax_amount'];
1155 $params['total_amount'] = CRM_Utils_Array
::value('amount', $this->_params
);
1156 $submittedFinancialType = CRM_Utils_Array
::value('financial_type_id', $formValues);
1157 if (!empty($lineItem[$priceSetId])) {
1158 foreach ($lineItem[$priceSetId] as &$li) {
1159 if (!empty($li['membership_type_id'])) {
1160 if (!empty($li['membership_num_terms'])) {
1161 $termsByType[$li['membership_type_id']] = $li['membership_num_terms'];
1165 ///CRM-11529 for quick config backoffice transactions
1166 //when financial_type_id is passed in form, update the
1167 //lineitems with the financial type selected in form
1168 if ($isQuickConfig && $submittedFinancialType) {
1169 $li['financial_type_id'] = $submittedFinancialType;
1175 $this->storeContactFields($formValues);
1177 $params['contact_id'] = $this->_contactID
;
1186 foreach ($fields as $f) {
1187 $params[$f] = CRM_Utils_Array
::value($f, $formValues);
1191 // when is_override false ignore is_admin statuses during membership
1192 // status calculation. similarly we did fix for import in CRM-3570.
1193 if (empty($params['is_override'])) {
1194 $params['exclude_is_admin'] = TRUE;
1197 // process date params to mysql date format.
1199 'join_date' => 'joinDate',
1200 'start_date' => 'startDate',
1201 'end_date' => 'endDate',
1203 foreach ($dateTypes as $dateField => $dateVariable) {
1204 $
$dateVariable = CRM_Utils_Date
::processDate($formValues[$dateField]);
1207 $memTypeNumTerms = CRM_Utils_Array
::value('num_terms', $formValues);
1209 $calcDates = array();
1210 foreach ($this->_memTypeSelected
as $memType) {
1211 if (empty($memTypeNumTerms)) {
1212 $memTypeNumTerms = CRM_Utils_Array
::value($memType, $termsByType, 1);
1214 $calcDates[$memType] = CRM_Member_BAO_MembershipType
::getDatesForMembershipType($memType,
1215 $joinDate, $startDate, $endDate, $memTypeNumTerms
1219 foreach ($calcDates as $memType => $calcDate) {
1220 foreach (array_keys($dateTypes) as $d) {
1221 //first give priority to form values then calDates.
1222 $date = CRM_Utils_Array
::value($d, $formValues);
1224 $date = CRM_Utils_Array
::value($d, $calcDate);
1227 $membershipTypeValues[$memType][$d] = CRM_Utils_Date
::processDate($date);
1228 //$params[$d] = CRM_Utils_Date::processDate( $date );
1232 // max related memberships - take from form or inherit from membership type
1233 foreach ($this->_memTypeSelected
as $memType) {
1234 if (array_key_exists('max_related', $formValues)) {
1235 $membershipTypeValues[$memType]['max_related'] = CRM_Utils_Array
::value('max_related', $formValues);
1240 $ids['membership'] = $params['id'] = $this->_id
;
1243 $session = CRM_Core_Session
::singleton();
1244 $ids['userId'] = $session->get('userID');
1246 // membership type custom data
1247 foreach ($this->_memTypeSelected
as $memType) {
1248 $customFields = CRM_Core_BAO_CustomField
::getFields('Membership', FALSE, FALSE,
1252 $customFields = CRM_Utils_Array
::crmArrayMerge($customFields,
1253 CRM_Core_BAO_CustomField
::getFields('Membership',
1259 $membershipTypeValues[$memType]['custom'] = CRM_Core_BAO_CustomField
::postProcess($formValues,
1266 foreach ($this->_memTypeSelected
as $memType) {
1267 $membershipTypes[$memType] = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType',
1272 $membershipType = implode(', ', $membershipTypes);
1274 // Retrieve the name and email of the current user - this will be the FROM for the receipt email
1275 list($userName, $userEmail) = CRM_Contact_BAO_Contact_Location
::getEmailDetails($ids['userId']);
1277 //CRM-13981, allow different person as a soft-contributor of chosen type
1278 if ($this->_contributorContactID
!= $this->_contactID
) {
1279 $params['contribution_contact_id'] = $this->_contributorContactID
;
1280 if (!empty($this->_params
['soft_credit_type_id'])) {
1281 $softParams['soft_credit_type_id'] = $this->_params
['soft_credit_type_id'];
1282 $softParams['contact_id'] = $this->_contactID
;
1285 if (!empty($formValues['record_contribution'])) {
1286 $recordContribution = array(
1288 'financial_type_id',
1289 'payment_instrument_id',
1291 'contribution_status_id',
1297 foreach ($recordContribution as $f) {
1298 $params[$f] = CRM_Utils_Array
::value($f, $formValues);
1301 if (!$this->_onlinePendingContributionId
) {
1302 $params['contribution_source'] = ts('%1 Membership: Offline signup (by %2)',
1303 array(1 => $membershipType, 2 => $userName)
1307 if (empty($params['is_override']) &&
1308 CRM_Utils_Array
::value('contribution_status_id', $params) == array_search('Pending', CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name'))
1310 $allStatus = CRM_Member_PseudoConstant
::membershipStatus();
1311 $params['status_id'] = array_search('Pending', $allStatus);
1312 $params['skipStatusCal'] = TRUE;
1313 $params['is_pay_later'] = 1;
1314 $this->assign('is_pay_later', 1);
1317 if (!empty($formValues['send_receipt'])) {
1318 $params['receipt_date'] = CRM_Utils_Array
::value('receive_date', $formValues);
1321 //insert financial type name in receipt.
1322 $formValues['contributionType_name'] = CRM_Core_DAO
::getFieldValue('CRM_Financial_DAO_FinancialType',
1323 $formValues['financial_type_id']
1327 // process line items, until no previous line items.
1328 if (!empty($lineItem)) {
1329 $params['lineItems'] = $lineItem;
1330 $params['processPriceSet'] = TRUE;
1332 $createdMemberships = array();
1334 if (empty($formValues['total_amount']) && !$priceSetId) {
1335 // if total amount not provided minimum for membership type is used
1336 $params['total_amount'] = $formValues['total_amount'] = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType',
1337 $formValues['membership_type_id'][1], 'minimum_fee'
1341 $params['total_amount'] = CRM_Utils_Array
::value('total_amount', $formValues, 0);
1344 if ($priceSetId && !$isQuickConfig) {
1345 $params['financial_type_id'] = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet',
1351 $params['financial_type_id'] = CRM_Utils_Array
::value('financial_type_id', $formValues);
1354 $this->_paymentProcessor
= CRM_Financial_BAO_PaymentProcessor
::getPayment($formValues['payment_processor_id'],
1358 //get the payment processor id as per mode.
1359 $params['payment_processor_id'] = $this->_params
['payment_processor_id'] = $formValues['payment_processor_id'] = $this->_paymentProcessor
['id'];
1362 $now = date('YmdHis');
1365 // set email for primary location.
1366 $fields['email-Primary'] = 1;
1367 $formValues['email-5'] = $formValues['email-Primary'] = $this->_memberEmail
;
1368 $params['register_date'] = $now;
1370 // now set the values for the billing location.
1371 foreach ($this->_fields
as $name => $dontCare) {
1375 // also add location name to the array
1376 $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);
1378 $formValues["address_name-{$this->_bltID}"] = trim($formValues["address_name-{$this->_bltID}"]);
1380 $fields["address_name-{$this->_bltID}"] = 1;
1381 //ensure we don't over-write the payer's email with the member's email
1382 if ($this->_contributorContactID
== $this->_contactID
) {
1383 $fields["email-{$this->_bltID}"] = 1;
1386 $ctype = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $this->_contactID
, 'contact_type');
1388 $nameFields = array('first_name', 'middle_name', 'last_name');
1390 foreach ($nameFields as $name) {
1392 if (array_key_exists("billing_$name", $formValues)) {
1393 $formValues[$name] = $formValues["billing_{$name}"];
1394 $formValues['preserveDBName'] = TRUE;
1397 if ($this->_contributorContactID
== $this->_contactID
) {
1398 //see CRM-12869 for discussion of why we don't do this for separate payee payments
1399 CRM_Contact_BAO_Contact
::createProfileContact($formValues, $fields,
1400 $this->_contributorContactID
, NULL, NULL, $ctype
1404 // add all the additioanl payment params we need
1405 $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}"]);
1406 $this->_params
["country-{$this->_bltID}"] = $this->_params
["billing_country-{$this->_bltID}"] = CRM_Core_PseudoConstant
::countryIsoCode($this->_params
["billing_country_id-{$this->_bltID}"]);
1408 $this->_params
['year'] = CRM_Core_Payment_Form
::getCreditCardExpirationYear($this->_params
);
1409 $this->_params
['month'] = CRM_Core_Payment_Form
::getCreditCardExpirationMonth($this->_params
);
1410 $this->_params
['ip_address'] = CRM_Utils_System
::ipAddress();
1411 $this->_params
['amount'] = $params['total_amount'];
1412 $this->_params
['currencyID'] = $config->defaultCurrency
;
1413 $this->_params
['payment_action'] = 'Sale';
1414 $this->_params
['invoiceID'] = md5(uniqid(rand(), TRUE));
1415 $this->_params
['financial_type_id'] = $params['financial_type_id'];
1417 // at this point we've created a contact and stored its address etc
1418 // all the payment processors expect the name and address to be in the
1419 // so we copy stuff over to first_name etc.
1420 $paymentParams = $this->_params
;
1421 $paymentParams['contactID'] = $this->_contributorContactID
;
1422 //CRM-10377 if payment is by an alternate contact then we need to set that person
1423 // as the contact in the payment params
1424 if ($this->_contributorContactID
!= $this->_contactID
) {
1425 if (!empty($this->_params
['soft_credit_type_id'])) {
1426 $softParams['contact_id'] = $params['contact_id'];
1427 $softParams['soft_credit_type_id'] = $this->_params
['soft_credit_type_id'];
1430 if (!empty($this->_params
['send_receipt'])) {
1431 $paymentParams['email'] = $this->_contributorEmail
;
1434 CRM_Core_Payment_Form
::mapParams($this->_bltID
, $this->_params
, $paymentParams, TRUE);
1436 // CRM-7137 -for recurring membership,
1437 // we do need contribution and recuring records.
1439 if (!empty($paymentParams['is_recur'])) {
1440 $allStatus = CRM_Member_PseudoConstant
::membershipStatus();
1442 $contributionType = new CRM_Financial_DAO_FinancialType();
1443 $contributionType->id
= $params['financial_type_id'];
1444 if (!$contributionType->find(TRUE)) {
1445 CRM_Core_Error
::fatal('Could not find a system table');
1448 $contribution = CRM_Contribute_Form_Contribution_Confirm
::processContribution($this,
1451 $this->_contributorContactID
,
1458 //create new soft-credit record, CRM-13981
1459 $softParams['contribution_id'] = $contribution->id
;
1460 $softParams['currency'] = $contribution->currency
;
1461 $softParams['amount'] = $contribution->total_amount
;
1462 CRM_Contribute_BAO_ContributionSoft
::add($softParams);
1464 $paymentParams['contactID'] = $contactID;
1465 $paymentParams['contributionID'] = $contribution->id
;
1466 $paymentParams['contributionTypeID'] = $contribution->financial_type_id
;
1467 $paymentParams['contributionPageID'] = $contribution->contribution_page_id
;
1468 $paymentParams['contributionRecurID'] = $contribution->contribution_recur_id
;
1469 $ids['contribution'] = $contribution->id
;
1470 $params['contribution_recur_id'] = $paymentParams['contributionRecurID'];
1471 $params['status_id'] = array_search('Pending', $allStatus);
1472 $params['skipStatusCal'] = TRUE;
1474 //as membership is pending set dates to null.
1475 $memberDates = array(
1476 'join_date' => 'joinDate',
1477 'start_date' => 'startDate',
1478 'end_date' => 'endDate',
1481 foreach ($memberDates as $dp => $dv) {
1483 foreach ($this->_memTypeSelected
as $memType) {
1484 $membershipTypeValues[$memType][$dv] = NULL;
1489 if ($params['total_amount'] > 0.0) {
1490 $payment = CRM_Core_Payment
::singleton($this->_mode
, $this->_paymentProcessor
, $this);
1491 $result = & $payment->doDirectPayment($paymentParams);
1494 if (is_a($result, 'CRM_Core_Error')) {
1495 //make sure to cleanup db for recurring case.
1496 if (!empty($paymentParams['contributionID'])) {
1497 CRM_Contribute_BAO_Contribution
::deleteContribution($paymentParams['contributionID']);
1499 if (!empty($paymentParams['contributionRecurID'])) {
1500 CRM_Contribute_BAO_ContributionRecur
::deleteRecurContribution($paymentParams['contributionRecurID']);
1503 CRM_Core_Error
::displaySessionError($result);
1504 CRM_Utils_System
::redirect(CRM_Utils_System
::url('civicrm/contact/view/membership',
1505 "reset=1&action=add&cid={$this->_contactID}&context=&mode={$this->_mode}"
1510 $this->_params
= array_merge($this->_params
, $result);
1511 //assign amount to template if payment was successful
1512 $this->assign('amount', $params['total_amount']);
1515 $params['contribution_status_id'] = !empty($paymentParams['is_recur']) ?
2 : 1;
1516 $params['receive_date'] = $now;
1517 $params['invoice_id'] = $this->_params
['invoiceID'];
1518 $params['contribution_source'] = ts('%1 Membership Signup: Credit card or direct debit (by %2)',
1519 array(1 => $membershipType, 2 => $userName)
1521 $params['source'] = $formValues['source'] ?
$formValues['source'] : $params['contribution_source'];
1522 $params['trxn_id'] = CRM_Utils_Array
::value('trxn_id', $result);
1523 $params['payment_instrument_id'] = 1;
1524 $params['is_test'] = ($this->_mode
== 'live') ?
0 : 1;
1525 if (!empty($this->_params
['send_receipt'])) {
1526 $params['receipt_date'] = $now;
1529 $params['receipt_date'] = NULL;
1532 $this->set('params', $this->_params
);
1533 $this->assign('trxn_id', CRM_Utils_Array
::value('trxn_id', $result));
1534 $this->assign('receive_date',
1535 CRM_Utils_Date
::mysqlToIso($params['receive_date'])
1538 // required for creating membership for related contacts
1539 $params['action'] = $this->_action
;
1541 //create membership record.
1543 foreach ($this->_memTypeSelected
as $memType) {
1545 ($relateContribution = CRM_Member_BAO_Membership
::getMembershipContributionId($membership->id
))
1547 $membershipTypeValues[$memType]['relate_contribution_id'] = $relateContribution;
1550 $membershipParams = array_merge($membershipTypeValues[$memType], $params);
1551 $membership = CRM_Member_BAO_Membership
::create($membershipParams, $ids);
1553 $this->_membershipIDs
[] = $membership->id
;
1554 $createdMemberships[$memType] = $membership;
1560 $params['action'] = $this->_action
;
1561 if ($this->_onlinePendingContributionId
&& !empty($formValues['record_contribution'])) {
1563 // update membership as well as contribution object, CRM-4395
1564 $params['contribution_id'] = $this->_onlinePendingContributionId
;
1565 $params['componentId'] = $params['id'];
1566 $params['componentName'] = 'contribute';
1567 $result = CRM_Contribute_BAO_Contribution
::transitionComponents($params, TRUE);
1568 if (!empty($result) && !empty($params['contribution_id'])) {
1569 $lineItem = array();
1570 $lineItems = CRM_Price_BAO_LineItem
::getLineItems($params['contribution_id'], 'contribution');
1571 $itemId = key($lineItems);
1572 $priceSetId = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceField', $lineItems[$itemId]['price_field_id'], 'price_set_id');
1574 if ($itemId && !empty($lineItems[$itemId]['price_field_id'])) {
1575 $fieldType = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceField', $lineItems[$itemId]['price_field_id'], 'html_type');
1577 $lineItems[$itemId]['unit_price'] = $params['total_amount'];
1578 $lineItems[$itemId]['line_total'] = $params['total_amount'];
1579 $lineItems[$itemId]['id'] = $itemId;
1580 $lineItem[$priceSetId] = $lineItems;
1581 CRM_Price_BAO_LineItem
::processPriceSet($params['contribution_id'], $lineItem);
1583 //create new soft-credit record, CRM-13981
1584 $softParams['contribution_id'] = $params['contribution_id'];
1585 $dao = new CRM_Contribute_DAO_Contribution();
1586 $dao->id
= $params['contribution_id'];
1588 while ($dao->fetch()) {
1589 $softParams['currency'] = $dao->currency
;
1590 $softParams['amount'] = $dao->total_amount
;
1592 CRM_Contribute_BAO_ContributionSoft
::add($softParams);
1595 //carry updated membership object.
1596 $membership = new CRM_Member_DAO_Membership();
1597 $membership->id
= $this->_id
;
1598 $membership->find(TRUE);
1601 if ($membership->end_date
) {
1602 //display end date w/ status message.
1603 $endDate = $membership->end_date
;
1605 $membershipStatues = CRM_Member_PseudoConstant
::membershipStatus();
1606 if (!in_array($membership->status_id
, array(
1607 array_search('Cancelled', $membershipStatues),
1608 array_search('Expired', $membershipStatues),
1614 // suppress form values in template.
1615 $this->assign('cancelled', $cancelled);
1617 // FIX ME: need to recheck this
1618 // here we might updated dates, so get from object.
1619 foreach ($calcDates[$membership->membership_type_id
] as $date => & $val) {
1620 if ($membership->$date) {
1621 $val = $membership->$date;
1625 $createdMemberships[] = $membership;
1629 foreach ($this->_memTypeSelected
as $memType) {
1630 if ($count && !empty($formValues['record_contribution']) &&
1631 ($relateContribution = CRM_Member_BAO_Membership
::getMembershipContributionId($membership->id
))
1633 $membershipTypeValues[$memType]['relate_contribution_id'] = $relateContribution;
1636 $membershipParams = array_merge($params, $membershipTypeValues[$memType]);
1637 if (!empty($formValues['int_amount'])) {
1638 $init_amount = array();
1639 foreach ($formValues as $key => $value) {
1640 if (strstr($key, 'txt-price')) {
1641 $init_amount[$key] = $value;
1644 $membershipParams['init_amount'] = $init_amount;
1647 if (!empty($softParams)) {
1648 $membershipParams['soft_credit'] = $softParams;
1651 $membership = CRM_Member_BAO_Membership
::create($membershipParams, $ids);
1653 $this->_membershipIDs
[] = $membership->id
;
1654 $createdMemberships[$memType] = $membership;
1660 if (!empty($lineItem[$priceSetId])) {
1661 $totalTaxAmount = 0;
1662 foreach ($lineItem[$priceSetId] as & $priceFieldOp) {
1663 if (!empty($priceFieldOp['membership_type_id'])) {
1664 $priceFieldOp['start_date'] = $membershipTypeValues[$priceFieldOp['membership_type_id']]['start_date'] ? CRM_Utils_Date
::customFormat($membershipTypeValues[$priceFieldOp['membership_type_id']]['start_date'], '%d%f %b, %Y') : '-';
1666 $priceFieldOp['end_date'] = $membershipTypeValues[$priceFieldOp['membership_type_id']]['end_date'] ? CRM_Utils_Date
::customFormat($membershipTypeValues[$priceFieldOp['membership_type_id']]['end_date'], '%d%f %b, %Y') : '-';
1669 $priceFieldOp['start_date'] = $priceFieldOp['end_date'] = 'N/A';
1671 if (isset($priceFieldOp['tax_amount'])) {
1672 $totalTaxAmount +
= $priceFieldOp['tax_amount'];
1675 //add dataArray membership receipt
1676 $dataArray = array();
1677 foreach ($lineItem[$priceSetId] as $key => $value) {
1678 if (isset($value['tax_amount']) && isset($value['tax_rate'])) {
1679 if (isset($dataArray[$value['tax_rate']])) {
1680 $dataArray[$value['tax_rate']] +
= $dataArray[$value['tax_rate']] + CRM_Utils_Array
::value('tax_amount', $value);
1682 $dataArray[$value['tax_rate']] = CRM_Utils_Array
::value('tax_amount', $value);
1686 $smarty = CRM_Core_Smarty
::singleton();
1687 $smarty->assign('dataArray', $dataArray);
1689 $this->assign('totalTaxAmount', $totalTaxAmount);
1690 $this->assign('lineItem', !empty($lineItem) && !$isQuickConfig ?
$lineItem : FALSE);
1692 $receiptSend = FALSE;
1693 if (!empty($formValues['send_receipt'])) {
1694 $receiptSend = TRUE;
1696 $formValues['contact_id'] = $this->_contactID
;
1698 // send email receipt
1699 $mailSend = self
::emailReceipt($this, $formValues, $membership);
1702 if (($this->_action
& CRM_Core_Action
::UPDATE
)) {
1703 //end date can be modified by hooks, so if end date is set then use it.
1704 $endDate = ($membership->end_date
) ?
$membership->end_date
: $endDate;
1706 $statusMsg = ts('Membership for %1 has been updated.', array(1 => $this->_memberDisplayName
));
1707 if ($endDate && $endDate !== 'null') {
1708 $endDate = CRM_Utils_Date
::customFormat($endDate);
1709 $statusMsg .= ' ' . ts('The membership End Date is %1.', array(1 => $endDate));
1712 $statusMsg .= ' ' . ts('A confirmation and receipt has been sent to %1.', array(1 => $this->_contributorEmail
));
1715 elseif (($this->_action
& CRM_Core_Action
::ADD
)) {
1716 // FIX ME: fix status messages
1718 $statusMsg = array();
1719 foreach ($membershipTypes as $memType => $membershipType) {
1720 $statusMsg[$memType] = ts('%1 membership for %2 has been added.', array(
1721 1 => $membershipType,
1722 2 => $this->_memberDisplayName
1725 $membership = $createdMemberships[$memType];
1726 $memEndDate = ($membership->end_date
) ?
$membership->end_date
: $endDate;
1728 //get the end date from calculated dates.
1729 if (!$memEndDate && empty($params['is_recur'])) {
1730 $memEndDate = CRM_Utils_Array
::value('end_date', $calcDates[$memType]);
1733 if ($memEndDate && $memEndDate !== 'null') {
1734 $memEndDate = CRM_Utils_Date
::customFormat($memEndDate);
1735 $statusMsg[$memType] .= ' ' . ts('The new membership End Date is %1.', array(1 => $memEndDate));
1738 $statusMsg = implode('<br/>', $statusMsg);
1739 if ($receiptSend && $mailSend) {
1740 $statusMsg .= ' ' . ts('A membership confirmation and receipt has been sent to %1.', array(1 => $this->_contributorEmail
));
1744 // finally set membership id if already not set
1746 $this->_id
= $membership->id
;
1749 CRM_Core_Session
::setStatus($statusMsg, ts('Complete'), 'success');
1751 $buttonName = $this->controller
->getButtonName();
1752 if ($this->_context
== 'standalone') {
1753 if ($buttonName == $this->getButtonName('upload', 'new')) {
1754 $session->replaceUserContext(CRM_Utils_System
::url('civicrm/member/add',
1755 'reset=1&action=add&context=standalone'
1759 $session->replaceUserContext(CRM_Utils_System
::url('civicrm/contact/view',
1760 "reset=1&cid={$this->_contactID}&selectedChild=member"
1764 elseif ($buttonName == $this->getButtonName('upload', 'new')) {
1765 $session->replaceUserContext(CRM_Utils_System
::url('civicrm/contact/view/membership',
1766 "reset=1&action=add&context=membership&cid={$this->_contactID}"
1772 * Function to send email receipt
1774 * @param object $form form object
1775 * @param $formValues
1776 * @param object $membership object
1778 * @internal param array $values submitted values
1779 * @return boolean true if mail was sent successfully
1782 static function emailReceipt(&$form, &$formValues, &$membership) {
1783 // retrieve 'from email id' for acknowledgement
1784 $receiptFrom = $formValues['from_email_address'];
1786 if (!empty($formValues['payment_instrument_id'])) {
1787 $paymentInstrument = CRM_Contribute_PseudoConstant
::paymentInstrument();
1788 $formValues['paidBy'] = $paymentInstrument[$formValues['payment_instrument_id']];
1791 // retrieve custom data
1792 $customFields = $customValues = array();
1793 if (property_exists($form, '_groupTree')
1794 && !empty($form->_groupTree
)
1796 foreach ($form->_groupTree
as $groupID => $group) {
1797 if ($groupID == 'info') {
1800 foreach ($group['fields'] as $k => $field) {
1801 $field['title'] = $field['label'];
1802 $customFields["custom_{$k}"] = $field;
1807 $members = array(array('member_id', '=', $membership->id
, 0, 0));
1808 // check whether its a test drive
1809 if ($form->_mode
== 'test') {
1810 $members[] = array('member_test', '=', 1, 0, 0);
1813 CRM_Core_BAO_UFGroup
::getValues($formValues['contact_id'], $customFields, $customValues, FALSE, $members);
1816 if (!empty($form->_params
['billing_first_name'])) {
1817 $name = $form->_params
['billing_first_name'];
1820 if (!empty($form->_params
['billing_middle_name'])) {
1821 $name .= " {$form->_params['billing_middle_name']}";
1824 if (!empty($form->_params
['billing_last_name'])) {
1825 $name .= " {$form->_params['billing_last_name']}";
1828 $form->assign('billingName', $name);
1830 // assign the address formatted up for display
1831 $addressParts = array(
1832 "street_address-{$form->_bltID}",
1833 "city-{$form->_bltID}",
1834 "postal_code-{$form->_bltID}",
1835 "state_province-{$form->_bltID}",
1836 "country-{$form->_bltID}",
1838 $addressFields = array();
1839 foreach ($addressParts as $part) {
1840 list($n, $id) = explode('-', $part);
1841 if (isset($form->_params
['billing_' . $part])) {
1842 $addressFields[$n] = $form->_params
['billing_' . $part];
1845 $form->assign('address', CRM_Utils_Address
::format($addressFields));
1847 $date = CRM_Utils_Date
::format($form->_params
['credit_card_exp_date']);
1848 $date = CRM_Utils_Date
::mysqlToIso($date);
1849 $form->assign('credit_card_exp_date', $date);
1850 $form->assign('credit_card_number',
1851 CRM_Utils_System
::mungeCreditCard($form->_params
['credit_card_number'])
1853 $form->assign('credit_card_type', $form->_params
['credit_card_type']);
1854 $form->assign('contributeMode', 'direct');
1855 $form->assign('isAmountzero', 0);
1856 $form->assign('is_pay_later', 0);
1857 $form->assign('isPrimary', 1);
1860 $form->assign('module', 'Membership');
1861 $form->assign('contactID', $formValues['contact_id']);
1863 $form->assign('membershipID', CRM_Utils_Array
::value('membership_id', $form->_params
, CRM_Utils_Array
::value('membership_id', $form->_defaultValues
)));
1865 if (!empty($formValues['contribution_id'])) {
1866 $form->assign('contributionID', $formValues['contribution_id']);
1868 elseif (isset($form->_onlinePendingContributionId
)) {
1869 $form->assign('contributionID', $form->_onlinePendingContributionId
);
1872 if (!empty($formValues['contribution_status_id'])) {
1873 $form->assign('contributionStatusID', $formValues['contribution_status_id']);
1874 $form->assign('contributionStatus', CRM_Contribute_PseudoConstant
::contributionStatus($formValues['contribution_status_id'], 'name'));
1877 if (!empty($formValues['is_renew'])) {
1878 $form->assign('receiptType', 'membership renewal');
1881 $form->assign('receiptType', 'membership signup');
1883 $form->assign('receive_date', CRM_Utils_Date
::processDate(CRM_Utils_Array
::value('receive_date', $formValues)));
1884 $form->assign('formValues', $formValues);
1886 if (empty($lineItem)) {
1887 $form->assign('mem_start_date', CRM_Utils_Date
::customFormat($membership->start_date
, '%B %E%f, %Y'));
1888 $form->assign('mem_end_date', CRM_Utils_Date
::customFormat($membership->end_date
, '%B %E%f, %Y'));
1889 $form->assign('membership_name', CRM_Member_PseudoConstant
::membershipType($membership->membership_type_id
));
1892 $form->assign('customValues', $customValues);
1893 $isBatchProcess = is_a($form, 'CRM_Batch_Form_Entry');
1894 if ((empty($form->_contributorDisplayName
) ||
empty($form->_contributorEmail
)) ||
$isBatchProcess) {
1895 // in this case the form is being called statically from the batch editing screen
1896 // having one class in the form layer call another statically is not greate
1897 // & we should aim to move this function to the BAO layer in future.
1898 // however, we can assume that the contact_id passed in by the batch
1899 // function will be the recipient
1901 $form->_contributorDisplayName
,
1902 $form->_contributorEmail
1903 ) = CRM_Contact_BAO_Contact_Location
::getEmailDetails(
1904 $formValues['contact_id']
1906 if (empty($form->_receiptContactId
) ||
$isBatchProcess) {
1907 $form->_receiptContactId
= $formValues['contact_id'];
1911 list($mailSend, $subject, $message, $html) = CRM_Core_BAO_MessageTemplate
::sendTemplate(
1913 'groupName' => 'msg_tpl_workflow_membership',
1914 'valueName' => 'membership_offline_receipt',
1915 'contactId' => $form->_receiptContactId
,
1916 'from' => $receiptFrom,
1917 'toName' => $form->_contributorDisplayName
,
1918 'toEmail' => $form->_contributorEmail
,
1919 'isTest' => (bool) ($form->_action
& CRM_Core_Action
::PREVIEW
)