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 if (!empty($defaults['record_contribution']) && !$this->_mode
) {
364 $contributionParams = array('id' => $defaults['record_contribution']);
365 $contributionIds = array();
367 //keep main object campaign in hand.
368 $memberCampaignId = CRM_Utils_Array
::value('campaign_id', $defaults);
370 CRM_Contribute_BAO_Contribution
::getValues($contributionParams, $defaults, $contributionIds);
372 //get back original object campaign id.
373 $defaults['campaign_id'] = $memberCampaignId;
375 if (!empty($defaults['receive_date'])) {
376 list($defaults['receive_date']) = CRM_Utils_Date
::setDateDefaults($defaults['receive_date']);
379 // Contribution::getValues() over-writes the membership record's source field value - so we need to restore it.
380 if (!empty($defaults['membership_source'])) {
381 $defaults['source'] = $defaults['membership_source'];
385 if (empty($defaults['payment_instrument_id'])) {
386 $defaults['payment_instrument_id'] = key(CRM_Core_OptionGroup
::values('payment_instrument', FALSE, FALSE, FALSE, 'AND is_default = 1'));
389 // User must explicitly choose to send a receipt in both add and update mode.
390 $defaults['send_receipt'] = 0;
392 if ($this->_action
& CRM_Core_Action
::UPDATE
) {
393 // in this mode by default uncheck this checkbox
394 unset($defaults['record_contribution']);
397 if (!empty($defaults['id'])) {
398 $subscriptionCancelled = CRM_Member_BAO_Membership
::isSubscriptionCancelled($this->_id
);
401 $alreadyAutoRenew = FALSE;
402 if (!empty($defaults['contribution_recur_id']) && !$subscriptionCancelled) {
403 $defaults['auto_renew'] = 1;
404 $alreadyAutoRenew = TRUE;
406 $this->assign('alreadyAutoRenew', $alreadyAutoRenew);
408 $this->assign('member_is_test', CRM_Utils_Array
::value('member_is_test', $defaults));
410 $this->assign('membership_status_id', CRM_Utils_Array
::value('status_id', $defaults));
412 if (!empty($defaults['is_pay_later'])) {
413 $this->assign('is_pay_later', TRUE);
416 // set default country from config if no country set
417 $config = CRM_Core_Config
::singleton();
418 if (empty($defaults["billing_country_id-{$this->_bltID}"])) {
419 $defaults["billing_country_id-{$this->_bltID}"] = $config->defaultContactCountry
;
422 if (empty($defaults["billing_state_province_id-{$this->_bltID}"])) {
423 $defaults["billing_state_province_id-{$this->_bltID}"] = $config->defaultContactStateProvince
;
426 $billingDefaults = $this->getProfileDefaults('Billing', $this->_contactID
);
427 $defaults = array_merge($defaults, $billingDefaults);
429 // now fix all state country selectors, set correct state based on country
430 CRM_Core_BAO_Address
::fixAllStateSelects($this, $defaults);
432 // // hack to simplify credit card entry for testing
433 // $defaults['credit_card_type'] = 'Visa';
434 // $defaults['credit_card_number'] = '4807731747657838';
435 // $defaults['cvv2'] = '000';
436 // $defaults['credit_card_exp_date'] = array( 'Y' => '2012', 'M' => '05' );
439 $dates = array('join_date', 'start_date', 'end_date');
440 foreach ($dates as $key) {
441 if (!empty($defaults[$key])) {
442 list($defaults[$key]) = CRM_Utils_Date
::setDateDefaults(CRM_Utils_Array
::value($key, $defaults));
446 //setting default join date if there is no join date
447 if (empty($defaults['join_date'])) {
448 $defaults['join_date'] = $now;
451 if (!empty($defaults['membership_end_date'])) {
452 $this->assign('endDate', $defaults['membership_end_date']);
459 * Function to build the form
464 public function buildQuickForm() {
465 if ($this->_cdType
) {
466 return CRM_Custom_Form_CustomData
::buildQuickForm($this);
469 // build price set form.
470 $buildPriceSet = FALSE;
471 if ($this->_priceSetId ||
!empty($_POST['price_set_id'])) {
472 if (!empty($_POST['price_set_id'])) {
473 $buildPriceSet = TRUE;
475 $getOnlyPriceSetElements = TRUE;
476 if (!$this->_priceSetId
) {
477 $this->_priceSetId
= $_POST['price_set_id'];
478 $getOnlyPriceSetElements = FALSE;
481 $this->set('priceSetId', $this->_priceSetId
);
482 CRM_Price_BAO_PriceSet
::buildPriceSet($this);
484 $optionsMembershipTypes = array();
485 foreach ($this->_priceSet
['fields'] as $pField) {
486 if (empty($pField['options'])) {
489 foreach ($pField['options'] as $opId => $opValues) {
490 $optionsMembershipTypes[$opId] = CRM_Utils_Array
::value('membership_type_id', $opValues, 0);
494 $this->assign('autoRenewOption', CRM_Price_BAO_PriceSet
::checkAutoRenewForPriceSet($this->_priceSetId
));
496 $this->assign('optionsMembershipTypes', $optionsMembershipTypes);
497 $this->assign('contributionType', CRM_Utils_Array
::value('financial_type_id', $this->_priceSet
));
499 // get only price set form elements.
500 if ($getOnlyPriceSetElements) {
505 // use to build form during form rule.
506 $this->assign('buildPriceSet', $buildPriceSet);
508 if ($this->_action
& CRM_Core_Action
::ADD
) {
509 $buildPriceSet = FALSE;
510 $priceSets = CRM_Price_BAO_PriceSet
::getAssoc(FALSE, 'CiviMember');
511 if (!empty($priceSets)) {
512 $buildPriceSet = TRUE;
515 if ($buildPriceSet) {
516 $this->add('select', 'price_set_id', ts('Choose price set'),
518 '' => ts('Choose price set')
520 NULL, array('onchange' => "buildAmount( this.value );")
523 $this->assign('hasPriceSets', $buildPriceSet);
526 //need to assign custom data type and subtype to the template
527 $this->assign('customDataType', 'Membership');
528 $this->assign('customDataSubType', $this->_memType
);
529 $this->assign('entityID', $this->_id
);
531 if ($this->_action
& CRM_Core_Action
::DELETE
) {
532 $this->addButtons(array(
535 'name' => ts('Delete'),
536 'spacing' => ' ',
541 'name' => ts('Cancel'),
548 if ($this->_context
== 'standalone') {
549 $this->addEntityRef('contact_id', ts('Contact'), array('create' => TRUE), TRUE);
552 $selOrgMemType[0][0] = $selMemTypeOrg[0] = ts('- select -');
554 $dao = new CRM_Member_DAO_MembershipType();
555 $dao->domain_id
= CRM_Core_Config
::domainID();
558 // retrieve all memberships
559 $allMemberships = CRM_Member_BAO_Membership
::buildMembershipTypeValues($this);
561 $allMembershipInfo = $membershipType = array();
562 foreach ($allMemberships as $key => $values) {
563 if (!empty($values['is_active'])) {
564 $membershipType[$key] = CRM_Utils_Array
::value('name', $values);
565 if ($this->_mode
&& empty($values['minimum_fee'])) {
569 $memberOfContactId = CRM_Utils_Array
::value('member_of_contact_id', $values);
570 if (empty($selMemTypeOrg[$memberOfContactId])) {
571 $selMemTypeOrg[$memberOfContactId] = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact',
577 $selOrgMemType[$memberOfContactId][0] = ts('- select -');
579 if (empty($selOrgMemType[$memberOfContactId][$key])) {
580 $selOrgMemType[$memberOfContactId][$key] = CRM_Utils_Array
::value('name', $values);
584 // build membership info array, which is used when membership type is selected to:
585 // - set the payment information block
586 // - set the max related block
587 $allMembershipInfo[$key] = array(
588 'financial_type_id' => CRM_Utils_Array
::value('financial_type_id', $values),
589 'total_amount' => CRM_Utils_Money
::format($values['minimum_fee'], NULL, '%a'),
590 'total_amount_numeric' => CRM_Utils_Array
::value('minimum_fee', $values),
591 'auto_renew' => CRM_Utils_Array
::value('auto_renew', $values),
592 'has_related' => isset($values['relationship_type_id']),
593 'max_related' => CRM_Utils_Array
::value('max_related', $values),
598 $this->assign('allMembershipInfo', json_encode($allMembershipInfo));
600 // show organization by default, if only one organization in
602 if (count($selMemTypeOrg) == 2) {
603 unset($selMemTypeOrg[0], $selOrgMemType[0][0]);
605 //sort membership organization and type, CRM-6099
606 natcasesort($selMemTypeOrg);
607 foreach ($selOrgMemType as $index => $orgMembershipType) {
608 natcasesort($orgMembershipType);
609 $selOrgMemType[$index] = $orgMembershipType;
612 $memTypeJs = array('onChange' => "CRM.buildCustomData( 'Membership', this.value );");
614 //build the form for auto renew.
615 $recurProcessor = $autoRenew = array();
616 if ($this->_mode ||
($this->_action
& CRM_Core_Action
::UPDATE
)) {
617 $autoRenewElement = $this->addElement('checkbox',
619 ts('Membership renewed automatically'),
621 array('onclick' => "buildReceiptANDNotice( );")
625 //get the valid recurring processors.
626 $recurring = CRM_Core_PseudoConstant
::paymentProcessor(FALSE, FALSE, 'is_recur = 1');
627 $recurProcessor = array_intersect_assoc($this->_processors
, $recurring);
628 $autoRenew = array();
629 if (!empty($recurProcessor)) {
630 if (!empty($membershipType)) {
636 FROM civicrm_membership_type
637 WHERE id IN ( ' . implode(' , ', array_keys($membershipType)) . ' )';
638 $recurMembershipTypes = CRM_Core_DAO
::executeQuery($sql);
639 while ($recurMembershipTypes->fetch()) {
640 $autoRenew[$recurMembershipTypes->id
] = $recurMembershipTypes->auto_renew
;
647 $this->_recurMembershipTypes
[$recurMembershipTypes->id
][$fld] = $recurMembershipTypes->$fld;
653 "CRM.buildCustomData( 'Membership', this.value ); buildAutoRenew(this.value, null );",
658 $allowAutoRenew = FALSE;
659 if ($this->_mode
&& !empty($recurProcessor)) {
660 $allowAutoRenew = TRUE;
662 $this->assign('allowAutoRenew', $allowAutoRenew);
663 $this->assign('autoRenewOptions', json_encode($autoRenew));
664 $this->assign('recurProcessor', json_encode($recurProcessor));
666 // for max_related: a little JS to show/hide & set default value
667 $memTypeJs['onChange'] = "buildMaxRelated(this.value,true); " . $memTypeJs['onChange'];
668 $this->add('text', 'max_related', ts('Max related'),
669 CRM_Core_DAO
::getAttribute('CRM_Member_DAO_Membership', 'max_related')
672 $sel = & $this->addElement('hierselect',
673 'membership_type_id',
674 ts('Membership Organization and Type'),
678 $sel->setOptions(array($selMemTypeOrg, $selOrgMemType));
684 $this->applyFilter('__ALL__', 'trim');
686 if ($this->_action
& CRM_Core_Action
::ADD
) {
687 $this->add('text', 'num_terms', ts('Number of Terms'), array('size' => 6));
690 $this->addDate('join_date', ts('Member Since'), FALSE, array('formatType' => 'activityDate'));
691 $this->addDate('start_date', ts('Start Date'), FALSE, array('formatType' => 'activityDate'));
692 $endDate = $this->addDate('end_date', ts('End Date'), FALSE, array('formatType' => 'activityDate'));
694 $elements[] = $endDate;
697 $this->add('text', 'source', ts('Source'),
698 CRM_Core_DAO
::getAttribute('CRM_Member_DAO_Membership', 'source')
701 //CRM-7362 --add campaigns.
704 $campaignId = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership', $this->_id
, 'campaign_id');
706 CRM_Campaign_BAO_Campaign
::addCampaign($this, $campaignId);
709 $this->add('select', 'status_id', ts('Membership Status'),
710 array('' => ts('- select -')) + CRM_Member_PseudoConstant
::membershipStatus(NULL, NULL, 'label')
712 $statusOverride = $this->addElement('checkbox', 'is_override',
713 ts('Status Override?'), NULL,
714 array('onClick' => 'showHideMemberStatus()')
716 if ($statusOverride) {
717 $elements[] = $statusOverride;
720 $this->addElement('checkbox', 'record_contribution', ts('Record Membership Payment?'));
722 $this->add('text', 'total_amount', ts('Amount'));
723 $this->addRule('total_amount', ts('Please enter a valid amount.'), 'money');
725 $this->addDate('receive_date', ts('Received'), FALSE, array('formatType' => 'activityDateTime'));
727 $this->add('select', 'payment_instrument_id',
729 array('' => ts('- select -')) + CRM_Contribute_PseudoConstant
::paymentInstrument(),
730 FALSE, array('onChange' => "return showHideByValue('payment_instrument_id','4','checkNumber','table-row','select',false);")
732 $this->add('text', 'trxn_id', ts('Transaction ID'));
733 $this->addRule('trxn_id', ts('Transaction ID already exists in Database.'),
734 'objectExists', array('CRM_Contribute_DAO_Contribution', $this->_id
, 'trxn_id')
737 $allowStatuses = array();
738 $statuses = CRM_Contribute_PseudoConstant
::contributionStatus();
739 if ($this->_onlinePendingContributionId
) {
740 $statusNames = CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name');
741 foreach ($statusNames as $val => $name) {
742 if (in_array($name, array(
749 $allowStatuses[$val] = $statuses[$val];
753 $allowStatuses = $statuses;
755 $this->add('select', 'contribution_status_id',
756 ts('Payment Status'), $allowStatuses
758 $this->add('text', 'check_number', ts('Check Number'),
759 CRM_Core_DAO
::getAttribute('CRM_Contribute_DAO_Contribution', 'check_number')
763 //add field for amount to allow an amount to be entered that differs from minimum
764 $this->add('text', 'total_amount', ts('Amount'));
766 $this->add('select', 'financial_type_id',
767 ts('Financial Type'),
768 array('' => ts('- select -')) + CRM_Contribute_PseudoConstant
::financialType()
770 if ($this->_context
!= 'standalone') {
771 //CRM-10223 - allow contribution to be recorded against different contact
772 // causes a conflict in standalone mode so skip in standalone for now
773 $this->addElement('checkbox', 'is_different_contribution_contact', ts('Record Payment from a Different Contact?'));
774 $this->addSelect('soft_credit_type_id', array('entity' => 'contribution_soft'));
775 $this->addEntityRef('soft_credit_contact_id', ts('Payment From'), array('create' => TRUE));
778 $this->addElement('checkbox',
780 ts('Send Confirmation and Receipt?'), NULL,
781 array('onclick' => "showHideByValue( 'send_receipt', '', 'notice', 'table-row', 'radio', false); showHideByValue( 'send_receipt', '', 'fromEmail', 'table-row', 'radio', false);")
784 $this->add('select', 'from_email_address', ts('Receipt From'), $this->_fromEmails
);
786 $this->add('textarea', 'receipt_text_signup', ts('Receipt Message'));
789 $this->add('select', 'payment_processor_id',
790 ts('Payment Processor'),
791 $this->_processors
, TRUE,
792 array('onChange' => "buildAutoRenew( null, this.value );")
794 CRM_Core_Payment_Form
::buildCreditCard($this, TRUE);
797 // Retrieve the name and email of the contact - this will be the TO for receipt email
798 if ($this->_contactID
) {
799 list($this->_memberDisplayName
,
801 ) = CRM_Contact_BAO_Contact_Location
::getEmailDetails($this->_contactID
);
803 $this->assign('emailExists', $this->_memberEmail
);
804 $this->assign('displayName', $this->_memberDisplayName
);
808 if ($this->_action
& CRM_Core_Action
::UPDATE
) {
809 $recurContributionId = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership', $this->_id
,
810 'contribution_recur_id'
812 if ($recurContributionId && !CRM_Member_BAO_Membership
::isSubscriptionCancelled($this->_id
)) {
814 if (CRM_Member_BAO_Membership
::isCancelSubscriptionSupported($this->_id
)) {
815 $this->assign('cancelAutoRenew',
816 CRM_Utils_System
::url('civicrm/contribute/unsubscribe', "reset=1&mid={$this->_id}")
819 foreach ($elements as $elem) {
824 $this->assign('isRecur', $isRecur);
826 $this->addFormRule(array('CRM_Member_Form_Membership', 'formRule'), $this);
828 $mailingInfo = CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::MAILING_PREFERENCES_NAME
,
831 $this->assign('outBound_option', $mailingInfo['outBound_option']);
833 parent
::buildQuickForm();
837 * Function for validation
839 * @param array $params (ref.) an assoc array of name/value pairs
841 * @return mixed true or array of errors
845 static function formRule($params, $files, $self) {
848 $priceSetId = CRM_Utils_Array
::value('price_set_id', $params);
851 CRM_Price_BAO_PriceField
::priceSetValidation($priceSetId, $params, $errors);
853 $priceFieldIDS = array();
854 foreach ($self->_priceSet
['fields'] as $priceIds => $dontCare) {
856 if (!empty($params['price_' . $priceIds])) {
857 if (is_array($params['price_' . $priceIds])) {
858 foreach ($params['price_' . $priceIds] as $priceFldVal => $isSet) {
860 $priceFieldIDS[] = $priceFldVal;
865 $priceFieldIDS[] = $params['price_' . $priceIds];
870 if (!empty($priceFieldIDS)) {
871 $ids = implode(',', $priceFieldIDS);
873 $count = CRM_Price_BAO_PriceSet
::getMembershipCount($ids);
874 foreach ($count as $id => $occurance) {
875 if ($occurance > 1) {
876 $errors['_qf_default'] = ts('Select at most one option associated with the same membership type.');
880 foreach ($priceFieldIDS as $priceFieldId) {
881 if ($id = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceFieldValue', $priceFieldId, 'membership_type_id')) {
882 $self->_memTypeSelected
[$id] = $id;
887 elseif (empty($params['membership_type_id'][1])) {
888 $errors['membership_type_id'] = ts('Please select a membership type.');
891 $self->_memTypeSelected
[] = $params['membership_type_id'][1];
895 $numterms = CRM_Utils_Array
::value('num_terms', $params);
896 if ($numterms && intval($numterms) != $numterms) {
897 $errors['num_terms'] = ts('Please enter an integer for the number of terms.');
901 // Return error if empty $self->_memTypeSelected
902 if ($priceSetId && empty($errors) && empty($self->_memTypeSelected
)) {
903 $errors['_qf_default'] = ts('Select at least one membership option.');
906 if (!empty($errors) && (count($self->_memTypeSelected
) > 1)) {
907 $memberOfContacts = CRM_Member_BAO_MembershipType
::getMemberOfContactByMemTypes($self->_memTypeSelected
);
908 $duplicateMemberOfContacts = array_count_values($memberOfContacts);
909 foreach ($duplicateMemberOfContacts as $countDuplicate) {
910 if ($countDuplicate > 1) {
911 $errors['_qf_default'] = ts('Please do not select more than one membership associated with the same organization.');
916 if (!empty($errors)) {
920 if ($priceSetId && !$self->_mode
&& empty($params['record_contribution'])) {
921 $errors['record_contribution'] = ts('Record Membership Payment is required when you using price set.');
924 if (!$priceSetId && $self->_mode
&& empty($params['financial_type_id'])) {
925 $errors['financial_type_id'] = ts('Please enter the financial Type.');
928 if (!empty($params['record_contribution']) && empty($params['payment_instrument_id'])) {
929 $errors['payment_instrument_id'] = ts('Paid By is a required field.');
932 if (!empty($params['is_different_contribution_contact'])) {
933 if (empty($params['soft_credit_type_id'])) {
934 $errors['soft_credit_type_id'] = ts('Please Select a Soft Credit Type');
936 if (empty($params['contribution_contact'][1])) {
937 $errors['contribution_contact[1]'] = ts('Please select a contact');
941 if (!empty($params['payment_processor_id'])) {
942 // make sure that credit card number and cvv are valid
943 CRM_Core_Payment_Form
::validateCreditCard($params, $errors);
947 if (!empty($params['join_date'])) {
949 $joinDate = CRM_Utils_Date
::processDate($params['join_date']);
951 foreach ($self->_memTypeSelected
as $memType) {
953 if (!empty($params['start_date'])) {
954 $startDate = CRM_Utils_Date
::processDate($params['start_date']);
957 // if end date is set, ensure that start date is also set
958 // and that end date is later than start date
960 if (!empty($params['end_date'])) {
961 $endDate = CRM_Utils_Date
::processDate($params['end_date']);
964 $membershipDetails = CRM_Member_BAO_MembershipType
::getMembershipTypeDetails($memType);
966 if ($startDate && CRM_Utils_Array
::value('period_type', $membershipDetails) == 'rolling') {
967 if ($startDate < $joinDate) {
968 $errors['start_date'] = ts('Start date must be the same or later than Member since.');
973 if ($membershipDetails['duration_unit'] == 'lifetime') {
974 // Check if status is NOT cancelled or similar. For lifetime memberships, there is no automated
975 // process to update status based on end-date. The user must change the status now.
976 $result = civicrm_api3('MembershipStatus', 'get', array(
978 'is_current_member' => 0,
980 $tmp_statuses = $result['values'];
981 $status_ids = array();
982 foreach($tmp_statuses as $cur_stat) {
983 $status_ids[] = $cur_stat['id'];
985 if (empty($params['status_id']) ||
in_array( $params['status_id'] , $status_ids) == false) {
986 $errors['status_id'] = ts('Please enter a status that does NOT represent a current membership status.');
987 $errors['is_override'] = ts('This must be checked because you set an End Date for a lifetime membership');
992 $errors['start_date'] = ts('Start date must be set if end date is set.');
994 if ($endDate < $startDate) {
995 $errors['end_date'] = ts('End date must be the same or later than start date.');
1000 // Default values for start and end dates if not supplied
1002 $defaultDates = CRM_Member_BAO_MembershipType
::getDatesForMembershipType($memType,
1009 $startDate = CRM_Utils_Array
::value('start_date',
1014 $endDate = CRM_Utils_Array
::value('end_date',
1019 //CRM-3724, check for availability of valid membership status.
1020 if (empty($params['is_override']) && !isset($errors['_qf_default'])) {
1021 $calcStatus = CRM_Member_BAO_MembershipStatus
::getMembershipStatusByDate($startDate,
1029 if (empty($calcStatus)) {
1030 $url = CRM_Utils_System
::url('civicrm/admin/member/membershipStatus', 'reset=1&action=browse');
1031 $errors['_qf_default'] = ts('There is no valid Membership Status available for selected membership dates.');
1032 $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));
1033 if (!$self->_mode
) {
1034 $status .= ' ' . ts('OR You can sign up by setting Status Override? to true.');
1036 CRM_Core_Session
::setStatus($status, ts('Membership Status Error'), 'error');
1042 $errors['join_date'] = ts('Please enter the Member Since.');
1045 if (isset($params['is_override']) &&
1046 $params['is_override'] && empty($params['status_id'])) {
1047 $errors['status_id'] = ts('Please enter the status.');
1050 //total amount condition arise when membership type having no
1052 if (isset($params['record_contribution'])) {
1053 if (!$params['financial_type_id']) {
1054 $errors['financial_type_id'] = ts('Please enter the financial Type.');
1056 if (CRM_Utils_System
::isNull($params['total_amount'])) {
1057 $errors['total_amount'] = ts('Please enter the contribution.');
1061 // validate contribution status for 'Failed'.
1062 if ($self->_onlinePendingContributionId
&& !empty($params['record_contribution']) &&
1063 (CRM_Utils_Array
::value('contribution_status_id', $params) ==
1064 array_search('Failed', CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name'))
1067 $errors['contribution_status_id'] = ts('Please select a valid payment status before updating.');
1070 return empty($errors) ?
TRUE : $errors;
1074 * Function to process the form
1080 public function postProcess() {
1081 if ($this->_action
& CRM_Core_Action
::DELETE
) {
1082 CRM_Member_BAO_Membership
::del($this->_id
);
1086 $config = CRM_Core_Config
::singleton();
1087 // get the submitted form values.
1088 $this->_params
= $formValues = $this->controller
->exportValues($this->_name
);
1089 $this->convertDateFieldsToMySQL($formValues);
1091 $params = $softParams = $ids = array();
1093 $membershipTypeValues = array();
1094 foreach ($this->_memTypeSelected
as $memType) {
1095 $membershipTypeValues[$memType]['membership_type_id'] = $memType;
1098 //take the required membership recur values.
1099 if ($this->_mode
&& !empty($this->_params
['auto_renew'])) {
1100 $params['is_recur'] = $this->_params
['is_recur'] = $formValues['is_recur'] = TRUE;
1102 'frequency_interval' => 'duration_interval',
1103 'frequency_unit' => 'duration_unit',
1107 foreach ($this->_memTypeSelected
as $memType) {
1108 $recurMembershipTypeValues = CRM_Utils_Array
::value($memType,
1109 $this->_recurMembershipTypes
, array()
1111 foreach ($mapping as $mapVal => $mapParam) {
1112 $membershipTypeValues[$memType][$mapVal] = CRM_Utils_Array
::value($mapParam,
1113 $recurMembershipTypeValues
1116 $this->_params
[$mapVal] = $formValues[$mapVal] = CRM_Utils_Array
::value($mapParam,
1117 $recurMembershipTypeValues
1124 // unset send-receipt option, since receipt will be sent when ipn is received.
1125 unset($this->_params
['send_receipt'], $formValues['send_receipt']);
1128 // process price set and get total amount and line items.
1129 $lineItem = array();
1131 if (!$priceSetId = CRM_Utils_Array
::value('price_set_id', $formValues)) {
1132 CRM_Member_BAO_Membership
::createLineItems($this, $formValues['membership_type_id'], $priceSetId);
1135 if ($this->_priceSetId
&& CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet', $this->_priceSetId
, 'is_quick_config')) {
1139 $termsByType = array();
1141 CRM_Price_BAO_PriceSet
::processAmount($this->_priceSet
['fields'],
1142 $this->_params
, $lineItem[$priceSetId]);
1143 $params['total_amount'] = CRM_Utils_Array
::value('amount', $this->_params
);
1144 $submittedFinancialType = CRM_Utils_Array
::value('financial_type_id', $formValues);
1145 if (!empty($lineItem[$priceSetId])) {
1146 foreach ($lineItem[$priceSetId] as &$li) {
1147 if (!empty($li['membership_type_id'])) {
1148 if (!empty($li['membership_num_terms'])) {
1149 $termsByType[$li['membership_type_id']] = $li['membership_num_terms'];
1153 ///CRM-11529 for quick config backoffice transactions
1154 //when financial_type_id is passed in form, update the
1155 //lineitems with the financial type selected in form
1156 if ($isQuickConfig && $submittedFinancialType) {
1157 $li['financial_type_id'] = $submittedFinancialType;
1163 $this->storeContactFields($formValues);
1165 $params['contact_id'] = $this->_contactID
;
1174 foreach ($fields as $f) {
1175 $params[$f] = CRM_Utils_Array
::value($f, $formValues);
1179 // when is_override false ignore is_admin statuses during membership
1180 // status calculation. similarly we did fix for import in CRM-3570.
1181 if (empty($params['is_override'])) {
1182 $params['exclude_is_admin'] = TRUE;
1185 // process date params to mysql date format.
1187 'join_date' => 'joinDate',
1188 'start_date' => 'startDate',
1189 'end_date' => 'endDate',
1191 foreach ($dateTypes as $dateField => $dateVariable) {
1192 $
$dateVariable = CRM_Utils_Date
::processDate($formValues[$dateField]);
1195 $memTypeNumTerms = CRM_Utils_Array
::value('num_terms', $formValues);
1197 $calcDates = array();
1198 foreach ($this->_memTypeSelected
as $memType) {
1199 if (empty($memTypeNumTerms)) {
1200 $memTypeNumTerms = CRM_Utils_Array
::value($memType, $termsByType, 1);
1202 $calcDates[$memType] = CRM_Member_BAO_MembershipType
::getDatesForMembershipType($memType,
1203 $joinDate, $startDate, $endDate, $memTypeNumTerms
1207 foreach ($calcDates as $memType => $calcDate) {
1208 foreach (array_keys($dateTypes) as $d) {
1209 //first give priority to form values then calDates.
1210 $date = CRM_Utils_Array
::value($d, $formValues);
1212 $date = CRM_Utils_Array
::value($d, $calcDate);
1215 $membershipTypeValues[$memType][$d] = CRM_Utils_Date
::processDate($date);
1216 //$params[$d] = CRM_Utils_Date::processDate( $date );
1220 // max related memberships - take from form or inherit from membership type
1221 foreach ($this->_memTypeSelected
as $memType) {
1222 if (array_key_exists('max_related', $formValues)) {
1223 $membershipTypeValues[$memType]['max_related'] = CRM_Utils_Array
::value('max_related', $formValues);
1228 $ids['membership'] = $params['id'] = $this->_id
;
1231 $session = CRM_Core_Session
::singleton();
1232 $ids['userId'] = $session->get('userID');
1234 // membership type custom data
1235 foreach ($this->_memTypeSelected
as $memType) {
1236 $customFields = CRM_Core_BAO_CustomField
::getFields('Membership', FALSE, FALSE,
1240 $customFields = CRM_Utils_Array
::crmArrayMerge($customFields,
1241 CRM_Core_BAO_CustomField
::getFields('Membership',
1247 $membershipTypeValues[$memType]['custom'] = CRM_Core_BAO_CustomField
::postProcess($formValues,
1254 foreach ($this->_memTypeSelected
as $memType) {
1255 $membershipTypes[$memType] = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType',
1260 $membershipType = implode(', ', $membershipTypes);
1262 // Retrieve the name and email of the current user - this will be the FROM for the receipt email
1263 list($userName, $userEmail) = CRM_Contact_BAO_Contact_Location
::getEmailDetails($ids['userId']);
1265 //CRM-10223 - allow contribution to be recorded against different contact
1266 if ($this->_contributorContactID
!= $this->_contactID
) {
1267 $params['contribution_contact_id'] = $this->_contributorContactID
;
1268 if (!empty($this->_params
['soft_credit_type_id'])) {
1269 $softParams['soft_credit_type_id'] = $this->_params
['soft_credit_type_id'];
1270 $softParams['contact_id'] = $params['contact_id'];
1273 if (!empty($formValues['record_contribution'])) {
1274 $recordContribution = array(
1276 'financial_type_id',
1277 'payment_instrument_id',
1279 'contribution_status_id',
1285 foreach ($recordContribution as $f) {
1286 $params[$f] = CRM_Utils_Array
::value($f, $formValues);
1289 if (!$this->_onlinePendingContributionId
) {
1290 $params['contribution_source'] = ts('%1 Membership: Offline signup (by %2)',
1291 array(1 => $membershipType, 2 => $userName)
1295 if (empty($params['is_override']) &&
1296 CRM_Utils_Array
::value('contribution_status_id', $params) == array_search('Pending', CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name'))
1298 $allStatus = CRM_Member_PseudoConstant
::membershipStatus();
1299 $params['status_id'] = array_search('Pending', $allStatus);
1300 $params['skipStatusCal'] = TRUE;
1301 $params['is_pay_later'] = 1;
1302 $this->assign('is_pay_later', 1);
1305 if (!empty($formValues['send_receipt'])) {
1306 $params['receipt_date'] = CRM_Utils_Array
::value('receive_date', $formValues);
1309 //insert financial type name in receipt.
1310 $formValues['contributionType_name'] = CRM_Core_DAO
::getFieldValue('CRM_Financial_DAO_FinancialType',
1311 $formValues['financial_type_id']
1315 // process line items, until no previous line items.
1316 if (!empty($lineItem)) {
1317 $params['lineItems'] = $lineItem;
1318 $params['processPriceSet'] = TRUE;
1320 $createdMemberships = array();
1322 if (empty($formValues['total_amount']) && !$priceSetId) {
1323 // if total amount not provided minimum for membership type is used
1324 $params['total_amount'] = $formValues['total_amount'] = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType',
1325 $formValues['membership_type_id'][1], 'minimum_fee'
1329 $params['total_amount'] = CRM_Utils_Array
::value('total_amount', $formValues, 0);
1332 if ($priceSetId && !$isQuickConfig) {
1333 $params['financial_type_id'] = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet',
1339 $params['financial_type_id'] = CRM_Utils_Array
::value('financial_type_id', $formValues);
1342 $this->_paymentProcessor
= CRM_Financial_BAO_PaymentProcessor
::getPayment($formValues['payment_processor_id'],
1346 //get the payment processor id as per mode.
1347 $params['payment_processor_id'] = $this->_params
['payment_processor_id'] = $formValues['payment_processor_id'] = $this->_paymentProcessor
['id'];
1350 $now = date('YmdHis');
1353 // set email for primary location.
1354 $fields['email-Primary'] = 1;
1355 $formValues['email-5'] = $formValues['email-Primary'] = $this->_memberEmail
;
1356 $params['register_date'] = $now;
1358 // now set the values for the billing location.
1359 foreach ($this->_fields
as $name => $dontCare) {
1363 // also add location name to the array
1364 $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);
1366 $formValues["address_name-{$this->_bltID}"] = trim($formValues["address_name-{$this->_bltID}"]);
1368 $fields["address_name-{$this->_bltID}"] = 1;
1369 //ensure we don't over-write the payer's email with the member's email
1370 if ($this->_contributorContactID
== $this->_contactID
) {
1371 $fields["email-{$this->_bltID}"] = 1;
1374 $ctype = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $this->_contactID
, 'contact_type');
1376 $nameFields = array('first_name', 'middle_name', 'last_name');
1378 foreach ($nameFields as $name) {
1380 if (array_key_exists("billing_$name", $formValues)) {
1381 $formValues[$name] = $formValues["billing_{$name}"];
1382 $formValues['preserveDBName'] = TRUE;
1385 if ($this->_contributorContactID
== $this->_contactID
) {
1386 //see CRM-12869 for discussion of why we don't do this for separate payee payments
1387 CRM_Contact_BAO_Contact
::createProfileContact($formValues, $fields,
1388 $this->_contributorContactID
, NULL, NULL, $ctype
1392 // add all the additioanl payment params we need
1393 $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}"]);
1394 $this->_params
["country-{$this->_bltID}"] = $this->_params
["billing_country-{$this->_bltID}"] = CRM_Core_PseudoConstant
::countryIsoCode($this->_params
["billing_country_id-{$this->_bltID}"]);
1396 $this->_params
['year'] = CRM_Core_Payment_Form
::getCreditCardExpirationYear($this->_params
);
1397 $this->_params
['month'] = CRM_Core_Payment_Form
::getCreditCardExpirationMonth($this->_params
);
1398 $this->_params
['ip_address'] = CRM_Utils_System
::ipAddress();
1399 $this->_params
['amount'] = $params['total_amount'];
1400 $this->_params
['currencyID'] = $config->defaultCurrency
;
1401 $this->_params
['payment_action'] = 'Sale';
1402 $this->_params
['invoiceID'] = md5(uniqid(rand(), TRUE));
1403 $this->_params
['financial_type_id'] = $params['financial_type_id'];
1405 // at this point we've created a contact and stored its address etc
1406 // all the payment processors expect the name and address to be in the
1407 // so we copy stuff over to first_name etc.
1408 $paymentParams = $this->_params
;
1409 $paymentParams['contactID'] = $this->_contributorContactID
;
1410 //CRM-10377 if payment is by an alternate contact then we need to set that person
1411 // as the contact in the payment params
1412 if ($this->_contributorContactID
!= $this->_contactID
) {
1413 if (!empty($this->_params
['soft_credit_type_id'])) {
1414 $softParams['contact_id'] = $params['contact_id'];
1415 $softParams['soft_credit_type_id'] = $this->_params
['soft_credit_type_id'];
1418 if (!empty($this->_params
['send_receipt'])) {
1419 $paymentParams['email'] = $this->_contributorEmail
;
1422 CRM_Core_Payment_Form
::mapParams($this->_bltID
, $this->_params
, $paymentParams, TRUE);
1424 // CRM-7137 -for recurring membership,
1425 // we do need contribution and recuring records.
1427 if (!empty($paymentParams['is_recur'])) {
1428 $allStatus = CRM_Member_PseudoConstant
::membershipStatus();
1430 $contributionType = new CRM_Financial_DAO_FinancialType();
1431 $contributionType->id
= $params['financial_type_id'];
1432 if (!$contributionType->find(TRUE)) {
1433 CRM_Core_Error
::fatal('Could not find a system table');
1436 $contribution = CRM_Contribute_Form_Contribution_Confirm
::processContribution($this,
1439 $this->_contributorContactID
,
1446 //create new soft-credit record, CRM-13981
1447 $softParams['contribution_id'] = $contribution->id
;
1448 $softParams['currency'] = $contribution->currency
;
1449 $softParams['amount'] = $contribution->total_amount
;
1450 CRM_Contribute_BAO_ContributionSoft
::add($softParams);
1452 $paymentParams['contactID'] = $contactID;
1453 $paymentParams['contributionID'] = $contribution->id
;
1454 $paymentParams['contributionTypeID'] = $contribution->financial_type_id
;
1455 $paymentParams['contributionPageID'] = $contribution->contribution_page_id
;
1456 $paymentParams['contributionRecurID'] = $contribution->contribution_recur_id
;
1457 $ids['contribution'] = $contribution->id
;
1458 $params['contribution_recur_id'] = $paymentParams['contributionRecurID'];
1459 $params['status_id'] = array_search('Pending', $allStatus);
1460 $params['skipStatusCal'] = TRUE;
1462 //as membership is pending set dates to null.
1463 $memberDates = array(
1464 'join_date' => 'joinDate',
1465 'start_date' => 'startDate',
1466 'end_date' => 'endDate',
1469 foreach ($memberDates as $dp => $dv) {
1471 foreach ($this->_memTypeSelected
as $memType) {
1472 $membershipTypeValues[$memType][$dv] = NULL;
1477 if ($params['total_amount'] > 0.0) {
1478 $payment = CRM_Core_Payment
::singleton($this->_mode
, $this->_paymentProcessor
, $this);
1479 $result = & $payment->doDirectPayment($paymentParams);
1482 if (is_a($result, 'CRM_Core_Error')) {
1483 //make sure to cleanup db for recurring case.
1484 if (!empty($paymentParams['contributionID'])) {
1485 CRM_Contribute_BAO_Contribution
::deleteContribution($paymentParams['contributionID']);
1487 if (!empty($paymentParams['contributionRecurID'])) {
1488 CRM_Contribute_BAO_ContributionRecur
::deleteRecurContribution($paymentParams['contributionRecurID']);
1491 CRM_Core_Error
::displaySessionError($result);
1492 CRM_Utils_System
::redirect(CRM_Utils_System
::url('civicrm/contact/view/membership',
1493 "reset=1&action=add&cid={$this->_contactID}&context=&mode={$this->_mode}"
1498 $this->_params
= array_merge($this->_params
, $result);
1499 //assign amount to template if payment was successful
1500 $this->assign('amount', $params['total_amount']);
1503 $params['contribution_status_id'] = !empty($paymentParams['is_recur']) ?
2 : 1;
1504 $params['receive_date'] = $now;
1505 $params['invoice_id'] = $this->_params
['invoiceID'];
1506 $params['contribution_source'] = ts('%1 Membership Signup: Credit card or direct debit (by %2)',
1507 array(1 => $membershipType, 2 => $userName)
1509 $params['source'] = $formValues['source'] ?
$formValues['source'] : $params['contribution_source'];
1510 $params['trxn_id'] = CRM_Utils_Array
::value('trxn_id', $result);
1511 $params['payment_instrument_id'] = 1;
1512 $params['is_test'] = ($this->_mode
== 'live') ?
0 : 1;
1513 if (!empty($this->_params
['send_receipt'])) {
1514 $params['receipt_date'] = $now;
1517 $params['receipt_date'] = NULL;
1520 $this->set('params', $this->_params
);
1521 $this->assign('trxn_id', CRM_Utils_Array
::value('trxn_id', $result));
1522 $this->assign('receive_date',
1523 CRM_Utils_Date
::mysqlToIso($params['receive_date'])
1526 // required for creating membership for related contacts
1527 $params['action'] = $this->_action
;
1529 //create membership record.
1531 foreach ($this->_memTypeSelected
as $memType) {
1533 ($relateContribution = CRM_Member_BAO_Membership
::getMembershipContributionId($membership->id
))
1535 $membershipTypeValues[$memType]['relate_contribution_id'] = $relateContribution;
1538 $membershipParams = array_merge($membershipTypeValues[$memType], $params);
1539 $membership = CRM_Member_BAO_Membership
::create($membershipParams, $ids);
1541 $this->_membershipIDs
[] = $membership->id
;
1542 $createdMemberships[$memType] = $membership;
1548 $params['action'] = $this->_action
;
1549 if ($this->_onlinePendingContributionId
&& !empty($formValues['record_contribution'])) {
1551 // update membership as well as contribution object, CRM-4395
1552 $params['contribution_id'] = $this->_onlinePendingContributionId
;
1553 $params['componentId'] = $params['id'];
1554 $params['componentName'] = 'contribute';
1555 $result = CRM_Contribute_BAO_Contribution
::transitionComponents($params, TRUE);
1556 if (!empty($result) && !empty($params['contribution_id'])) {
1557 $lineItem = array();
1558 $lineItems = CRM_Price_BAO_LineItem
::getLineItems($params['contribution_id'], 'contribution');
1559 $itemId = key($lineItems);
1560 $priceSetId = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceField', $lineItems[$itemId]['price_field_id'], 'price_set_id');
1562 if ($itemId && !empty($lineItems[$itemId]['price_field_id'])) {
1563 $fieldType = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceField', $lineItems[$itemId]['price_field_id'], 'html_type');
1565 $lineItems[$itemId]['unit_price'] = $params['total_amount'];
1566 $lineItems[$itemId]['line_total'] = $params['total_amount'];
1567 $lineItems[$itemId]['id'] = $itemId;
1568 $lineItem[$priceSetId] = $lineItems;
1569 CRM_Price_BAO_LineItem
::processPriceSet($params['contribution_id'], $lineItem);
1571 //create new soft-credit record, CRM-13981
1572 $softParams['contribution_id'] = $params['contribution_id'];
1573 $dao = new CRM_Contribute_DAO_Contribution();
1574 $dao->id
= $params['contribution_id'];
1576 while ($dao->fetch()) {
1577 $softParams['currency'] = $dao->currency
;
1578 $softParams['amount'] = $dao->total_amount
;
1580 CRM_Contribute_BAO_ContributionSoft
::add($softParams);
1583 //carry updated membership object.
1584 $membership = new CRM_Member_DAO_Membership();
1585 $membership->id
= $this->_id
;
1586 $membership->find(TRUE);
1589 if ($membership->end_date
) {
1590 //display end date w/ status message.
1591 $endDate = $membership->end_date
;
1593 $membershipStatues = CRM_Member_PseudoConstant
::membershipStatus();
1594 if (!in_array($membership->status_id
, array(
1595 array_search('Cancelled', $membershipStatues),
1596 array_search('Expired', $membershipStatues),
1602 // suppress form values in template.
1603 $this->assign('cancelled', $cancelled);
1605 // FIX ME: need to recheck this
1606 // here we might updated dates, so get from object.
1607 foreach ($calcDates[$membership->membership_type_id
] as $date => & $val) {
1608 if ($membership->$date) {
1609 $val = $membership->$date;
1613 $createdMemberships[] = $membership;
1617 foreach ($this->_memTypeSelected
as $memType) {
1618 if ($count && !empty($formValues['record_contribution']) &&
1619 ($relateContribution = CRM_Member_BAO_Membership
::getMembershipContributionId($membership->id
))
1621 $membershipTypeValues[$memType]['relate_contribution_id'] = $relateContribution;
1624 $membershipParams = array_merge($params, $membershipTypeValues[$memType]);
1625 if (!empty($formValues['int_amount'])) {
1626 $init_amount = array();
1627 foreach ($formValues as $key => $value) {
1628 if (strstr($key, 'txt-price')) {
1629 $init_amount[$key] = $value;
1632 $membershipParams['init_amount'] = $init_amount;
1634 $membership = CRM_Member_BAO_Membership
::create($membershipParams, $ids);
1636 $this->_membershipIDs
[] = $membership->id
;
1637 $createdMemberships[$memType] = $membership;
1643 if (!empty($lineItem[$priceSetId])) {
1644 foreach ($lineItem[$priceSetId] as & $priceFieldOp) {
1645 if (!empty($priceFieldOp['membership_type_id'])) {
1646 $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') : '-';
1648 $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') : '-';
1651 $priceFieldOp['start_date'] = $priceFieldOp['end_date'] = 'N/A';
1655 $this->assign('lineItem', !empty($lineItem) && !$isQuickConfig ?
$lineItem : FALSE);
1657 $receiptSend = FALSE;
1658 if (!empty($formValues['send_receipt'])) {
1659 $receiptSend = TRUE;
1661 $formValues['contact_id'] = $this->_contactID
;
1663 // send email receipt
1664 $mailSend = self
::emailReceipt($this, $formValues, $membership);
1667 if (($this->_action
& CRM_Core_Action
::UPDATE
)) {
1668 //end date can be modified by hooks, so if end date is set then use it.
1669 $endDate = ($membership->end_date
) ?
$membership->end_date
: $endDate;
1671 $statusMsg = ts('Membership for %1 has been updated.', array(1 => $this->_memberDisplayName
));
1672 if ($endDate && $endDate !== 'null') {
1673 $endDate = CRM_Utils_Date
::customFormat($endDate);
1674 $statusMsg .= ' ' . ts('The membership End Date is %1.', array(1 => $endDate));
1677 $statusMsg .= ' ' . ts('A confirmation and receipt has been sent to %1.', array(1 => $this->_contributorEmail
));
1680 elseif (($this->_action
& CRM_Core_Action
::ADD
)) {
1681 // FIX ME: fix status messages
1683 $statusMsg = array();
1684 foreach ($membershipTypes as $memType => $membershipType) {
1685 $statusMsg[$memType] = ts('%1 membership for %2 has been added.', array(
1686 1 => $membershipType,
1687 2 => $this->_memberDisplayName
1690 $membership = $createdMemberships[$memType];
1691 $memEndDate = ($membership->end_date
) ?
$membership->end_date
: $endDate;
1693 //get the end date from calculated dates.
1694 if (!$memEndDate && empty($params['is_recur'])) {
1695 $memEndDate = CRM_Utils_Array
::value('end_date', $calcDates[$memType]);
1698 if ($memEndDate && $memEndDate !== 'null') {
1699 $memEndDate = CRM_Utils_Date
::customFormat($memEndDate);
1700 $statusMsg[$memType] .= ' ' . ts('The new membership End Date is %1.', array(1 => $memEndDate));
1703 $statusMsg = implode('<br/>', $statusMsg);
1704 if ($receiptSend && $mailSend) {
1705 $statusMsg .= ' ' . ts('A membership confirmation and receipt has been sent to %1.', array(1 => $this->_contributorEmail
));
1709 // finally set membership id if already not set
1711 $this->_id
= $membership->id
;
1714 CRM_Core_Session
::setStatus($statusMsg, ts('Complete'), 'success');
1716 $buttonName = $this->controller
->getButtonName();
1717 if ($this->_context
== 'standalone') {
1718 if ($buttonName == $this->getButtonName('upload', 'new')) {
1719 $session->replaceUserContext(CRM_Utils_System
::url('civicrm/member/add',
1720 'reset=1&action=add&context=standalone'
1724 $session->replaceUserContext(CRM_Utils_System
::url('civicrm/contact/view',
1725 "reset=1&cid={$this->_contactID}&selectedChild=member"
1729 elseif ($buttonName == $this->getButtonName('upload', 'new')) {
1730 $session->replaceUserContext(CRM_Utils_System
::url('civicrm/contact/view/membership',
1731 "reset=1&action=add&context=membership&cid={$this->_contactID}"
1737 * Function to send email receipt
1739 * @param object $form form object
1740 * @param $formValues
1741 * @param object $membership object
1743 * @internal param array $values submitted values
1744 * @return boolean true if mail was sent successfully
1747 static function emailReceipt(&$form, &$formValues, &$membership) {
1748 // retrieve 'from email id' for acknowledgement
1749 $receiptFrom = $formValues['from_email_address'];
1751 if (!empty($formValues['payment_instrument_id'])) {
1752 $paymentInstrument = CRM_Contribute_PseudoConstant
::paymentInstrument();
1753 $formValues['paidBy'] = $paymentInstrument[$formValues['payment_instrument_id']];
1756 // retrieve custom data
1757 $customFields = $customValues = array();
1758 if (property_exists($form, '_groupTree')
1759 && !empty($form->_groupTree
)
1761 foreach ($form->_groupTree
as $groupID => $group) {
1762 if ($groupID == 'info') {
1765 foreach ($group['fields'] as $k => $field) {
1766 $field['title'] = $field['label'];
1767 $customFields["custom_{$k}"] = $field;
1772 $members = array(array('member_id', '=', $membership->id
, 0, 0));
1773 // check whether its a test drive
1774 if ($form->_mode
== 'test') {
1775 $members[] = array('member_test', '=', 1, 0, 0);
1778 CRM_Core_BAO_UFGroup
::getValues($formValues['contact_id'], $customFields, $customValues, FALSE, $members);
1781 if (!empty($form->_params
['billing_first_name'])) {
1782 $name = $form->_params
['billing_first_name'];
1785 if (!empty($form->_params
['billing_middle_name'])) {
1786 $name .= " {$form->_params['billing_middle_name']}";
1789 if (!empty($form->_params
['billing_last_name'])) {
1790 $name .= " {$form->_params['billing_last_name']}";
1793 $form->assign('billingName', $name);
1795 // assign the address formatted up for display
1796 $addressParts = array(
1797 "street_address-{$form->_bltID}",
1798 "city-{$form->_bltID}",
1799 "postal_code-{$form->_bltID}",
1800 "state_province-{$form->_bltID}",
1801 "country-{$form->_bltID}",
1803 $addressFields = array();
1804 foreach ($addressParts as $part) {
1805 list($n, $id) = explode('-', $part);
1806 if (isset($form->_params
['billing_' . $part])) {
1807 $addressFields[$n] = $form->_params
['billing_' . $part];
1810 $form->assign('address', CRM_Utils_Address
::format($addressFields));
1812 $date = CRM_Utils_Date
::format($form->_params
['credit_card_exp_date']);
1813 $date = CRM_Utils_Date
::mysqlToIso($date);
1814 $form->assign('credit_card_exp_date', $date);
1815 $form->assign('credit_card_number',
1816 CRM_Utils_System
::mungeCreditCard($form->_params
['credit_card_number'])
1818 $form->assign('credit_card_type', $form->_params
['credit_card_type']);
1819 $form->assign('contributeMode', 'direct');
1820 $form->assign('isAmountzero', 0);
1821 $form->assign('is_pay_later', 0);
1822 $form->assign('isPrimary', 1);
1825 $form->assign('module', 'Membership');
1826 $form->assign('contactID', $formValues['contact_id']);
1828 $form->assign('membershipID', CRM_Utils_Array
::value('membership_id', $form->_params
, CRM_Utils_Array
::value('membership_id', $form->_defaultValues
)));
1830 if (!empty($formValues['contribution_id'])) {
1831 $form->assign('contributionID', $formValues['contribution_id']);
1833 elseif (isset($form->_onlinePendingContributionId
)) {
1834 $form->assign('contributionID', $form->_onlinePendingContributionId
);
1837 if (!empty($formValues['contribution_status_id'])) {
1838 $form->assign('contributionStatusID', $formValues['contribution_status_id']);
1839 $form->assign('contributionStatus', CRM_Contribute_PseudoConstant
::contributionStatus($formValues['contribution_status_id'], 'name'));
1842 if (!empty($formValues['is_renew'])) {
1843 $form->assign('receiptType', 'membership renewal');
1846 $form->assign('receiptType', 'membership signup');
1848 $form->assign('receive_date', CRM_Utils_Date
::processDate(CRM_Utils_Array
::value('receive_date', $formValues)));
1849 $form->assign('formValues', $formValues);
1851 if (empty($lineItem)) {
1852 $form->assign('mem_start_date', CRM_Utils_Date
::customFormat($membership->start_date
, '%B %E%f, %Y'));
1853 $form->assign('mem_end_date', CRM_Utils_Date
::customFormat($membership->end_date
, '%B %E%f, %Y'));
1854 $form->assign('membership_name', CRM_Member_PseudoConstant
::membershipType($membership->membership_type_id
));
1857 $form->assign('customValues', $customValues);
1858 $isBatchProcess = is_a($form, 'CRM_Batch_Form_Entry');
1859 if ((empty($form->_contributorDisplayName
) ||
empty($form->_contributorEmail
)) ||
$isBatchProcess) {
1860 // in this case the form is being called statically from the batch editing screen
1861 // having one class in the form layer call another statically is not greate
1862 // & we should aim to move this function to the BAO layer in future.
1863 // however, we can assume that the contact_id passed in by the batch
1864 // function will be the recipient
1866 $form->_contributorDisplayName
,
1867 $form->_contributorEmail
1868 ) = CRM_Contact_BAO_Contact_Location
::getEmailDetails(
1869 $formValues['contact_id']
1871 if (empty($form->_receiptContactId
) ||
$isBatchProcess) {
1872 $form->_receiptContactId
= $formValues['contact_id'];
1876 list($mailSend, $subject, $message, $html) = CRM_Core_BAO_MessageTemplate
::sendTemplate(
1878 'groupName' => 'msg_tpl_workflow_membership',
1879 'valueName' => 'membership_offline_receipt',
1880 'contactId' => $form->_receiptContactId
,
1881 'from' => $receiptFrom,
1882 'toName' => $form->_contributorDisplayName
,
1883 'toEmail' => $form->_contributorEmail
,
1884 'isTest' => (bool) ($form->_action
& CRM_Core_Action
::PREVIEW
)