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',
230 $mem['renewUrl'] = CRM_Utils_System
::url('civicrm/contact/view/membership',
231 "reset=1&action=renew&cid={$this->_contactID}&id={$mem['id']}&context=membership&selectedChild=member"
232 . ($this->_mode ?
'&mode=live' : '')
234 $mem['membershipTab'] = CRM_Utils_System
::url('civicrm/contact/view',
235 "reset=1&force=1&cid={$this->_contactID}&selectedChild=member"
237 $mems_by_org[$mem['member_of_contact_id']] = $mem;
239 $this->assign('existingContactMemberships', $mems_by_org);
243 // In standalone mode we don't have a contact id yet so lookup will be done client-side with this script:
244 $resources = CRM_Core_Resources
::singleton();
245 $resources->addScriptFile('civicrm', 'templates/CRM/Member/Form/MembershipStandalone.js');
247 'typeorgs' => CRM_Member_BAO_MembershipType
::getMembershipTypeOrganization(),
248 'memtypes' => CRM_Core_PseudoConstant
::get('CRM_Member_BAO_Membership', 'membership_type_id'),
249 'statuses' => CRM_Core_PseudoConstant
::get('CRM_Member_BAO_Membership', 'status_id'),
251 $resources->addSetting(array('existingMems' => $passthru));
255 // when custom data is included in this page
256 if (!empty($_POST['hidden_custom'])) {
257 CRM_Custom_Form_CustomData
::preProcess($this);
258 CRM_Custom_Form_CustomData
::buildQuickForm($this);
259 CRM_Custom_Form_CustomData
::setDefaultValues($this);
262 // CRM-4395, get the online pending contribution id.
263 $this->_onlinePendingContributionId
= NULL;
264 if (!$this->_mode
&& $this->_id
&& ($this->_action
& CRM_Core_Action
::UPDATE
)) {
265 $this->_onlinePendingContributionId
= CRM_Contribute_BAO_Contribution
::checkOnlinePendingContribution($this->_id
,
269 $this->assign('onlinePendingContributionId', $this->_onlinePendingContributionId
);
270 $this->_fromEmails
= CRM_Core_BAO_Email
::getFromEmail();
273 if ($this->_contactID
) {
274 $displayName = CRM_Contact_BAO_Contact
::displayName($this->_contactID
);
276 // Check if this is default domain contact CRM-10482
277 if (CRM_Contact_BAO_Contact
::checkDomainContact($this->_contactID
)) {
278 $displayName .= ' (' . ts('default organization') . ')';
281 // omitting contactImage from title for now since the summary overlay css doesn't work outside of our crm-container
282 CRM_Utils_System
::setTitle(ts('Membership for') . ' ' . $displayName);
284 parent
::preProcess();
288 * This function sets the default values for the form. MobileProvider that in edit/view mode
289 * the default values are retrieved from the database
295 public function setDefaultValues() {
296 if ($this->_cdType
) {
297 return CRM_Custom_Form_CustomData
::setDefaultValues($this);
300 if ($this->_priceSetId
) {
301 return CRM_Price_BAO_PriceSet
::setDefaultPriceSet($this, $defaults);
304 $defaults = parent
::setDefaultValues();
306 //setting default join date and receive date
307 list($now, $currentTime) = CRM_Utils_Date
::setDateDefaults();
308 if ($this->_action
== CRM_Core_Action
::ADD
) {
309 $defaults['receive_date'] = $now;
310 $defaults['receive_date_time'] = $currentTime;
313 if (is_numeric($this->_memType
)) {
314 $defaults['membership_type_id'] = array();
315 $defaults['membership_type_id'][0] = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType',
317 'member_of_contact_id',
320 $defaults['membership_type_id'][1] = $this->_memType
;
323 $defaults['membership_type_id'] = $this->_memType
;
326 $defaults['num_terms'] = 1;
328 if (!empty($defaults['id'])) {
329 if ($this->_onlinePendingContributionId
) {
330 $defaults['record_contribution'] = $this->_onlinePendingContributionId
;
333 $contributionId = CRM_Core_DAO
::singleValueQuery("
334 SELECT contribution_id
335 FROM civicrm_membership_payment
336 WHERE membership_id = $this->_id
337 ORDER BY contribution_id
340 if ($contributionId) {
341 $defaults['record_contribution'] = $contributionId;
346 //set Soft Credit Type to Gift by default
347 $scTypes = CRM_Core_OptionGroup
::values("soft_credit_type");
348 $defaults['soft_credit_type_id'] = CRM_Utils_Array
::value(ts('Gift'), array_flip($scTypes));
350 if (!empty($defaults['record_contribution']) && !$this->_mode
) {
351 $contributionParams = array('id' => $defaults['record_contribution']);
352 $contributionIds = array();
354 //keep main object campaign in hand.
355 $memberCampaignId = CRM_Utils_Array
::value('campaign_id', $defaults);
357 CRM_Contribute_BAO_Contribution
::getValues($contributionParams, $defaults, $contributionIds);
359 //get back original object campaign id.
360 $defaults['campaign_id'] = $memberCampaignId;
362 if (!empty($defaults['receive_date'])) {
363 list($defaults['receive_date']) = CRM_Utils_Date
::setDateDefaults($defaults['receive_date']);
366 // Contribution::getValues() over-writes the membership record's source field value - so we need to restore it.
367 if (!empty($defaults['membership_source'])) {
368 $defaults['source'] = $defaults['membership_source'];
372 if (empty($defaults['payment_instrument_id'])) {
373 $defaults['payment_instrument_id'] = key(CRM_Core_OptionGroup
::values('payment_instrument', FALSE, FALSE, FALSE, 'AND is_default = 1'));
376 // User must explicitly choose to send a receipt in both add and update mode.
377 $defaults['send_receipt'] = 0;
379 if ($this->_action
& CRM_Core_Action
::UPDATE
) {
380 // in this mode by default uncheck this checkbox
381 unset($defaults['record_contribution']);
384 if (!empty($defaults['id'])) {
385 $subscriptionCancelled = CRM_Member_BAO_Membership
::isSubscriptionCancelled($this->_id
);
388 $alreadyAutoRenew = FALSE;
389 if (!empty($defaults['contribution_recur_id']) && !$subscriptionCancelled) {
390 $defaults['auto_renew'] = 1;
391 $alreadyAutoRenew = TRUE;
393 $this->assign('alreadyAutoRenew', $alreadyAutoRenew);
395 $this->assign('member_is_test', CRM_Utils_Array
::value('member_is_test', $defaults));
397 $this->assign('membership_status_id', CRM_Utils_Array
::value('status_id', $defaults));
399 if (!empty($defaults['is_pay_later'])) {
400 $this->assign('is_pay_later', TRUE);
403 // set default country from config if no country set
404 $config = CRM_Core_Config
::singleton();
405 if (empty($defaults["billing_country_id-{$this->_bltID}"])) {
406 $defaults["billing_country_id-{$this->_bltID}"] = $config->defaultContactCountry
;
409 if (empty($defaults["billing_state_province_id-{$this->_bltID}"])) {
410 $defaults["billing_state_province_id-{$this->_bltID}"] = $config->defaultContactStateProvince
;
413 $billingDefaults = $this->getProfileDefaults('Billing', $this->_contactID
);
414 $defaults = array_merge($defaults, $billingDefaults);
416 // now fix all state country selectors, set correct state based on country
417 CRM_Core_BAO_Address
::fixAllStateSelects($this, $defaults);
419 // // hack to simplify credit card entry for testing
420 // $defaults['credit_card_type'] = 'Visa';
421 // $defaults['credit_card_number'] = '4807731747657838';
422 // $defaults['cvv2'] = '000';
423 // $defaults['credit_card_exp_date'] = array( 'Y' => '2012', 'M' => '05' );
426 $dates = array('join_date', 'start_date', 'end_date');
427 foreach ($dates as $key) {
428 if (!empty($defaults[$key])) {
429 list($defaults[$key]) = CRM_Utils_Date
::setDateDefaults(CRM_Utils_Array
::value($key, $defaults));
433 //setting default join date if there is no join date
434 if (empty($defaults['join_date'])) {
435 $defaults['join_date'] = $now;
438 if (!empty($defaults['membership_end_date'])) {
439 $this->assign('endDate', $defaults['membership_end_date']);
446 * Function to build the form
451 public function buildQuickForm() {
452 if ($this->_cdType
) {
453 return CRM_Custom_Form_CustomData
::buildQuickForm($this);
456 $this->assign('taxRates', json_encode(CRM_Core_PseudoConstant
::getTaxRates()));
457 // build price set form.
458 $buildPriceSet = FALSE;
459 if ($this->_priceSetId ||
!empty($_POST['price_set_id'])) {
460 if (!empty($_POST['price_set_id'])) {
461 $buildPriceSet = TRUE;
463 $getOnlyPriceSetElements = TRUE;
464 if (!$this->_priceSetId
) {
465 $this->_priceSetId
= $_POST['price_set_id'];
466 $getOnlyPriceSetElements = FALSE;
469 $this->set('priceSetId', $this->_priceSetId
);
470 CRM_Price_BAO_PriceSet
::buildPriceSet($this);
472 $optionsMembershipTypes = array();
473 foreach ($this->_priceSet
['fields'] as $pField) {
474 if (empty($pField['options'])) {
477 foreach ($pField['options'] as $opId => $opValues) {
478 $optionsMembershipTypes[$opId] = CRM_Utils_Array
::value('membership_type_id', $opValues, 0);
482 $this->assign('autoRenewOption', CRM_Price_BAO_PriceSet
::checkAutoRenewForPriceSet($this->_priceSetId
));
484 $this->assign('optionsMembershipTypes', $optionsMembershipTypes);
485 $this->assign('contributionType', CRM_Utils_Array
::value('financial_type_id', $this->_priceSet
));
487 // get only price set form elements.
488 if ($getOnlyPriceSetElements) {
493 // use to build form during form rule.
494 $this->assign('buildPriceSet', $buildPriceSet);
496 if ($this->_action
& CRM_Core_Action
::ADD
) {
497 $buildPriceSet = FALSE;
498 $priceSets = CRM_Price_BAO_PriceSet
::getAssoc(FALSE, 'CiviMember');
499 if (!empty($priceSets)) {
500 $buildPriceSet = TRUE;
503 if ($buildPriceSet) {
504 $this->add('select', 'price_set_id', ts('Choose price set'),
506 '' => ts('Choose price set')
508 NULL, array('onchange' => "buildAmount( this.value );")
511 $this->assign('hasPriceSets', $buildPriceSet);
514 //need to assign custom data type and subtype to the template
515 $this->assign('customDataType', 'Membership');
516 $this->assign('customDataSubType', $this->_memType
);
517 $this->assign('entityID', $this->_id
);
519 if ($this->_action
& CRM_Core_Action
::DELETE
) {
520 $this->addButtons(array(
523 'name' => ts('Delete'),
524 'spacing' => ' ',
529 'name' => ts('Cancel'),
536 if ($this->_context
== 'standalone') {
537 $this->addEntityRef('contact_id', ts('Contact'), array('create' => TRUE, 'api' => array('extra' => array('email'))), TRUE);
540 $selOrgMemType[0][0] = $selMemTypeOrg[0] = ts('- select -');
542 $dao = new CRM_Member_DAO_MembershipType();
543 $dao->domain_id
= CRM_Core_Config
::domainID();
546 // retrieve all memberships
547 $allMemberships = CRM_Member_BAO_Membership
::buildMembershipTypeValues($this);
549 $allMembershipInfo = $membershipType = array();
550 foreach ($allMemberships as $key => $values) {
551 if (!empty($values['is_active'])) {
552 $membershipType[$key] = CRM_Utils_Array
::value('name', $values);
553 if ($this->_mode
&& empty($values['minimum_fee'])) {
557 $memberOfContactId = CRM_Utils_Array
::value('member_of_contact_id', $values);
558 if (empty($selMemTypeOrg[$memberOfContactId])) {
559 $selMemTypeOrg[$memberOfContactId] = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact',
565 $selOrgMemType[$memberOfContactId][0] = ts('- select -');
567 if (empty($selOrgMemType[$memberOfContactId][$key])) {
568 $selOrgMemType[$memberOfContactId][$key] = CRM_Utils_Array
::value('name', $values);
572 // build membership info array, which is used when membership type is selected to:
573 // - set the payment information block
574 // - set the max related block
575 $allMembershipInfo[$key] = array(
576 'financial_type_id' => CRM_Utils_Array
::value('financial_type_id', $values),
577 'total_amount' => CRM_Utils_Money
::format($values['minimum_fee'], NULL, '%a'),
578 'total_amount_numeric' => CRM_Utils_Array
::value('minimum_fee', $values),
579 'auto_renew' => CRM_Utils_Array
::value('auto_renew', $values),
580 'has_related' => isset($values['relationship_type_id']),
581 'max_related' => CRM_Utils_Array
::value('max_related', $values),
586 $this->assign('allMembershipInfo', json_encode($allMembershipInfo));
588 // show organization by default, if only one organization in
590 if (count($selMemTypeOrg) == 2) {
591 unset($selMemTypeOrg[0], $selOrgMemType[0][0]);
593 //sort membership organization and type, CRM-6099
594 natcasesort($selMemTypeOrg);
595 foreach ($selOrgMemType as $index => $orgMembershipType) {
596 natcasesort($orgMembershipType);
597 $selOrgMemType[$index] = $orgMembershipType;
600 $memTypeJs = array('onChange' => "CRM.buildCustomData( 'Membership', this.value );");
602 //build the form for auto renew.
603 $recurProcessor = $autoRenew = array();
604 if ($this->_mode ||
($this->_action
& CRM_Core_Action
::UPDATE
)) {
605 $autoRenewElement = $this->addElement('checkbox',
607 ts('Membership renewed automatically'),
609 array('onclick' => "buildReceiptANDNotice( );")
613 //get the valid recurring processors.
614 $recurring = CRM_Core_PseudoConstant
::paymentProcessor(FALSE, FALSE, 'is_recur = 1');
615 $recurProcessor = array_intersect_assoc($this->_processors
, $recurring);
616 $autoRenew = array();
617 if (!empty($recurProcessor)) {
618 if (!empty($membershipType)) {
624 FROM civicrm_membership_type
625 WHERE id IN ( ' . implode(' , ', array_keys($membershipType)) . ' )';
626 $recurMembershipTypes = CRM_Core_DAO
::executeQuery($sql);
627 while ($recurMembershipTypes->fetch()) {
628 $autoRenew[$recurMembershipTypes->id
] = $recurMembershipTypes->auto_renew
;
635 $this->_recurMembershipTypes
[$recurMembershipTypes->id
][$fld] = $recurMembershipTypes->$fld;
641 "CRM.buildCustomData( 'Membership', this.value ); buildAutoRenew(this.value, null );",
646 $allowAutoRenew = FALSE;
647 if ($this->_mode
&& !empty($recurProcessor)) {
648 $allowAutoRenew = TRUE;
650 $this->assign('allowAutoRenew', $allowAutoRenew);
651 $this->assign('autoRenewOptions', json_encode($autoRenew));
652 $this->assign('recurProcessor', json_encode($recurProcessor));
654 // for max_related: a little JS to show/hide & set default value
655 $memTypeJs['onChange'] = "buildMaxRelated(this.value,true); " . $memTypeJs['onChange'];
656 $this->add('text', 'max_related', ts('Max related'),
657 CRM_Core_DAO
::getAttribute('CRM_Member_DAO_Membership', 'max_related')
660 $sel = & $this->addElement('hierselect',
661 'membership_type_id',
662 ts('Membership Organization and Type'),
666 $sel->setOptions(array($selMemTypeOrg, $selOrgMemType));
672 $this->applyFilter('__ALL__', 'trim');
674 if ($this->_action
& CRM_Core_Action
::ADD
) {
675 $this->add('text', 'num_terms', ts('Number of Terms'), array('size' => 6));
678 $this->addDate('join_date', ts('Member Since'), FALSE, array('formatType' => 'activityDate'));
679 $this->addDate('start_date', ts('Start Date'), FALSE, array('formatType' => 'activityDate'));
680 $endDate = $this->addDate('end_date', ts('End Date'), FALSE, array('formatType' => 'activityDate'));
682 $elements[] = $endDate;
685 $this->add('text', 'source', ts('Source'),
686 CRM_Core_DAO
::getAttribute('CRM_Member_DAO_Membership', 'source')
689 //CRM-7362 --add campaigns.
692 $campaignId = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership', $this->_id
, 'campaign_id');
694 CRM_Campaign_BAO_Campaign
::addCampaign($this, $campaignId);
697 $this->add('select', 'status_id', ts('Membership Status'),
698 array('' => ts('- select -')) + CRM_Member_PseudoConstant
::membershipStatus(NULL, NULL, 'label')
700 $statusOverride = $this->addElement('checkbox', 'is_override',
701 ts('Status Override?'), NULL,
702 array('onClick' => 'showHideMemberStatus()')
704 if ($statusOverride) {
705 $elements[] = $statusOverride;
708 $this->addElement('checkbox', 'record_contribution', ts('Record Membership Payment?'));
710 $this->add('text', 'total_amount', ts('Amount'));
711 $this->addRule('total_amount', ts('Please enter a valid amount.'), 'money');
713 $this->addDate('receive_date', ts('Received'), FALSE, array('formatType' => 'activityDateTime'));
715 $this->add('select', 'payment_instrument_id',
717 array('' => ts('- select -')) + CRM_Contribute_PseudoConstant
::paymentInstrument(),
718 FALSE, array('onChange' => "return showHideByValue('payment_instrument_id','4','checkNumber','table-row','select',false);")
720 $this->add('text', 'trxn_id', ts('Transaction ID'));
721 $this->addRule('trxn_id', ts('Transaction ID already exists in Database.'),
722 'objectExists', array('CRM_Contribute_DAO_Contribution', $this->_id
, 'trxn_id')
725 $allowStatuses = array();
726 $statuses = CRM_Contribute_PseudoConstant
::contributionStatus();
727 if ($this->_onlinePendingContributionId
) {
728 $statusNames = CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name');
729 foreach ($statusNames as $val => $name) {
730 if (in_array($name, array(
737 $allowStatuses[$val] = $statuses[$val];
741 $allowStatuses = $statuses;
743 $this->add('select', 'contribution_status_id',
744 ts('Payment Status'), $allowStatuses
746 $this->add('text', 'check_number', ts('Check Number'),
747 CRM_Core_DAO
::getAttribute('CRM_Contribute_DAO_Contribution', 'check_number')
751 //add field for amount to allow an amount to be entered that differs from minimum
752 $this->add('text', 'total_amount', ts('Amount'));
754 $this->add('select', 'financial_type_id',
755 ts('Financial Type'),
756 array('' => ts('- select -')) + CRM_Contribute_PseudoConstant
::financialType()
759 //CRM-10223 - allow contribution to be recorded against different contact
760 // causes a conflict in standalone mode so skip in standalone for now
761 $this->addElement('checkbox', 'is_different_contribution_contact', ts('Record Payment from a Different Contact?'));
762 $this->addSelect('soft_credit_type_id', array('entity' => 'contribution_soft'));
763 $this->addEntityRef('soft_credit_contact_id', ts('Payment From'), array('create' => TRUE));
766 $this->addElement('checkbox',
768 ts('Send Confirmation and Receipt?'), NULL,
769 array('onclick' => "showHideByValue( 'send_receipt', '', 'notice', 'table-row', 'radio', false); showHideByValue( 'send_receipt', '', 'fromEmail', 'table-row', 'radio', false);")
772 $this->add('select', 'from_email_address', ts('Receipt From'), $this->_fromEmails
);
774 $this->add('textarea', 'receipt_text_signup', ts('Receipt Message'));
777 $this->add('select', 'payment_processor_id',
778 ts('Payment Processor'),
779 $this->_processors
, TRUE,
780 array('onChange' => "buildAutoRenew( null, this.value );")
782 CRM_Core_Payment_Form
::buildCreditCard($this, TRUE);
785 // Retrieve the name and email of the contact - this will be the TO for receipt email
786 if ($this->_contactID
) {
787 list($this->_memberDisplayName
,
789 ) = CRM_Contact_BAO_Contact_Location
::getEmailDetails($this->_contactID
);
791 $this->assign('emailExists', $this->_memberEmail
);
792 $this->assign('displayName', $this->_memberDisplayName
);
796 if ($this->_action
& CRM_Core_Action
::UPDATE
) {
797 $recurContributionId = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership', $this->_id
,
798 'contribution_recur_id'
800 if ($recurContributionId && !CRM_Member_BAO_Membership
::isSubscriptionCancelled($this->_id
)) {
802 if (CRM_Member_BAO_Membership
::isCancelSubscriptionSupported($this->_id
)) {
803 $this->assign('cancelAutoRenew',
804 CRM_Utils_System
::url('civicrm/contribute/unsubscribe', "reset=1&mid={$this->_id}")
807 foreach ($elements as $elem) {
812 $this->assign('isRecur', $isRecur);
814 $this->addFormRule(array('CRM_Member_Form_Membership', 'formRule'), $this);
816 $mailingInfo = CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::MAILING_PREFERENCES_NAME
,
819 $this->assign('outBound_option', $mailingInfo['outBound_option']);
821 parent
::buildQuickForm();
825 * Function for validation
827 * @param array $params (ref.) an assoc array of name/value pairs
832 * @throws CiviCRM_API3_Exception
833 * @return mixed true or array of errors
837 static function formRule($params, $files, $self) {
840 $priceSetId = CRM_Utils_Array
::value('price_set_id', $params);
843 CRM_Price_BAO_PriceField
::priceSetValidation($priceSetId, $params, $errors);
845 $priceFieldIDS = array();
846 foreach ($self->_priceSet
['fields'] as $priceIds => $dontCare) {
848 if (!empty($params['price_' . $priceIds])) {
849 if (is_array($params['price_' . $priceIds])) {
850 foreach ($params['price_' . $priceIds] as $priceFldVal => $isSet) {
852 $priceFieldIDS[] = $priceFldVal;
857 $priceFieldIDS[] = $params['price_' . $priceIds];
862 if (!empty($priceFieldIDS)) {
863 $ids = implode(',', $priceFieldIDS);
865 $count = CRM_Price_BAO_PriceSet
::getMembershipCount($ids);
866 foreach ($count as $id => $occurance) {
867 if ($occurance > 1) {
868 $errors['_qf_default'] = ts('Select at most one option associated with the same membership type.');
872 foreach ($priceFieldIDS as $priceFieldId) {
873 if ($id = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceFieldValue', $priceFieldId, 'membership_type_id')) {
874 $self->_memTypeSelected
[$id] = $id;
879 elseif (empty($params['membership_type_id'][1])) {
880 $errors['membership_type_id'] = ts('Please select a membership type.');
883 $self->_memTypeSelected
[] = $params['membership_type_id'][1];
887 $numterms = CRM_Utils_Array
::value('num_terms', $params);
888 if ($numterms && intval($numterms) != $numterms) {
889 $errors['num_terms'] = ts('Please enter an integer for the number of terms.');
893 // Return error if empty $self->_memTypeSelected
894 if ($priceSetId && empty($errors) && empty($self->_memTypeSelected
)) {
895 $errors['_qf_default'] = ts('Select at least one membership option.');
898 if (!empty($errors) && (count($self->_memTypeSelected
) > 1)) {
899 $memberOfContacts = CRM_Member_BAO_MembershipType
::getMemberOfContactByMemTypes($self->_memTypeSelected
);
900 $duplicateMemberOfContacts = array_count_values($memberOfContacts);
901 foreach ($duplicateMemberOfContacts as $countDuplicate) {
902 if ($countDuplicate > 1) {
903 $errors['_qf_default'] = ts('Please do not select more than one membership associated with the same organization.');
908 if (!empty($errors)) {
912 if ($priceSetId && !$self->_mode
&& empty($params['record_contribution'])) {
913 $errors['record_contribution'] = ts('Record Membership Payment is required when you using price set.');
916 if (!$priceSetId && $self->_mode
&& empty($params['financial_type_id'])) {
917 $errors['financial_type_id'] = ts('Please enter the financial Type.');
920 if (!empty($params['record_contribution']) && empty($params['payment_instrument_id'])) {
921 $errors['payment_instrument_id'] = ts('Paid By is a required field.');
924 if (!empty($params['is_different_contribution_contact'])) {
925 if (empty($params['soft_credit_type_id'])) {
926 $errors['soft_credit_type_id'] = ts('Please Select a Soft Credit Type');
928 if (empty($params['soft_credit_contact_id'])) {
929 $errors['soft_credit_contact_id'] = ts('Please select a contact');
933 if (!empty($params['payment_processor_id'])) {
934 // make sure that credit card number and cvv are valid
935 CRM_Core_Payment_Form
::validateCreditCard($params, $errors);
939 if (!empty($params['join_date'])) {
941 $joinDate = CRM_Utils_Date
::processDate($params['join_date']);
943 foreach ($self->_memTypeSelected
as $memType) {
945 if (!empty($params['start_date'])) {
946 $startDate = CRM_Utils_Date
::processDate($params['start_date']);
949 // if end date is set, ensure that start date is also set
950 // and that end date is later than start date
952 if (!empty($params['end_date'])) {
953 $endDate = CRM_Utils_Date
::processDate($params['end_date']);
956 $membershipDetails = CRM_Member_BAO_MembershipType
::getMembershipTypeDetails($memType);
958 if ($startDate && CRM_Utils_Array
::value('period_type', $membershipDetails) == 'rolling') {
959 if ($startDate < $joinDate) {
960 $errors['start_date'] = ts('Start date must be the same or later than Member since.');
965 if ($membershipDetails['duration_unit'] == 'lifetime') {
966 // Check if status is NOT cancelled or similar. For lifetime memberships, there is no automated
967 // process to update status based on end-date. The user must change the status now.
968 $result = civicrm_api3('MembershipStatus', 'get', array(
970 'is_current_member' => 0,
972 $tmp_statuses = $result['values'];
973 $status_ids = array();
974 foreach($tmp_statuses as $cur_stat) {
975 $status_ids[] = $cur_stat['id'];
977 if (empty($params['status_id']) ||
in_array( $params['status_id'] , $status_ids) == false) {
978 $errors['status_id'] = ts('Please enter a status that does NOT represent a current membership status.');
979 $errors['is_override'] = ts('This must be checked because you set an End Date for a lifetime membership');
984 $errors['start_date'] = ts('Start date must be set if end date is set.');
986 if ($endDate < $startDate) {
987 $errors['end_date'] = ts('End date must be the same or later than start date.');
992 // Default values for start and end dates if not supplied
994 $defaultDates = CRM_Member_BAO_MembershipType
::getDatesForMembershipType($memType,
1001 $startDate = CRM_Utils_Array
::value('start_date',
1006 $endDate = CRM_Utils_Array
::value('end_date',
1011 //CRM-3724, check for availability of valid membership status.
1012 if (empty($params['is_override']) && !isset($errors['_qf_default'])) {
1013 $calcStatus = CRM_Member_BAO_MembershipStatus
::getMembershipStatusByDate($startDate,
1021 if (empty($calcStatus)) {
1022 $url = CRM_Utils_System
::url('civicrm/admin/member/membershipStatus', 'reset=1&action=browse');
1023 $errors['_qf_default'] = ts('There is no valid Membership Status available for selected membership dates.');
1024 $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));
1025 if (!$self->_mode
) {
1026 $status .= ' ' . ts('OR You can sign up by setting Status Override? to true.');
1028 CRM_Core_Session
::setStatus($status, ts('Membership Status Error'), 'error');
1034 $errors['join_date'] = ts('Please enter the Member Since.');
1037 if (isset($params['is_override']) &&
1038 $params['is_override'] && empty($params['status_id'])) {
1039 $errors['status_id'] = ts('Please enter the status.');
1042 //total amount condition arise when membership type having no
1044 if (isset($params['record_contribution'])) {
1045 if (!$params['financial_type_id']) {
1046 $errors['financial_type_id'] = ts('Please enter the financial Type.');
1048 if (CRM_Utils_System
::isNull($params['total_amount'])) {
1049 $errors['total_amount'] = ts('Please enter the contribution.');
1053 // validate contribution status for 'Failed'.
1054 if ($self->_onlinePendingContributionId
&& !empty($params['record_contribution']) &&
1055 (CRM_Utils_Array
::value('contribution_status_id', $params) ==
1056 array_search('Failed', CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name'))
1059 $errors['contribution_status_id'] = ts('Please select a valid payment status before updating.');
1062 return empty($errors) ?
TRUE : $errors;
1066 * Function to process the form
1072 public function postProcess() {
1073 if ($this->_action
& CRM_Core_Action
::DELETE
) {
1074 CRM_Member_BAO_Membership
::del($this->_id
);
1078 $isTest = ($this->_mode
== 'test') ?
1 : 0;
1081 if (!empty($this->_lineItem
)) {
1082 $lineItems = $this->_lineItem
;
1085 $config = CRM_Core_Config
::singleton();
1086 // get the submitted form values.
1087 $this->_params
= $formValues = $this->controller
->exportValues($this->_name
);
1088 $this->convertDateFieldsToMySQL($formValues);
1090 $params = $softParams = $ids = array();
1092 $membershipTypeValues = array();
1093 foreach ($this->_memTypeSelected
as $memType) {
1094 $membershipTypeValues[$memType]['membership_type_id'] = $memType;
1097 //take the required membership recur values.
1098 if ($this->_mode
&& !empty($this->_params
['auto_renew'])) {
1099 $params['is_recur'] = $this->_params
['is_recur'] = $formValues['is_recur'] = TRUE;
1101 'frequency_interval' => 'duration_interval',
1102 'frequency_unit' => 'duration_unit',
1106 foreach ($this->_memTypeSelected
as $memType) {
1107 $recurMembershipTypeValues = CRM_Utils_Array
::value($memType,
1108 $this->_recurMembershipTypes
, array()
1110 foreach ($mapping as $mapVal => $mapParam) {
1111 $membershipTypeValues[$memType][$mapVal] = CRM_Utils_Array
::value($mapParam,
1112 $recurMembershipTypeValues
1115 $this->_params
[$mapVal] = $formValues[$mapVal] = CRM_Utils_Array
::value($mapParam,
1116 $recurMembershipTypeValues
1123 // unset send-receipt option, since receipt will be sent when ipn is received.
1124 unset($this->_params
['send_receipt'], $formValues['send_receipt']);
1127 // process price set and get total amount and line items.
1128 $lineItem = array();
1130 if (!$priceSetId = CRM_Utils_Array
::value('price_set_id', $formValues)) {
1131 CRM_Member_BAO_Membership
::createLineItems($this, $formValues['membership_type_id'], $priceSetId);
1134 if ($this->_priceSetId
&& CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet', $this->_priceSetId
, 'is_quick_config')) {
1138 $termsByType = array();
1140 CRM_Price_BAO_PriceSet
::processAmount($this->_priceSet
['fields'],
1141 $this->_params
, $lineItem[$priceSetId]);
1142 if (CRM_Utils_Array
::value('tax_amount', $this->_params
)) {
1143 $params['tax_amount'] = $this->_params
['tax_amount'];
1145 $params['total_amount'] = CRM_Utils_Array
::value('amount', $this->_params
);
1146 $submittedFinancialType = CRM_Utils_Array
::value('financial_type_id', $formValues);
1147 if (!empty($lineItem[$priceSetId])) {
1148 foreach ($lineItem[$priceSetId] as &$li) {
1149 if (!empty($li['membership_type_id'])) {
1150 if (!empty($li['membership_num_terms'])) {
1151 $termsByType[$li['membership_type_id']] = $li['membership_num_terms'];
1155 ///CRM-11529 for quick config backoffice transactions
1156 //when financial_type_id is passed in form, update the
1157 //lineitems with the financial type selected in form
1158 if ($isQuickConfig && $submittedFinancialType) {
1159 $li['financial_type_id'] = $submittedFinancialType;
1165 $this->storeContactFields($formValues);
1167 $params['contact_id'] = $this->_contactID
;
1176 foreach ($fields as $f) {
1177 $params[$f] = CRM_Utils_Array
::value($f, $formValues);
1181 // when is_override false ignore is_admin statuses during membership
1182 // status calculation. similarly we did fix for import in CRM-3570.
1183 if (empty($params['is_override'])) {
1184 $params['exclude_is_admin'] = TRUE;
1187 // process date params to mysql date format.
1189 'join_date' => 'joinDate',
1190 'start_date' => 'startDate',
1191 'end_date' => 'endDate',
1193 foreach ($dateTypes as $dateField => $dateVariable) {
1194 $
$dateVariable = CRM_Utils_Date
::processDate($formValues[$dateField]);
1197 $memTypeNumTerms = CRM_Utils_Array
::value('num_terms', $formValues);
1199 $calcDates = array();
1200 foreach ($this->_memTypeSelected
as $memType) {
1201 if (empty($memTypeNumTerms)) {
1202 $memTypeNumTerms = CRM_Utils_Array
::value($memType, $termsByType, 1);
1204 $calcDates[$memType] = CRM_Member_BAO_MembershipType
::getDatesForMembershipType($memType,
1205 $joinDate, $startDate, $endDate, $memTypeNumTerms
1209 foreach ($calcDates as $memType => $calcDate) {
1210 foreach (array_keys($dateTypes) as $d) {
1211 //first give priority to form values then calDates.
1212 $date = CRM_Utils_Array
::value($d, $formValues);
1214 $date = CRM_Utils_Array
::value($d, $calcDate);
1217 $membershipTypeValues[$memType][$d] = CRM_Utils_Date
::processDate($date);
1218 //$params[$d] = CRM_Utils_Date::processDate( $date );
1222 // max related memberships - take from form or inherit from membership type
1223 foreach ($this->_memTypeSelected
as $memType) {
1224 if (array_key_exists('max_related', $formValues)) {
1225 $membershipTypeValues[$memType]['max_related'] = CRM_Utils_Array
::value('max_related', $formValues);
1230 $ids['membership'] = $params['id'] = $this->_id
;
1233 $session = CRM_Core_Session
::singleton();
1234 $ids['userId'] = $session->get('userID');
1236 // membership type custom data
1237 foreach ($this->_memTypeSelected
as $memType) {
1238 $customFields = CRM_Core_BAO_CustomField
::getFields('Membership', FALSE, FALSE,
1242 $customFields = CRM_Utils_Array
::crmArrayMerge($customFields,
1243 CRM_Core_BAO_CustomField
::getFields('Membership',
1249 $membershipTypeValues[$memType]['custom'] = CRM_Core_BAO_CustomField
::postProcess($formValues,
1256 foreach ($this->_memTypeSelected
as $memType) {
1257 $membershipTypes[$memType] = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType',
1262 $membershipType = implode(', ', $membershipTypes);
1264 // Retrieve the name and email of the current user - this will be the FROM for the receipt email
1265 list($userName, $userEmail) = CRM_Contact_BAO_Contact_Location
::getEmailDetails($ids['userId']);
1267 //CRM-13981, allow different person as a soft-contributor of chosen type
1268 if ($this->_contributorContactID
!= $this->_contactID
) {
1269 $params['contribution_contact_id'] = $this->_contributorContactID
;
1270 if (!empty($this->_params
['soft_credit_type_id'])) {
1271 $softParams['soft_credit_type_id'] = $this->_params
['soft_credit_type_id'];
1272 $softParams['contact_id'] = $this->_contactID
;
1275 if (!empty($formValues['record_contribution'])) {
1276 $recordContribution = array(
1278 'financial_type_id',
1279 'payment_instrument_id',
1281 'contribution_status_id',
1287 foreach ($recordContribution as $f) {
1288 $params[$f] = CRM_Utils_Array
::value($f, $formValues);
1291 if (!$this->_onlinePendingContributionId
) {
1292 if (empty($formValues['source'])) {
1293 $params['contribution_source'] = ts('%1 Membership: Offline signup (by %2)', array(1 => $membershipType, 2 => $userName));
1296 $params['contribution_source'] = $formValues['source'];
1300 if (empty($params['is_override']) &&
1301 CRM_Utils_Array
::value('contribution_status_id', $params) == array_search('Pending', CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name'))
1303 $allStatus = CRM_Member_PseudoConstant
::membershipStatus();
1304 $params['status_id'] = array_search('Pending', $allStatus);
1305 $params['skipStatusCal'] = TRUE;
1306 $params['is_pay_later'] = 1;
1307 $this->assign('is_pay_later', 1);
1310 if (!empty($formValues['send_receipt'])) {
1311 $params['receipt_date'] = CRM_Utils_Array
::value('receive_date', $formValues);
1314 //insert financial type name in receipt.
1315 $formValues['contributionType_name'] = CRM_Core_DAO
::getFieldValue('CRM_Financial_DAO_FinancialType',
1316 $formValues['financial_type_id']
1320 // process line items, until no previous line items.
1321 if (!empty($lineItem)) {
1322 $params['lineItems'] = $lineItem;
1323 $params['processPriceSet'] = TRUE;
1325 $createdMemberships = array();
1327 if (empty($formValues['total_amount']) && !$priceSetId) {
1328 // if total amount not provided minimum for membership type is used
1329 $params['total_amount'] = $formValues['total_amount'] = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType',
1330 $formValues['membership_type_id'][1], 'minimum_fee'
1334 $params['total_amount'] = CRM_Utils_Array
::value('total_amount', $formValues, 0);
1337 if ($priceSetId && !$isQuickConfig) {
1338 $params['financial_type_id'] = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet',
1344 $params['financial_type_id'] = CRM_Utils_Array
::value('financial_type_id', $formValues);
1347 $this->_paymentProcessor
= CRM_Financial_BAO_PaymentProcessor
::getPayment($formValues['payment_processor_id'],
1351 //get the payment processor id as per mode.
1352 $params['payment_processor_id'] = $this->_params
['payment_processor_id'] = $formValues['payment_processor_id'] = $this->_paymentProcessor
['id'];
1355 $now = date('YmdHis');
1358 // set email for primary location.
1359 $fields['email-Primary'] = 1;
1360 $formValues['email-5'] = $formValues['email-Primary'] = $this->_memberEmail
;
1361 $params['register_date'] = $now;
1363 // now set the values for the billing location.
1364 foreach ($this->_fields
as $name => $dontCare) {
1368 // also add location name to the array
1369 $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);
1371 $formValues["address_name-{$this->_bltID}"] = trim($formValues["address_name-{$this->_bltID}"]);
1373 $fields["address_name-{$this->_bltID}"] = 1;
1374 //ensure we don't over-write the payer's email with the member's email
1375 if ($this->_contributorContactID
== $this->_contactID
) {
1376 $fields["email-{$this->_bltID}"] = 1;
1379 $ctype = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $this->_contactID
, 'contact_type');
1381 $nameFields = array('first_name', 'middle_name', 'last_name');
1383 foreach ($nameFields as $name) {
1385 if (array_key_exists("billing_$name", $formValues)) {
1386 $formValues[$name] = $formValues["billing_{$name}"];
1387 $formValues['preserveDBName'] = TRUE;
1390 if ($this->_contributorContactID
== $this->_contactID
) {
1391 //see CRM-12869 for discussion of why we don't do this for separate payee payments
1392 CRM_Contact_BAO_Contact
::createProfileContact($formValues, $fields,
1393 $this->_contributorContactID
, NULL, NULL, $ctype
1397 // add all the additional payment params we need
1398 $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}"]);
1399 $this->_params
["country-{$this->_bltID}"] = $this->_params
["billing_country-{$this->_bltID}"] = CRM_Core_PseudoConstant
::countryIsoCode($this->_params
["billing_country_id-{$this->_bltID}"]);
1401 $this->_params
['year'] = CRM_Core_Payment_Form
::getCreditCardExpirationYear($this->_params
);
1402 $this->_params
['month'] = CRM_Core_Payment_Form
::getCreditCardExpirationMonth($this->_params
);
1403 $this->_params
['ip_address'] = CRM_Utils_System
::ipAddress();
1404 $this->_params
['amount'] = $params['total_amount'];
1405 $this->_params
['currencyID'] = $config->defaultCurrency
;
1406 $this->_params
['payment_action'] = 'Sale';
1407 $this->_params
['invoiceID'] = md5(uniqid(rand(), TRUE));
1408 $this->_params
['financial_type_id'] = $params['financial_type_id'];
1410 // at this point we've created a contact and stored its address etc
1411 // all the payment processors expect the name and address to be in the
1412 // so we copy stuff over to first_name etc.
1413 $paymentParams = $this->_params
;
1414 $paymentParams['contactID'] = $this->_contributorContactID
;
1415 //CRM-10377 if payment is by an alternate contact then we need to set that person
1416 // as the contact in the payment params
1417 if ($this->_contributorContactID
!= $this->_contactID
) {
1418 if (!empty($this->_params
['soft_credit_type_id'])) {
1419 $softParams['contact_id'] = $params['contact_id'];
1420 $softParams['soft_credit_type_id'] = $this->_params
['soft_credit_type_id'];
1423 if (!empty($this->_params
['send_receipt'])) {
1424 $paymentParams['email'] = $this->_contributorEmail
;
1427 CRM_Core_Payment_Form
::mapParams($this->_bltID
, $this->_params
, $paymentParams, TRUE);
1429 // CRM-7137 -for recurring membership,
1430 // we do need contribution and recuring records.
1432 if (!empty($paymentParams['is_recur'])) {
1433 $allStatus = CRM_Member_PseudoConstant
::membershipStatus();
1435 $contributionType = new CRM_Financial_DAO_FinancialType();
1436 $contributionType->id
= $params['financial_type_id'];
1437 if (!$contributionType->find(TRUE)) {
1438 CRM_Core_Error
::fatal('Could not find a system table');
1441 $contribution = CRM_Contribute_Form_Contribution_Confirm
::processContribution($this,
1444 $this->_contributorContactID
,
1452 //create new soft-credit record, CRM-13981
1453 $softParams['contribution_id'] = $contribution->id
;
1454 $softParams['currency'] = $contribution->currency
;
1455 $softParams['amount'] = $contribution->total_amount
;
1456 CRM_Contribute_BAO_ContributionSoft
::add($softParams);
1458 $paymentParams['contactID'] = $this->_contactID
;
1459 $paymentParams['contributionID'] = $contribution->id
;
1460 $paymentParams['contributionTypeID'] = $contribution->financial_type_id
;
1461 $paymentParams['contributionPageID'] = $contribution->contribution_page_id
;
1462 $paymentParams['contributionRecurID'] = $contribution->contribution_recur_id
;
1463 $ids['contribution'] = $contribution->id
;
1464 $params['contribution_recur_id'] = $paymentParams['contributionRecurID'];
1465 $params['status_id'] = array_search('Pending', $allStatus);
1466 $params['skipStatusCal'] = TRUE;
1468 //as membership is pending set dates to null.
1469 $memberDates = array(
1470 'join_date' => 'joinDate',
1471 'start_date' => 'startDate',
1472 'end_date' => 'endDate',
1475 foreach ($memberDates as $dp => $dv) {
1477 foreach ($this->_memTypeSelected
as $memType) {
1478 $membershipTypeValues[$memType][$dv] = NULL;
1483 if ($params['total_amount'] > 0.0) {
1484 $payment = CRM_Core_Payment
::singleton($this->_mode
, $this->_paymentProcessor
, $this);
1485 $result = & $payment->doDirectPayment($paymentParams);
1488 if (is_a($result, 'CRM_Core_Error')) {
1489 //make sure to cleanup db for recurring case.
1490 if (!empty($paymentParams['contributionID'])) {
1491 CRM_Contribute_BAO_Contribution
::deleteContribution($paymentParams['contributionID']);
1493 if (!empty($paymentParams['contributionRecurID'])) {
1494 CRM_Contribute_BAO_ContributionRecur
::deleteRecurContribution($paymentParams['contributionRecurID']);
1497 CRM_Core_Error
::displaySessionError($result);
1498 CRM_Utils_System
::redirect(CRM_Utils_System
::url('civicrm/contact/view/membership',
1499 "reset=1&action=add&cid={$this->_contactID}&context=&mode={$this->_mode}"
1504 $this->_params
= array_merge($this->_params
, $result);
1505 //assign amount to template if payment was successful
1506 $this->assign('amount', $params['total_amount']);
1509 $params['contribution_status_id'] = !empty($paymentParams['is_recur']) ?
2 : 1;
1510 $params['receive_date'] = $now;
1511 $params['invoice_id'] = $this->_params
['invoiceID'];
1512 $params['contribution_source'] = ts('%1 Membership Signup: Credit card or direct debit (by %2)',
1513 array(1 => $membershipType, 2 => $userName)
1515 $params['source'] = $formValues['source'] ?
$formValues['source'] : $params['contribution_source'];
1516 $params['trxn_id'] = CRM_Utils_Array
::value('trxn_id', $result);
1517 $params['payment_instrument_id'] = 1;
1518 $params['is_test'] = ($this->_mode
== 'live') ?
0 : 1;
1519 if (!empty($this->_params
['send_receipt'])) {
1520 $params['receipt_date'] = $now;
1523 $params['receipt_date'] = NULL;
1526 $this->set('params', $this->_params
);
1527 $this->assign('trxn_id', CRM_Utils_Array
::value('trxn_id', $result));
1528 $this->assign('receive_date',
1529 CRM_Utils_Date
::mysqlToIso($params['receive_date'])
1532 // required for creating membership for related contacts
1533 $params['action'] = $this->_action
;
1535 //create membership record.
1537 foreach ($this->_memTypeSelected
as $memType) {
1539 ($relateContribution = CRM_Member_BAO_Membership
::getMembershipContributionId($membership->id
))
1541 $membershipTypeValues[$memType]['relate_contribution_id'] = $relateContribution;
1544 $membershipParams = array_merge($membershipTypeValues[$memType], $params);
1545 $membership = CRM_Member_BAO_Membership
::create($membershipParams, $ids);
1547 $this->_membershipIDs
[] = $membership->id
;
1548 $createdMemberships[$memType] = $membership;
1554 $params['action'] = $this->_action
;
1555 if ($this->_onlinePendingContributionId
&& !empty($formValues['record_contribution'])) {
1557 // update membership as well as contribution object, CRM-4395
1558 $params['contribution_id'] = $this->_onlinePendingContributionId
;
1559 $params['componentId'] = $params['id'];
1560 $params['componentName'] = 'contribute';
1561 $result = CRM_Contribute_BAO_Contribution
::transitionComponents($params, TRUE);
1562 if (!empty($result) && !empty($params['contribution_id'])) {
1563 $lineItem = array();
1564 $lineItems = CRM_Price_BAO_LineItem
::getLineItems($params['contribution_id'], 'contribution');
1565 $itemId = key($lineItems);
1566 $priceSetId = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceField', $lineItems[$itemId]['price_field_id'], 'price_set_id');
1568 if ($itemId && !empty($lineItems[$itemId]['price_field_id'])) {
1569 $fieldType = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceField', $lineItems[$itemId]['price_field_id'], 'html_type');
1571 $lineItems[$itemId]['unit_price'] = $params['total_amount'];
1572 $lineItems[$itemId]['line_total'] = $params['total_amount'];
1573 $lineItems[$itemId]['id'] = $itemId;
1574 $lineItem[$priceSetId] = $lineItems;
1575 $contributionBAO = new CRM_Contribute_BAO_Contribution();
1576 $contributionBAO->id
= $params['contribution_id'];
1577 $contributionBAO->find();
1578 CRM_Price_BAO_LineItem
::processPriceSet($params['contribution_id'], $lineItem, $contributionBAO, 'civicrm_membership');
1580 //create new soft-credit record, CRM-13981
1581 $softParams['contribution_id'] = $params['contribution_id'];
1583 while ($contributionBAO->fetch()) {
1584 $softParams['currency'] = $contributionBAO->currency
;
1585 $softParams['amount'] = $contributionBAO->total_amount
;
1587 CRM_Contribute_BAO_ContributionSoft
::add($softParams);
1590 //carry updated membership object.
1591 $membership = new CRM_Member_DAO_Membership();
1592 $membership->id
= $this->_id
;
1593 $membership->find(TRUE);
1596 if ($membership->end_date
) {
1597 //display end date w/ status message.
1598 $endDate = $membership->end_date
;
1600 $membershipStatues = CRM_Member_PseudoConstant
::membershipStatus();
1601 if (!in_array($membership->status_id
, array(
1602 array_search('Cancelled', $membershipStatues),
1603 array_search('Expired', $membershipStatues),
1609 // suppress form values in template.
1610 $this->assign('cancelled', $cancelled);
1612 // FIX ME: need to recheck this
1613 // here we might updated dates, so get from object.
1614 foreach ($calcDates[$membership->membership_type_id
] as $date => & $val) {
1615 if ($membership->$date) {
1616 $val = $membership->$date;
1620 $createdMemberships[] = $membership;
1624 foreach ($this->_memTypeSelected
as $memType) {
1625 if ($count && !empty($formValues['record_contribution']) &&
1626 ($relateContribution = CRM_Member_BAO_Membership
::getMembershipContributionId($membership->id
))
1628 $membershipTypeValues[$memType]['relate_contribution_id'] = $relateContribution;
1631 $membershipParams = array_merge($params, $membershipTypeValues[$memType]);
1632 if (!empty($formValues['int_amount'])) {
1633 $init_amount = array();
1634 foreach ($formValues as $key => $value) {
1635 if (strstr($key, 'txt-price')) {
1636 $init_amount[$key] = $value;
1639 $membershipParams['init_amount'] = $init_amount;
1642 if (!empty($softParams)) {
1643 $membershipParams['soft_credit'] = $softParams;
1646 $membership = CRM_Member_BAO_Membership
::create($membershipParams, $ids);
1648 $this->_membershipIDs
[] = $membership->id
;
1649 $createdMemberships[$memType] = $membership;
1655 if (!empty($lineItem[$priceSetId])) {
1656 $invoiceSettings = CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::CONTRIBUTE_PREFERENCES_NAME
,'contribution_invoice_settings');
1657 $invoicing = CRM_Utils_Array
::value('invoicing', $invoiceSettings);
1659 $totalTaxAmount = 0;
1660 foreach ($lineItem[$priceSetId] as & $priceFieldOp) {
1661 if (!empty($priceFieldOp['membership_type_id'])) {
1662 $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') : '-';
1664 $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') : '-';
1667 $priceFieldOp['start_date'] = $priceFieldOp['end_date'] = 'N/A';
1669 if ($invoicing && isset($priceFieldOp['tax_amount'])) {
1671 $totalTaxAmount +
= $priceFieldOp['tax_amount'];
1675 $dataArray = array();
1676 foreach ($lineItem[$priceSetId] as $key => $value) {
1677 if (isset($value['tax_amount']) && isset($value['tax_rate'])) {
1678 if (isset($dataArray[$value['tax_rate']])) {
1679 $dataArray[$value['tax_rate']] = $dataArray[$value['tax_rate']] + CRM_Utils_Array
::value('tax_amount', $value);
1681 $dataArray[$value['tax_rate']] = CRM_Utils_Array
::value('tax_amount', $value);
1686 $this->assign('totalTaxAmount', $totalTaxAmount);
1687 $this->assign('taxTerm', CRM_Utils_Array
::value('tax_term', $invoiceSettings));
1689 $this->assign('dataArray', $dataArray);
1692 $this->assign('lineItem', !empty($lineItem) && !$isQuickConfig ?
$lineItem : FALSE);
1694 $receiptSend = FALSE;
1695 if (!empty($formValues['send_receipt'])) {
1696 $receiptSend = TRUE;
1698 $formValues['contact_id'] = $this->_contactID
;
1700 $formValues['contribution_id'] = CRM_Member_BAO_Membership
::getMembershipContributionId($membership->id
);
1701 // send email receipt
1702 $mailSend = self
::emailReceipt($this, $formValues, $membership);
1705 if (($this->_action
& CRM_Core_Action
::UPDATE
)) {
1706 //end date can be modified by hooks, so if end date is set then use it.
1707 $endDate = ($membership->end_date
) ?
$membership->end_date
: $endDate;
1709 $statusMsg = ts('Membership for %1 has been updated.', array(1 => $this->_memberDisplayName
));
1710 if ($endDate && $endDate !== 'null') {
1711 $endDate = CRM_Utils_Date
::customFormat($endDate);
1712 $statusMsg .= ' ' . ts('The membership End Date is %1.', array(1 => $endDate));
1715 $statusMsg .= ' ' . ts('A confirmation and receipt has been sent to %1.', array(1 => $this->_contributorEmail
));
1718 elseif (($this->_action
& CRM_Core_Action
::ADD
)) {
1719 // FIX ME: fix status messages
1721 $statusMsg = array();
1722 foreach ($membershipTypes as $memType => $membershipType) {
1723 $statusMsg[$memType] = ts('%1 membership for %2 has been added.', array(
1724 1 => $membershipType,
1725 2 => $this->_memberDisplayName
1728 $membership = $createdMemberships[$memType];
1729 $memEndDate = ($membership->end_date
) ?
$membership->end_date
: $endDate;
1731 //get the end date from calculated dates.
1732 if (!$memEndDate && empty($params['is_recur'])) {
1733 $memEndDate = CRM_Utils_Array
::value('end_date', $calcDates[$memType]);
1736 if ($memEndDate && $memEndDate !== 'null') {
1737 $memEndDate = CRM_Utils_Date
::customFormat($memEndDate);
1738 $statusMsg[$memType] .= ' ' . ts('The new membership End Date is %1.', array(1 => $memEndDate));
1741 $statusMsg = implode('<br/>', $statusMsg);
1742 if ($receiptSend && $mailSend) {
1743 $statusMsg .= ' ' . ts('A membership confirmation and receipt has been sent to %1.', array(1 => $this->_contributorEmail
));
1747 // finally set membership id if already not set
1749 $this->_id
= $membership->id
;
1752 CRM_Core_Session
::setStatus($statusMsg, ts('Complete'), 'success');
1754 $buttonName = $this->controller
->getButtonName();
1755 if ($this->_context
== 'standalone') {
1756 if ($buttonName == $this->getButtonName('upload', 'new')) {
1757 $session->replaceUserContext(CRM_Utils_System
::url('civicrm/member/add',
1758 'reset=1&action=add&context=standalone'
1762 $session->replaceUserContext(CRM_Utils_System
::url('civicrm/contact/view',
1763 "reset=1&cid={$this->_contactID}&selectedChild=member"
1767 elseif ($buttonName == $this->getButtonName('upload', 'new')) {
1768 $session->replaceUserContext(CRM_Utils_System
::url('civicrm/contact/view/membership',
1769 "reset=1&action=add&context=membership&cid={$this->_contactID}"
1775 * Function to send email receipt
1777 * @param object $form form object
1778 * @param $formValues
1779 * @param object $membership object
1781 * @internal param array $values submitted values
1782 * @return boolean true if mail was sent successfully
1785 static function emailReceipt(&$form, &$formValues, &$membership) {
1786 // retrieve 'from email id' for acknowledgement
1787 $receiptFrom = $formValues['from_email_address'];
1789 if (!empty($formValues['payment_instrument_id'])) {
1790 $paymentInstrument = CRM_Contribute_PseudoConstant
::paymentInstrument();
1791 $formValues['paidBy'] = $paymentInstrument[$formValues['payment_instrument_id']];
1794 // retrieve custom data
1795 $customFields = $customValues = array();
1796 if (property_exists($form, '_groupTree')
1797 && !empty($form->_groupTree
)
1799 foreach ($form->_groupTree
as $groupID => $group) {
1800 if ($groupID == 'info') {
1803 foreach ($group['fields'] as $k => $field) {
1804 $field['title'] = $field['label'];
1805 $customFields["custom_{$k}"] = $field;
1810 $members = array(array('member_id', '=', $membership->id
, 0, 0));
1811 // check whether its a test drive
1812 if ($form->_mode
== 'test') {
1813 $members[] = array('member_test', '=', 1, 0, 0);
1816 CRM_Core_BAO_UFGroup
::getValues($formValues['contact_id'], $customFields, $customValues, FALSE, $members);
1819 if (!empty($form->_params
['billing_first_name'])) {
1820 $name = $form->_params
['billing_first_name'];
1823 if (!empty($form->_params
['billing_middle_name'])) {
1824 $name .= " {$form->_params['billing_middle_name']}";
1827 if (!empty($form->_params
['billing_last_name'])) {
1828 $name .= " {$form->_params['billing_last_name']}";
1831 $form->assign('billingName', $name);
1833 // assign the address formatted up for display
1834 $addressParts = array(
1835 "street_address-{$form->_bltID}",
1836 "city-{$form->_bltID}",
1837 "postal_code-{$form->_bltID}",
1838 "state_province-{$form->_bltID}",
1839 "country-{$form->_bltID}",
1841 $addressFields = array();
1842 foreach ($addressParts as $part) {
1843 list($n, $id) = explode('-', $part);
1844 if (isset($form->_params
['billing_' . $part])) {
1845 $addressFields[$n] = $form->_params
['billing_' . $part];
1848 $form->assign('address', CRM_Utils_Address
::format($addressFields));
1850 $date = CRM_Utils_Date
::format($form->_params
['credit_card_exp_date']);
1851 $date = CRM_Utils_Date
::mysqlToIso($date);
1852 $form->assign('credit_card_exp_date', $date);
1853 $form->assign('credit_card_number',
1854 CRM_Utils_System
::mungeCreditCard($form->_params
['credit_card_number'])
1856 $form->assign('credit_card_type', $form->_params
['credit_card_type']);
1857 $form->assign('contributeMode', 'direct');
1858 $form->assign('isAmountzero', 0);
1859 $form->assign('is_pay_later', 0);
1860 $form->assign('isPrimary', 1);
1863 $form->assign('module', 'Membership');
1864 $form->assign('contactID', $formValues['contact_id']);
1866 $form->assign('membershipID', CRM_Utils_Array
::value('membership_id', $form->_params
, CRM_Utils_Array
::value('membership_id', $form->_defaultValues
)));
1868 if (!empty($formValues['contribution_id'])) {
1869 $form->assign('contributionID', $formValues['contribution_id']);
1871 elseif (isset($form->_onlinePendingContributionId
)) {
1872 $form->assign('contributionID', $form->_onlinePendingContributionId
);
1875 if (!empty($formValues['contribution_status_id'])) {
1876 $form->assign('contributionStatusID', $formValues['contribution_status_id']);
1877 $form->assign('contributionStatus', CRM_Contribute_PseudoConstant
::contributionStatus($formValues['contribution_status_id'], 'name'));
1880 if (!empty($formValues['is_renew'])) {
1881 $form->assign('receiptType', 'membership renewal');
1884 $form->assign('receiptType', 'membership signup');
1886 $form->assign('receive_date', CRM_Utils_Date
::processDate(CRM_Utils_Array
::value('receive_date', $formValues)));
1887 $form->assign('formValues', $formValues);
1889 if (empty($lineItem)) {
1890 $form->assign('mem_start_date', CRM_Utils_Date
::customFormat($membership->start_date
, '%B %E%f, %Y'));
1891 $form->assign('mem_end_date', CRM_Utils_Date
::customFormat($membership->end_date
, '%B %E%f, %Y'));
1892 $form->assign('membership_name', CRM_Member_PseudoConstant
::membershipType($membership->membership_type_id
));
1895 $form->assign('customValues', $customValues);
1896 $isBatchProcess = is_a($form, 'CRM_Batch_Form_Entry');
1897 if ((empty($form->_contributorDisplayName
) ||
empty($form->_contributorEmail
)) ||
$isBatchProcess) {
1898 // in this case the form is being called statically from the batch editing screen
1899 // having one class in the form layer call another statically is not greate
1900 // & we should aim to move this function to the BAO layer in future.
1901 // however, we can assume that the contact_id passed in by the batch
1902 // function will be the recipient
1904 $form->_contributorDisplayName
,
1905 $form->_contributorEmail
1906 ) = CRM_Contact_BAO_Contact_Location
::getEmailDetails(
1907 $formValues['contact_id']
1909 if (empty($form->_receiptContactId
) ||
$isBatchProcess) {
1910 $form->_receiptContactId
= $formValues['contact_id'];
1913 $template = CRM_Core_Smarty
::singleton( );
1914 $taxAmt = $template->get_template_vars('dataArray');
1915 $eventTaxAmt = $template->get_template_vars('totalTaxAmount');
1916 $prefixValue = CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::CONTRIBUTE_PREFERENCES_NAME
, 'contribution_invoice_settings');
1917 $invoicing = CRM_Utils_Array
::value('invoicing', $prefixValue);
1918 if ((count($taxAmt) > 0 ||
!empty($eventTaxAmt)) && (isset($invoicing) && isset($prefixValue['is_email_pdf']))) {
1922 $isEmailPdf = False;
1925 list($mailSend, $subject, $message, $html) = CRM_Core_BAO_MessageTemplate
::sendTemplate(
1927 'groupName' => 'msg_tpl_workflow_membership',
1928 'valueName' => 'membership_offline_receipt',
1929 'contactId' => $form->_receiptContactId
,
1930 'from' => $receiptFrom,
1931 'toName' => $form->_contributorDisplayName
,
1932 'toEmail' => $form->_contributorEmail
,
1933 'PDFFilename' => ts('receipt').'.pdf',
1934 'isEmailPdf' => $isEmailPdf,
1935 'contributionId' => $formValues['contribution_id'],
1936 'isTest' => (bool) ($form->_action
& CRM_Core_Action
::PREVIEW
)