3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.4 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2013 |
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-2013
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 CRM_Contact_Form_NewContact
::buildQuickForm($this);
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->add('select', 'soft_credit_type_id', ts('Membership payment is : '),
775 array('' => ts('- Select - ')) + CRM_Core_OptionGroup
::values("soft_credit_type", FALSE));
776 CRM_Contact_Form_NewContact
::buildQuickForm($this, 1, NULL, FALSE, 'contribution_');
779 $this->addElement('checkbox',
781 ts('Send Confirmation and Receipt?'), NULL,
782 array('onclick' => "showHideByValue( 'send_receipt', '', 'notice', 'table-row', 'radio', false); showHideByValue( 'send_receipt', '', 'fromEmail', 'table-row', 'radio', false);")
785 $this->add('select', 'from_email_address', ts('Receipt From'), $this->_fromEmails
);
787 $this->add('textarea', 'receipt_text_signup', ts('Receipt Message'));
790 $this->add('select', 'payment_processor_id',
791 ts('Payment Processor'),
792 $this->_processors
, TRUE,
793 array('onChange' => "buildAutoRenew( null, this.value );")
795 CRM_Core_Payment_Form
::buildCreditCard($this, TRUE);
798 // Retrieve the name and email of the contact - this will be the TO for receipt email
799 if ($this->_contactID
) {
800 list($this->_memberDisplayName
,
802 ) = CRM_Contact_BAO_Contact_Location
::getEmailDetails($this->_contactID
);
804 $this->assign('emailExists', $this->_memberEmail
);
805 $this->assign('displayName', $this->_memberDisplayName
);
809 if ($this->_action
& CRM_Core_Action
::UPDATE
) {
810 $recurContributionId = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership', $this->_id
,
811 'contribution_recur_id'
813 if ($recurContributionId && !CRM_Member_BAO_Membership
::isSubscriptionCancelled($this->_id
)) {
815 if (CRM_Member_BAO_Membership
::isCancelSubscriptionSupported($this->_id
)) {
816 $this->assign('cancelAutoRenew',
817 CRM_Utils_System
::url('civicrm/contribute/unsubscribe', "reset=1&mid={$this->_id}")
820 foreach ($elements as $elem) {
825 $this->assign('isRecur', $isRecur);
827 $this->addFormRule(array('CRM_Member_Form_Membership', 'formRule'), $this);
829 $mailingInfo = CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::MAILING_PREFERENCES_NAME
,
832 $this->assign('outBound_option', $mailingInfo['outBound_option']);
834 parent
::buildQuickForm();
838 * Function for validation
840 * @param array $params (ref.) an assoc array of name/value pairs
842 * @return mixed true or array of errors
846 static function formRule($params, $files, $self) {
849 $priceSetId = CRM_Utils_Array
::value('price_set_id', $params);
852 CRM_Price_BAO_PriceField
::priceSetValidation($priceSetId, $params, $errors);
854 $priceFieldIDS = array();
855 foreach ($self->_priceSet
['fields'] as $priceIds => $dontCare) {
857 if (!empty($params['price_' . $priceIds])) {
858 if (is_array($params['price_' . $priceIds])) {
859 foreach ($params['price_' . $priceIds] as $priceFldVal => $isSet) {
861 $priceFieldIDS[] = $priceFldVal;
866 $priceFieldIDS[] = $params['price_' . $priceIds];
871 if (!empty($priceFieldIDS)) {
872 $ids = implode(',', $priceFieldIDS);
874 $count = CRM_Price_BAO_PriceSet
::getMembershipCount($ids);
875 foreach ($count as $id => $occurance) {
876 if ($occurance > 1) {
877 $errors['_qf_default'] = ts('Select at most one option associated with the same membership type.');
881 foreach ($priceFieldIDS as $priceFieldId) {
882 if ($id = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceFieldValue', $priceFieldId, 'membership_type_id')) {
883 $self->_memTypeSelected
[$id] = $id;
888 elseif (empty($params['membership_type_id'][1])) {
889 $errors['membership_type_id'] = ts('Please select a membership type.');
892 $self->_memTypeSelected
[] = $params['membership_type_id'][1];
896 $numterms = CRM_Utils_Array
::value('num_terms', $params);
897 if ($numterms && intval($numterms) != $numterms) {
898 $errors['num_terms'] = ts('Please enter an integer for the number of terms.');
902 // Return error if empty $self->_memTypeSelected
903 if ($priceSetId && empty($errors) && empty($self->_memTypeSelected
)) {
904 $errors['_qf_default'] = ts('Select at least one membership option.');
907 if (!empty($errors) && (count($self->_memTypeSelected
) > 1)) {
908 $memberOfContacts = CRM_Member_BAO_MembershipType
::getMemberOfContactByMemTypes($self->_memTypeSelected
);
909 $duplicateMemberOfContacts = array_count_values($memberOfContacts);
910 foreach ($duplicateMemberOfContacts as $countDuplicate) {
911 if ($countDuplicate > 1) {
912 $errors['_qf_default'] = ts('Please do not select more than one membership associated with the same organization.');
917 //check if contact is selected in standalone mode
918 if (isset($params['contact_select_id'][1]) && !$params['contact_select_id'][1]) {
919 $errors['contact[1]'] = ts('Please select a contact or create new contact');
922 if (!empty($errors)) {
926 if ($priceSetId && !$self->_mode
&& empty($params['record_contribution'])) {
927 $errors['record_contribution'] = ts('Record Membership Payment is required when you using price set.');
930 if (!$priceSetId && $self->_mode
&& empty($params['financial_type_id'])) {
931 $errors['financial_type_id'] = ts('Please enter the financial Type.');
934 if (!empty($params['record_contribution']) && empty($params['payment_instrument_id'])) {
935 $errors['payment_instrument_id'] = ts('Paid By is a required field.');
938 if (!empty($params['is_different_contribution_contact'])) {
939 if (empty($params['soft_credit_type_id'])) {
940 $errors['soft_credit_type_id'] = ts('Please Select a Soft Credit Type');
942 if (empty($params['contribution_contact'][1])) {
943 $errors['contribution_contact[1]'] = ts('Please select a contact');
947 if (!empty($params['payment_processor_id'])) {
948 // make sure that credit card number and cvv are valid
949 CRM_Core_Payment_Form
::validateCreditCard($params, $errors);
953 if (!empty($params['join_date'])) {
955 $joinDate = CRM_Utils_Date
::processDate($params['join_date']);
957 foreach ($self->_memTypeSelected
as $memType) {
959 if (!empty($params['start_date'])) {
960 $startDate = CRM_Utils_Date
::processDate($params['start_date']);
963 // if end date is set, ensure that start date is also set
964 // and that end date is later than start date
965 // If selected membership type has duration unit as 'lifetime'
966 // and end date is set, then give error
968 if (!empty($params['end_date'])) {
969 $endDate = CRM_Utils_Date
::processDate($params['end_date']);
972 $membershipDetails = CRM_Member_BAO_MembershipType
::getMembershipTypeDetails($memType);
974 if ($startDate && CRM_Utils_Array
::value('period_type', $membershipDetails) == 'rolling') {
975 if ($startDate < $joinDate) {
976 $errors['start_date'] = ts('Start date must be the same or later than Member since.');
981 if ($membershipDetails['duration_unit'] == 'lifetime') {
982 $errors['end_date'] = ts('The selected Membership Type has a lifetime duration. You cannot specify an End Date for lifetime memberships. Please clear the End Date OR select a different Membership Type.');
986 $errors['start_date'] = ts('Start date must be set if end date is set.');
988 if ($endDate < $startDate) {
989 $errors['end_date'] = ts('End date must be the same or later than start date.');
994 // Default values for start and end dates if not supplied
996 $defaultDates = CRM_Member_BAO_MembershipType
::getDatesForMembershipType($memType,
1003 $startDate = CRM_Utils_Array
::value('start_date',
1008 $endDate = CRM_Utils_Array
::value('end_date',
1013 //CRM-3724, check for availability of valid membership status.
1014 if (empty($params['is_override']) && !isset($errors['_qf_default'])) {
1015 $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 $config = CRM_Core_Config
::singleton();
1079 // get the submitted form values.
1080 $this->_params
= $formValues = $this->controller
->exportValues($this->_name
);
1081 $this->convertDateFieldsToMySQL($formValues);
1083 $params = $softParams = $ids = array();
1085 $membershipTypeValues = array();
1086 foreach ($this->_memTypeSelected
as $memType) {
1087 $membershipTypeValues[$memType]['membership_type_id'] = $memType;
1090 //take the required membership recur values.
1091 if ($this->_mode
&& !empty($this->_params
['auto_renew'])) {
1092 $params['is_recur'] = $this->_params
['is_recur'] = $formValues['is_recur'] = TRUE;
1094 'frequency_interval' => 'duration_interval',
1095 'frequency_unit' => 'duration_unit',
1099 foreach ($this->_memTypeSelected
as $memType) {
1100 $recurMembershipTypeValues = CRM_Utils_Array
::value($memType,
1101 $this->_recurMembershipTypes
, array()
1103 foreach ($mapping as $mapVal => $mapParam) {
1104 $membershipTypeValues[$memType][$mapVal] = CRM_Utils_Array
::value($mapParam,
1105 $recurMembershipTypeValues
1108 $this->_params
[$mapVal] = $formValues[$mapVal] = CRM_Utils_Array
::value($mapParam,
1109 $recurMembershipTypeValues
1116 // unset send-receipt option, since receipt will be sent when ipn is received.
1117 unset($this->_params
['send_receipt'], $formValues['send_receipt']);
1120 // process price set and get total amount and line items.
1121 $lineItem = array();
1123 if (!$priceSetId = CRM_Utils_Array
::value('price_set_id', $formValues)) {
1124 CRM_Member_BAO_Membership
::createLineItems($this, $formValues['membership_type_id'], $priceSetId);
1127 if ($this->_priceSetId
&& CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet', $this->_priceSetId
, 'is_quick_config')) {
1131 $termsByType = array();
1133 CRM_Price_BAO_PriceSet
::processAmount($this->_priceSet
['fields'],
1134 $this->_params
, $lineItem[$priceSetId]);
1135 $params['total_amount'] = CRM_Utils_Array
::value('amount', $this->_params
);
1136 $submittedFinancialType = CRM_Utils_Array
::value('financial_type_id', $formValues);
1137 if (!empty($lineItem[$priceSetId])) {
1138 foreach ($lineItem[$priceSetId] as &$li) {
1139 if (!empty($li['membership_type_id'])) {
1140 if (!empty($li['membership_num_terms'])) {
1141 $termsByType[$li['membership_type_id']] = $li['membership_num_terms'];
1145 ///CRM-11529 for quick config backoffice transactions
1146 //when financial_type_id is passed in form, update the
1147 //lineitems with the financial type selected in form
1148 if ($isQuickConfig && $submittedFinancialType) {
1149 $li['financial_type_id'] = $submittedFinancialType;
1155 $this->storeContactFields($formValues);
1157 $params['contact_id'] = $this->_contactID
;
1166 foreach ($fields as $f) {
1167 $params[$f] = CRM_Utils_Array
::value($f, $formValues);
1171 // when is_override false ignore is_admin statuses during membership
1172 // status calculation. similarly we did fix for import in CRM-3570.
1173 if (empty($params['is_override'])) {
1174 $params['exclude_is_admin'] = TRUE;
1177 // process date params to mysql date format.
1179 'join_date' => 'joinDate',
1180 'start_date' => 'startDate',
1181 'end_date' => 'endDate',
1183 foreach ($dateTypes as $dateField => $dateVariable) {
1184 $
$dateVariable = CRM_Utils_Date
::processDate($formValues[$dateField]);
1187 $num_terms = CRM_Utils_Array
::value('num_terms', $formValues, 1);
1189 $calcDates = array();
1190 foreach ($this->_memTypeSelected
as $memType) {
1191 $memTypeNumTerms = CRM_Utils_Array
::value($memType, $termsByType, $num_terms);
1192 $calcDates[$memType] = CRM_Member_BAO_MembershipType
::getDatesForMembershipType($memType,
1193 $joinDate, $startDate, $endDate, $memTypeNumTerms
1197 foreach ($calcDates as $memType => $calcDate) {
1198 foreach (array_keys($dateTypes) as $d) {
1199 //first give priority to form values then calDates.
1200 $date = CRM_Utils_Array
::value($d, $formValues);
1202 $date = CRM_Utils_Array
::value($d, $calcDate);
1205 $membershipTypeValues[$memType][$d] = CRM_Utils_Date
::processDate($date);
1206 //$params[$d] = CRM_Utils_Date::processDate( $date );
1210 // max related memberships - take from form or inherit from membership type
1211 foreach ($this->_memTypeSelected
as $memType) {
1212 if (array_key_exists('max_related', $formValues)) {
1213 $membershipTypeValues[$memType]['max_related'] = CRM_Utils_Array
::value('max_related', $formValues);
1218 $ids['membership'] = $params['id'] = $this->_id
;
1221 $session = CRM_Core_Session
::singleton();
1222 $ids['userId'] = $session->get('userID');
1224 // membership type custom data
1225 foreach ($this->_memTypeSelected
as $memType) {
1226 $customFields = CRM_Core_BAO_CustomField
::getFields('Membership', FALSE, FALSE,
1230 $customFields = CRM_Utils_Array
::crmArrayMerge($customFields,
1231 CRM_Core_BAO_CustomField
::getFields('Membership',
1237 $membershipTypeValues[$memType]['custom'] = CRM_Core_BAO_CustomField
::postProcess($formValues,
1244 foreach ($this->_memTypeSelected
as $memType) {
1245 $membershipTypes[$memType] = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType',
1250 $membershipType = implode(', ', $membershipTypes);
1252 // Retrieve the name and email of the current user - this will be the FROM for the receipt email
1253 list($userName, $userEmail) = CRM_Contact_BAO_Contact_Location
::getEmailDetails($ids['userId']);
1255 //CRM-10223 - allow contribution to be recorded against different contact
1256 if ($this->_contributorContactID
!= $this->_contactID
) {
1257 $params['contribution_contact_id'] = $this->_contributorContactID
;
1258 if (!empty($this->_params
['soft_credit_type_id'])) {
1259 $softParams['soft_credit_type_id'] = $this->_params
['soft_credit_type_id'];
1260 $softParams['contact_id'] = $params['contact_id'];
1263 if (!empty($formValues['record_contribution'])) {
1264 $recordContribution = array(
1266 'financial_type_id',
1267 'payment_instrument_id',
1269 'contribution_status_id',
1275 foreach ($recordContribution as $f) {
1276 $params[$f] = CRM_Utils_Array
::value($f, $formValues);
1279 if (!$this->_onlinePendingContributionId
) {
1280 $params['contribution_source'] = ts('%1 Membership: Offline signup (by %2)',
1281 array(1 => $membershipType, 2 => $userName)
1285 if (empty($params['is_override']) &&
1286 CRM_Utils_Array
::value('contribution_status_id', $params) == array_search('Pending', CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name'))
1288 $allStatus = CRM_Member_PseudoConstant
::membershipStatus();
1289 $params['status_id'] = array_search('Pending', $allStatus);
1290 $params['skipStatusCal'] = TRUE;
1291 $params['is_pay_later'] = 1;
1292 $this->assign('is_pay_later', 1);
1295 if (!empty($formValues['send_receipt'])) {
1296 $params['receipt_date'] = CRM_Utils_Array
::value('receive_date', $formValues);
1299 //insert financial type name in receipt.
1300 $formValues['contributionType_name'] = CRM_Core_DAO
::getFieldValue('CRM_Financial_DAO_FinancialType',
1301 $formValues['financial_type_id']
1305 // process line items, until no previous line items.
1306 if (!empty($lineItem)) {
1307 $params['lineItems'] = $lineItem;
1308 $params['processPriceSet'] = TRUE;
1310 $createdMemberships = array();
1312 if (empty($formValues['total_amount']) && !$priceSetId) {
1313 // if total amount not provided minimum for membership type is used
1314 $params['total_amount'] = $formValues['total_amount'] = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType',
1315 $formValues['membership_type_id'][1], 'minimum_fee'
1319 $params['total_amount'] = CRM_Utils_Array
::value('total_amount', $formValues, 0);
1322 if ($priceSetId && !$isQuickConfig) {
1323 $params['financial_type_id'] = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet',
1329 $params['financial_type_id'] = CRM_Utils_Array
::value('financial_type_id', $formValues);
1332 $this->_paymentProcessor
= CRM_Financial_BAO_PaymentProcessor
::getPayment($formValues['payment_processor_id'],
1336 //get the payment processor id as per mode.
1337 $params['payment_processor_id'] = $this->_params
['payment_processor_id'] = $formValues['payment_processor_id'] = $this->_paymentProcessor
['id'];
1340 $now = date('YmdHis');
1343 // set email for primary location.
1344 $fields['email-Primary'] = 1;
1345 $formValues['email-5'] = $formValues['email-Primary'] = $this->_memberEmail
;
1346 $params['register_date'] = $now;
1348 // now set the values for the billing location.
1349 foreach ($this->_fields
as $name => $dontCare) {
1353 // also add location name to the array
1354 $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);
1356 $formValues["address_name-{$this->_bltID}"] = trim($formValues["address_name-{$this->_bltID}"]);
1358 $fields["address_name-{$this->_bltID}"] = 1;
1359 //ensure we don't over-write the payer's email with the member's email
1360 if ($this->_contributorContactID
== $this->_contactID
) {
1361 $fields["email-{$this->_bltID}"] = 1;
1364 $ctype = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $this->_contactID
, 'contact_type');
1366 $nameFields = array('first_name', 'middle_name', 'last_name');
1368 foreach ($nameFields as $name) {
1370 if (array_key_exists("billing_$name", $formValues)) {
1371 $formValues[$name] = $formValues["billing_{$name}"];
1372 $formValues['preserveDBName'] = TRUE;
1375 if ($this->_contributorContactID
== $this->_contactID
) {
1376 //see CRM-12869 for discussion of why we don't do this for separate payee payments
1377 CRM_Contact_BAO_Contact
::createProfileContact($formValues, $fields,
1378 $this->_contributorContactID
, NULL, NULL, $ctype
1382 // add all the additioanl payment params we need
1383 $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}"]);
1384 $this->_params
["country-{$this->_bltID}"] = $this->_params
["billing_country-{$this->_bltID}"] = CRM_Core_PseudoConstant
::countryIsoCode($this->_params
["billing_country_id-{$this->_bltID}"]);
1386 $this->_params
['year'] = CRM_Core_Payment_Form
::getCreditCardExpirationYear($this->_params
);
1387 $this->_params
['month'] = CRM_Core_Payment_Form
::getCreditCardExpirationMonth($this->_params
);
1388 $this->_params
['ip_address'] = CRM_Utils_System
::ipAddress();
1389 $this->_params
['amount'] = $params['total_amount'];
1390 $this->_params
['currencyID'] = $config->defaultCurrency
;
1391 $this->_params
['payment_action'] = 'Sale';
1392 $this->_params
['invoiceID'] = md5(uniqid(rand(), TRUE));
1393 $this->_params
['financial_type_id'] = $params['financial_type_id'];
1395 // at this point we've created a contact and stored its address etc
1396 // all the payment processors expect the name and address to be in the
1397 // so we copy stuff over to first_name etc.
1398 $paymentParams = $this->_params
;
1399 $paymentParams['contactID'] = $this->_contributorContactID
;
1400 //CRM-10377 if payment is by an alternate contact then we need to set that person
1401 // as the contact in the payment params
1402 if ($this->_contributorContactID
!= $this->_contactID
) {
1403 if (!empty($this->_params
['soft_credit_type_id'])) {
1404 $softParams['contact_id'] = $params['contact_id'];
1405 $softParams['soft_credit_type_id'] = $this->_params
['soft_credit_type_id'];
1408 if (!empty($this->_params
['send_receipt'])) {
1409 $paymentParams['email'] = $this->_contributorEmail
;
1412 CRM_Core_Payment_Form
::mapParams($this->_bltID
, $this->_params
, $paymentParams, TRUE);
1414 // CRM-7137 -for recurring membership,
1415 // we do need contribution and recuring records.
1417 if (!empty($paymentParams['is_recur'])) {
1418 $allStatus = CRM_Member_PseudoConstant
::membershipStatus();
1420 $contributionType = new CRM_Financial_DAO_FinancialType();
1421 $contributionType->id
= $params['financial_type_id'];
1422 if (!$contributionType->find(TRUE)) {
1423 CRM_Core_Error
::fatal('Could not find a system table');
1426 $contribution = CRM_Contribute_Form_Contribution_Confirm
::processContribution($this,
1429 $this->_contributorContactID
,
1436 //create new soft-credit record, CRM-13981
1437 $softParams['contribution_id'] = $contribution->id
;
1438 $softParams['currency'] = $contribution->currency
;
1439 $softParams['amount'] = $contribution->total_amount
;
1440 CRM_Contribute_BAO_ContributionSoft
::add($softParams);
1442 $paymentParams['contactID'] = $contactID;
1443 $paymentParams['contributionID'] = $contribution->id
;
1444 $paymentParams['contributionTypeID'] = $contribution->financial_type_id
;
1445 $paymentParams['contributionPageID'] = $contribution->contribution_page_id
;
1446 $paymentParams['contributionRecurID'] = $contribution->contribution_recur_id
;
1447 $ids['contribution'] = $contribution->id
;
1448 $params['contribution_recur_id'] = $paymentParams['contributionRecurID'];
1449 $params['status_id'] = array_search('Pending', $allStatus);
1450 $params['skipStatusCal'] = TRUE;
1452 //as membership is pending set dates to null.
1453 $memberDates = array(
1454 'join_date' => 'joinDate',
1455 'start_date' => 'startDate',
1456 'end_date' => 'endDate',
1459 foreach ($memberDates as $dp => $dv) {
1461 foreach ($this->_memTypeSelected
as $memType) {
1462 $membershipTypeValues[$memType][$dv] = NULL;
1467 if ($params['total_amount'] > 0.0) {
1468 $payment = CRM_Core_Payment
::singleton($this->_mode
, $this->_paymentProcessor
, $this);
1469 $result = & $payment->doDirectPayment($paymentParams);
1472 if (is_a($result, 'CRM_Core_Error')) {
1473 //make sure to cleanup db for recurring case.
1474 if (!empty($paymentParams['contributionID'])) {
1475 CRM_Contribute_BAO_Contribution
::deleteContribution($paymentParams['contributionID']);
1477 if (!empty($paymentParams['contributionRecurID'])) {
1478 CRM_Contribute_BAO_ContributionRecur
::deleteRecurContribution($paymentParams['contributionRecurID']);
1481 CRM_Core_Error
::displaySessionError($result);
1482 CRM_Utils_System
::redirect(CRM_Utils_System
::url('civicrm/contact/view/membership',
1483 "reset=1&action=add&cid={$this->_contactID}&context=&mode={$this->_mode}"
1488 $this->_params
= array_merge($this->_params
, $result);
1489 //assign amount to template if payment was successful
1490 $this->assign('amount', $params['total_amount']);
1493 $params['contribution_status_id'] = !empty($paymentParams['is_recur']) ?
2 : 1;
1494 $params['receive_date'] = $now;
1495 $params['invoice_id'] = $this->_params
['invoiceID'];
1496 $params['contribution_source'] = ts('%1 Membership Signup: Credit card or direct debit (by %2)',
1497 array(1 => $membershipType, 2 => $userName)
1499 $params['source'] = $formValues['source'] ?
$formValues['source'] : $params['contribution_source'];
1500 $params['trxn_id'] = CRM_Utils_Array
::value('trxn_id', $result);
1501 $params['payment_instrument_id'] = 1;
1502 $params['is_test'] = ($this->_mode
== 'live') ?
0 : 1;
1503 if (!empty($this->_params
['send_receipt'])) {
1504 $params['receipt_date'] = $now;
1507 $params['receipt_date'] = NULL;
1510 $this->set('params', $this->_params
);
1511 $this->assign('trxn_id', CRM_Utils_Array
::value('trxn_id', $result));
1512 $this->assign('receive_date',
1513 CRM_Utils_Date
::mysqlToIso($params['receive_date'])
1516 // required for creating membership for related contacts
1517 $params['action'] = $this->_action
;
1519 //create membership record.
1521 foreach ($this->_memTypeSelected
as $memType) {
1523 ($relateContribution = CRM_Member_BAO_Membership
::getMembershipContributionId($membership->id
))
1525 $membershipTypeValues[$memType]['relate_contribution_id'] = $relateContribution;
1528 $membershipParams = array_merge($membershipTypeValues[$memType], $params);
1529 $membership = CRM_Member_BAO_Membership
::create($membershipParams, $ids);
1531 $this->_membershipIDs
[] = $membership->id
;
1532 $createdMemberships[$memType] = $membership;
1538 $params['action'] = $this->_action
;
1539 if ($this->_onlinePendingContributionId
&& !empty($formValues['record_contribution'])) {
1541 // update membership as well as contribution object, CRM-4395
1542 $params['contribution_id'] = $this->_onlinePendingContributionId
;
1543 $params['componentId'] = $params['id'];
1544 $params['componentName'] = 'contribute';
1545 $result = CRM_Contribute_BAO_Contribution
::transitionComponents($params, TRUE);
1546 if (!empty($result) && !empty($params['contribution_id'])) {
1547 $lineItem = array();
1548 $lineItems = CRM_Price_BAO_LineItem
::getLineItems($params['contribution_id'], 'contribution');
1549 $itemId = key($lineItems);
1550 $priceSetId = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceField', $lineItems[$itemId]['price_field_id'], 'price_set_id');
1552 if ($itemId && !empty($lineItems[$itemId]['price_field_id'])) {
1553 $fieldType = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceField', $lineItems[$itemId]['price_field_id'], 'html_type');
1555 $lineItems[$itemId]['unit_price'] = $params['total_amount'];
1556 $lineItems[$itemId]['line_total'] = $params['total_amount'];
1557 $lineItems[$itemId]['id'] = $itemId;
1558 $lineItem[$priceSetId] = $lineItems;
1559 CRM_Price_BAO_LineItem
::processPriceSet($params['contribution_id'], $lineItem);
1561 //create new soft-credit record, CRM-13981
1562 $softParams['contribution_id'] = $params['contribution_id'];
1563 $dao = new CRM_Contribute_DAO_Contribution();
1564 $dao->id
= $params['contribution_id'];
1566 while ($dao->fetch()) {
1567 $softParams['currency'] = $dao->currency
;
1568 $softParams['amount'] = $dao->total_amount
;
1570 CRM_Contribute_BAO_ContributionSoft
::add($softParams);
1573 //carry updated membership object.
1574 $membership = new CRM_Member_DAO_Membership();
1575 $membership->id
= $this->_id
;
1576 $membership->find(TRUE);
1579 if ($membership->end_date
) {
1580 //display end date w/ status message.
1581 $endDate = $membership->end_date
;
1583 $membershipStatues = CRM_Member_PseudoConstant
::membershipStatus();
1584 if (!in_array($membership->status_id
, array(
1585 array_search('Cancelled', $membershipStatues),
1586 array_search('Expired', $membershipStatues),
1592 // suppress form values in template.
1593 $this->assign('cancelled', $cancelled);
1595 // FIX ME: need to recheck this
1596 // here we might updated dates, so get from object.
1597 foreach ($calcDates[$membership->membership_type_id
] as $date => & $val) {
1598 if ($membership->$date) {
1599 $val = $membership->$date;
1603 $createdMemberships[] = $membership;
1607 foreach ($this->_memTypeSelected
as $memType) {
1608 if ($count && !empty($formValues['record_contribution']) &&
1609 ($relateContribution = CRM_Member_BAO_Membership
::getMembershipContributionId($membership->id
))
1611 $membershipTypeValues[$memType]['relate_contribution_id'] = $relateContribution;
1614 $membershipParams = array_merge($params, $membershipTypeValues[$memType]);
1615 if (!empty($formValues['int_amount'])) {
1616 $init_amount = array();
1617 foreach ($formValues as $key => $value) {
1618 if (strstr($key, 'txt-price')) {
1619 $init_amount[$key] = $value;
1622 $membershipParams['init_amount'] = $init_amount;
1624 $membership = CRM_Member_BAO_Membership
::create($membershipParams, $ids);
1626 $this->_membershipIDs
[] = $membership->id
;
1627 $createdMemberships[$memType] = $membership;
1633 if (!empty($lineItem[$priceSetId])) {
1634 foreach ($lineItem[$priceSetId] as & $priceFieldOp) {
1635 if (!empty($priceFieldOp['membership_type_id'])) {
1636 $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') : '-';
1638 $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') : '-';
1641 $priceFieldOp['start_date'] = $priceFieldOp['end_date'] = 'N/A';
1645 $this->assign('lineItem', !empty($lineItem) && !$isQuickConfig ?
$lineItem : FALSE);
1647 $receiptSend = FALSE;
1648 if (!empty($formValues['send_receipt'])) {
1649 $receiptSend = TRUE;
1651 $formValues['contact_id'] = $this->_contactID
;
1653 // send email receipt
1654 $mailSend = self
::emailReceipt($this, $formValues, $membership);
1657 if (($this->_action
& CRM_Core_Action
::UPDATE
)) {
1658 //end date can be modified by hooks, so if end date is set then use it.
1659 $endDate = ($membership->end_date
) ?
$membership->end_date
: $endDate;
1661 $statusMsg = ts('Membership for %1 has been updated.', array(1 => $this->_memberDisplayName
));
1662 if ($endDate && $endDate !== 'null') {
1663 $endDate = CRM_Utils_Date
::customFormat($endDate);
1664 $statusMsg .= ' ' . ts('The membership End Date is %1.', array(1 => $endDate));
1667 $statusMsg .= ' ' . ts('A confirmation and receipt has been sent to %1.', array(1 => $this->_contributorEmail
));
1670 elseif (($this->_action
& CRM_Core_Action
::ADD
)) {
1671 // FIX ME: fix status messages
1673 $statusMsg = array();
1674 foreach ($membershipTypes as $memType => $membershipType) {
1675 $statusMsg[$memType] = ts('%1 membership for %2 has been added.', array(
1676 1 => $membershipType,
1677 2 => $this->_memberDisplayName
1680 $membership = $createdMemberships[$memType];
1681 $memEndDate = ($membership->end_date
) ?
$membership->end_date
: $endDate;
1683 //get the end date from calculated dates.
1684 if (!$memEndDate && empty($params['is_recur'])) {
1685 $memEndDate = CRM_Utils_Array
::value('end_date', $calcDates[$memType]);
1688 if ($memEndDate && $memEndDate !== 'null') {
1689 $memEndDate = CRM_Utils_Date
::customFormat($memEndDate);
1690 $statusMsg[$memType] .= ' ' . ts('The new membership End Date is %1.', array(1 => $memEndDate));
1693 $statusMsg = implode('<br/>', $statusMsg);
1694 if ($receiptSend && $mailSend) {
1695 $statusMsg .= ' ' . ts('A membership confirmation and receipt has been sent to %1.', array(1 => $this->_contributorEmail
));
1699 // finally set membership id if already not set
1701 $this->_id
= $membership->id
;
1704 CRM_Core_Session
::setStatus($statusMsg, ts('Complete'), 'success');
1706 $buttonName = $this->controller
->getButtonName();
1707 if ($this->_context
== 'standalone') {
1708 if ($buttonName == $this->getButtonName('upload', 'new')) {
1709 $session->replaceUserContext(CRM_Utils_System
::url('civicrm/member/add',
1710 'reset=1&action=add&context=standalone'
1714 $session->replaceUserContext(CRM_Utils_System
::url('civicrm/contact/view',
1715 "reset=1&cid={$this->_contactID}&selectedChild=member"
1719 elseif ($buttonName == $this->getButtonName('upload', 'new')) {
1720 $session->replaceUserContext(CRM_Utils_System
::url('civicrm/contact/view/membership',
1721 "reset=1&action=add&context=membership&cid={$this->_contactID}"
1727 * Function to send email receipt
1729 * @param object $form form object
1730 * @param array $values submitted values
1731 * @param object $membership object
1733 * @return boolean true if mail was sent successfully
1736 static function emailReceipt(&$form, &$formValues, &$membership) {
1737 // retrieve 'from email id' for acknowledgement
1738 $receiptFrom = $formValues['from_email_address'];
1740 if (!empty($formValues['payment_instrument_id'])) {
1741 $paymentInstrument = CRM_Contribute_PseudoConstant
::paymentInstrument();
1742 $formValues['paidBy'] = $paymentInstrument[$formValues['payment_instrument_id']];
1745 // retrieve custom data
1746 $customFields = $customValues = array();
1747 if (property_exists($form, '_groupTree')
1748 && !empty($form->_groupTree
)
1750 foreach ($form->_groupTree
as $groupID => $group) {
1751 if ($groupID == 'info') {
1754 foreach ($group['fields'] as $k => $field) {
1755 $field['title'] = $field['label'];
1756 $customFields["custom_{$k}"] = $field;
1761 $members = array(array('member_id', '=', $membership->id
, 0, 0));
1762 // check whether its a test drive
1763 if ($form->_mode
== 'test') {
1764 $members[] = array('member_test', '=', 1, 0, 0);
1767 CRM_Core_BAO_UFGroup
::getValues($formValues['contact_id'], $customFields, $customValues, FALSE, $members);
1770 if (!empty($form->_params
['billing_first_name'])) {
1771 $name = $form->_params
['billing_first_name'];
1774 if (!empty($form->_params
['billing_middle_name'])) {
1775 $name .= " {$form->_params['billing_middle_name']}";
1778 if (!empty($form->_params
['billing_last_name'])) {
1779 $name .= " {$form->_params['billing_last_name']}";
1782 $form->assign('billingName', $name);
1784 // assign the address formatted up for display
1785 $addressParts = array(
1786 "street_address-{$form->_bltID}",
1787 "city-{$form->_bltID}",
1788 "postal_code-{$form->_bltID}",
1789 "state_province-{$form->_bltID}",
1790 "country-{$form->_bltID}",
1792 $addressFields = array();
1793 foreach ($addressParts as $part) {
1794 list($n, $id) = explode('-', $part);
1795 if (isset($form->_params
['billing_' . $part])) {
1796 $addressFields[$n] = $form->_params
['billing_' . $part];
1799 $form->assign('address', CRM_Utils_Address
::format($addressFields));
1801 $date = CRM_Utils_Date
::format($form->_params
['credit_card_exp_date']);
1802 $date = CRM_Utils_Date
::mysqlToIso($date);
1803 $form->assign('credit_card_exp_date', $date);
1804 $form->assign('credit_card_number',
1805 CRM_Utils_System
::mungeCreditCard($form->_params
['credit_card_number'])
1807 $form->assign('credit_card_type', $form->_params
['credit_card_type']);
1808 $form->assign('contributeMode', 'direct');
1809 $form->assign('isAmountzero', 0);
1810 $form->assign('is_pay_later', 0);
1811 $form->assign('isPrimary', 1);
1814 $form->assign('module', 'Membership');
1815 $form->assign('contactID', $formValues['contact_id']);
1817 $form->assign('membershipID', CRM_Utils_Array
::value('membership_id', $form->_params
, CRM_Utils_Array
::value('membership_id', $form->_defaultValues
)));
1819 if (!empty($formValues['contribution_id'])) {
1820 $form->assign('contributionID', $formValues['contribution_id']);
1822 elseif (isset($form->_onlinePendingContributionId
)) {
1823 $form->assign('contributionID', $form->_onlinePendingContributionId
);
1826 if (!empty($formValues['contribution_status_id'])) {
1827 $form->assign('contributionStatusID', $formValues['contribution_status_id']);
1828 $form->assign('contributionStatus', CRM_Contribute_PseudoConstant
::contributionStatus($formValues['contribution_status_id'], 'name'));
1831 if (!empty($formValues['is_renew'])) {
1832 $form->assign('receiptType', 'membership renewal');
1835 $form->assign('receiptType', 'membership signup');
1837 $form->assign('receive_date', CRM_Utils_Date
::processDate(CRM_Utils_Array
::value('receive_date', $formValues)));
1838 $form->assign('formValues', $formValues);
1840 if (empty($lineItem)) {
1841 $form->assign('mem_start_date', CRM_Utils_Date
::customFormat($membership->start_date
, '%B %E%f, %Y'));
1842 $form->assign('mem_end_date', CRM_Utils_Date
::customFormat($membership->end_date
, '%B %E%f, %Y'));
1843 $form->assign('membership_name', CRM_Member_PseudoConstant
::membershipType($membership->membership_type_id
));
1846 $form->assign('customValues', $customValues);
1847 $isBatchProcess = is_a($form, 'CRM_Batch_Form_Entry');
1848 if ((empty($form->_contributorDisplayName
) ||
empty($form->_contributorEmail
)) ||
$isBatchProcess) {
1849 // in this case the form is being called statically from the batch editing screen
1850 // having one class in the form layer call another statically is not greate
1851 // & we should aim to move this function to the BAO layer in future.
1852 // however, we can assume that the contact_id passed in by the batch
1853 // function will be the recipient
1855 $form->_contributorDisplayName
,
1856 $form->_contributorEmail
1857 ) = CRM_Contact_BAO_Contact_Location
::getEmailDetails(
1858 $formValues['contact_id']
1860 if (empty($form->_receiptContactId
) ||
$isBatchProcess) {
1861 $form->_receiptContactId
= $formValues['contact_id'];
1865 list($mailSend, $subject, $message, $html) = CRM_Core_BAO_MessageTemplate
::sendTemplate(
1867 'groupName' => 'msg_tpl_workflow_membership',
1868 'valueName' => 'membership_offline_receipt',
1869 'contactId' => $form->_receiptContactId
,
1870 'from' => $receiptFrom,
1871 'toName' => $form->_contributorDisplayName
,
1872 'toEmail' => $form->_contributorEmail
,
1873 'isTest' => (bool) ($form->_action
& CRM_Core_Action
::PREVIEW
)