3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2017 |
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 +--------------------------------------------------------------------+
32 * @copyright CiviCRM LLC (c) 2004-2017
38 * This class generates form components for processing a participation fee block
40 class CRM_Event_Form_EventFees
{
43 * Set variables up before form is built.
45 * @param CRM_Core_Form $form
47 public static function preProcess(&$form) {
48 //as when call come from register.php
49 if (!$form->_eventId
) {
50 $form->_eventId
= CRM_Utils_Request
::retrieve('eventId', 'Positive', $form);
53 $form->_pId
= CRM_Utils_Request
::retrieve('participantId', 'Positive', $form);
54 $form->_discountId
= CRM_Utils_Request
::retrieve('discountId', 'Positive', $form);
56 $form->_fromEmails
= CRM_Event_BAO_Event
::getFromEmailIds($form->_eventId
);
58 //CRM-6907 set event specific currency.
59 if ($form->_eventId
&&
60 ($currency = CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_Event', $form->_eventId
, 'currency'))
62 CRM_Core_Config
::singleton()->defaultCurrency
= $currency;
67 * This function sets the default values for the form in edit/view mode.
69 * @param CRM_Core_Form $form
73 public static function setDefaultValues(&$form) {
76 if ($form->_eventId
) {
77 //get receipt text and financial type
78 $returnProperities = array('confirm_email_text', 'financial_type_id', 'campaign_id', 'start_date');
80 CRM_Core_DAO
::commonRetrieveAll('CRM_Event_DAO_Event', 'id', $form->_eventId
, $details, $returnProperities);
81 if (!empty($details[$form->_eventId
]['financial_type_id'])) {
82 $defaults[$form->_pId
]['financial_type_id'] = $details[$form->_eventId
]['financial_type_id'];
88 $params = array('id' => $form->_pId
);
90 CRM_Event_BAO_Participant
::getValues($params, $defaults, $ids);
91 if ($form->_action
== CRM_Core_Action
::UPDATE
) {
93 if (!empty($form->_values
['discount'])) {
94 foreach ($form->_values
['discount'] as $key => $value) {
95 $value = current($value);
96 $discounts[$key] = $value['name'];
100 if ($form->_discountId
&& !empty($discounts[$defaults[$form->_pId
]['discount_id']])) {
101 $form->assign('discount', $discounts[$defaults[$form->_pId
]['discount_id']]);
104 $form->assign('fee_amount', CRM_Utils_Array
::value('fee_amount', $defaults[$form->_pId
]));
105 $form->assign('fee_level', CRM_Utils_Array
::value('fee_level', $defaults[$form->_pId
]));
107 $defaults[$form->_pId
]['send_receipt'] = 0;
110 $defaults[$form->_pId
]['send_receipt'] = (strtotime(CRM_Utils_Array
::value('start_date', $details[$form->_eventId
])) >= time()) ?
1 : 0;
111 if ($form->_eventId
&& !empty($details[$form->_eventId
]['confirm_email_text'])) {
113 $defaults[$form->_pId
]['receipt_text'] = $details[$form->_eventId
]['confirm_email_text'];
116 list($defaults[$form->_pId
]['receive_date'], $defaults[$form->_pId
]['receive_date_time']) = CRM_Utils_Date
::setDateDefaults();
119 //CRM-11601 we should keep the record contribution
120 //true by default while adding participant
121 if ($form->_action
== CRM_Core_Action
::ADD
&& !$form->_mode
&& $form->_isPaidEvent
) {
122 $defaults[$form->_pId
]['record_contribution'] = 1;
126 if (empty($defaults['payment_instrument_id'])) {
127 $defaults[$form->_pId
]['payment_instrument_id'] = key(CRM_Core_OptionGroup
::values('payment_instrument', FALSE, FALSE, FALSE, 'AND is_default = 1'));
130 $config = CRM_Core_Config
::singleton();
131 // set default country from config if no country set
132 if (empty($defaults[$form->_pId
]["billing_country_id-{$form->_bltID}"])) {
133 $defaults[$form->_pId
]["billing_country_id-{$form->_bltID}"] = $config->defaultContactCountry
;
136 if (empty($defaults["billing_state_province_id-{$form->_bltID}"])) {
137 $defaults[$form->_pId
]["billing_state_province_id-{$form->_bltID}"] = $config->defaultContactStateProvince
;
140 $billingDefaults = $form->getProfileDefaults('Billing', $form->_contactId
);
141 $defaults[$form->_pId
] = array_merge($defaults[$form->_pId
], $billingDefaults);
143 // // hack to simplify credit card entry for testing
144 // $defaults[$form->_pId]['credit_card_type'] = 'Visa';
145 // $defaults[$form->_pId]['credit_card_number'] = '4807731747657838';
146 // $defaults[$form->_pId]['cvv2'] = '000';
147 // $defaults[$form->_pId]['credit_card_exp_date'] = array( 'Y' => '2012', 'M' => '05' );
150 // if user has selected discount use that to set default
151 if (isset($form->_discountId
)) {
152 $defaults[$form->_pId
]['discount_id'] = $form->_discountId
;
154 //hack to set defaults for already selected discount value
155 if ($form->_action
== CRM_Core_Action
::UPDATE
&& !$form->_originalDiscountId
) {
156 $form->_originalDiscountId
= $defaults[$form->_pId
]['discount_id'];
157 if ($form->_originalDiscountId
) {
158 $defaults[$form->_pId
]['discount_id'] = $form->_originalDiscountId
;
161 $discountId = $form->_discountId
;
164 $discountId = CRM_Core_BAO_Discount
::findSet($form->_eventId
, 'civicrm_event');
168 $priceSetId = CRM_Core_DAO
::getFieldValue('CRM_Core_BAO_Discount', $discountId, 'price_set_id');
171 $priceSetId = CRM_Price_BAO_PriceSet
::getFor('civicrm_event', $form->_eventId
);
174 if (($form->_action
== CRM_Core_Action
::ADD
) && $form->_eventId
&& $discountId) {
175 // this case is for add mode, where we show discount automatically
176 $defaults[$form->_pId
]['discount_id'] = $discountId;
180 // get price set default values, CRM-4090
181 if (in_array(get_class($form),
183 'CRM_Event_Form_Participant',
184 'CRM_Event_Form_Registration_Register',
185 'CRM_Event_Form_Registration_AdditionalParticipant',
188 $priceSetValues = self
::setDefaultPriceSet($form->_pId
, $form->_eventId
);
189 if (!empty($priceSetValues)) {
190 $defaults[$form->_pId
] = array_merge($defaults[$form->_pId
], $priceSetValues);
194 if ($form->_action
== CRM_Core_Action
::ADD
&& !empty($form->_priceSet
['fields'])) {
195 foreach ($form->_priceSet
['fields'] as $key => $val) {
196 foreach ($val['options'] as $keys => $values) {
197 if ($values['is_default']) {
198 if (get_class($form) != 'CRM_Event_Form_Participant' && !empty($values['is_full'])) {
202 if ($val['html_type'] == 'CheckBox') {
203 $defaults[$form->_pId
]["price_{$key}"][$keys] = 1;
206 $defaults[$form->_pId
]["price_{$key}"] = $keys;
213 $form->assign('totalAmount', CRM_Utils_Array
::value('fee_amount', $defaults[$form->_pId
]));
214 if ($form->_action
== CRM_Core_Action
::UPDATE
) {
215 $fee_level = $defaults[$form->_pId
]['fee_level'];
216 CRM_Event_BAO_Participant
::fixEventLevel($fee_level);
217 $form->assign('fee_level', $fee_level);
218 $form->assign('fee_amount', CRM_Utils_Array
::value('fee_amount', $defaults[$form->_pId
]));
223 if (!empty($defaults[$form->_pId
]['participant_fee_currency'])) {
224 $form->assign('fee_currency', $defaults[$form->_pId
]['participant_fee_currency']);
228 if ($contriId = $form->get('onlinePendingContributionId')) {
229 $defaults[$form->_pId
]['record_contribution'] = 1;
230 $contribution = new CRM_Contribute_DAO_Contribution();
231 $contribution->id
= $contriId;
232 $contribution->find(TRUE);
235 'payment_instrument_id',
236 'contribution_status_id',
240 if ($f == 'receive_date') {
241 list($defaults[$form->_pId
]['receive_date']) = CRM_Utils_Date
::setDateDefaults($contribution->$f);
244 $defaults[$form->_pId
][$f] = $contribution->$f;
248 return $defaults[$form->_pId
];
252 * This function sets the default values for price set.
254 * @param int $participantID
255 * @param int $eventID
256 * @param bool $includeQtyZero
260 public static function setDefaultPriceSet($participantID, $eventID = NULL, $includeQtyZero = TRUE) {
262 if (!$eventID && $participantID) {
263 $eventID = CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_Participant', $participantID, 'event_id');
265 if (!$participantID ||
!$eventID) {
270 $priceSetID = CRM_Price_BAO_PriceSet
::getFor('civicrm_event', $eventID);
275 // use line items for setdefault price set fields, CRM-4090
276 $lineItems[$participantID] = CRM_Price_BAO_LineItem
::getLineItems($participantID, 'participant', FALSE, $includeQtyZero);
278 if (is_array($lineItems[$participantID]) &&
279 !CRM_Utils_System
::isNull($lineItems[$participantID])
282 $priceFields = $htmlTypes = $optionValues = array();
283 foreach ($lineItems[$participantID] as $lineId => $items) {
284 $priceFieldId = CRM_Utils_Array
::value('price_field_id', $items);
285 $priceOptionId = CRM_Utils_Array
::value('price_field_value_id', $items);
286 if ($priceFieldId && $priceOptionId) {
287 $priceFields[$priceFieldId][] = $priceOptionId;
291 if (empty($priceFields)) {
295 // get all price set field html types.
298 FROM civicrm_price_field
299 WHERE id IN (' . implode(',', array_keys($priceFields)) . ')';
300 $fieldDAO = CRM_Core_DAO
::executeQuery($sql);
301 while ($fieldDAO->fetch()) {
302 $htmlTypes[$fieldDAO->id
] = $fieldDAO->html_type
;
305 foreach ($lineItems[$participantID] as $lineId => $items) {
306 $fieldId = $items['price_field_id'];
307 $htmlType = CRM_Utils_Array
::value($fieldId, $htmlTypes);
312 if ($htmlType == 'Text') {
313 $defaults["price_{$fieldId}"] = $items['qty'];
316 $fieldOptValues = CRM_Utils_Array
::value($fieldId, $priceFields);
317 if (!is_array($fieldOptValues)) {
321 foreach ($fieldOptValues as $optionId) {
322 if ($htmlType == 'CheckBox') {
323 $defaults["price_{$fieldId}"][$optionId] = TRUE;
326 $defaults["price_{$fieldId}"] = $optionId;
338 * Build the form object.
340 * @param CRM_Core_Form $form
342 public static function buildQuickForm(&$form) {
343 if ($form->_eventId
) {
344 $form->_isPaidEvent
= CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_Event', $form->_eventId
, 'is_monetary');
345 if ($form->_isPaidEvent
) {
346 $form->addElement('hidden', 'hidden_feeblock', 1);
349 // make sure this is for backoffice registration.
350 if ($form->getName() == 'Participant') {
351 $eventfullMsg = CRM_Event_BAO_Participant
::eventFullMessage($form->_eventId
, $form->_pId
);
352 $form->addElement('hidden', 'hidden_eventFullMsg', $eventfullMsg, array('id' => 'hidden_eventFullMsg'));
357 if (CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_ParticipantPayment',
358 $form->_pId
, 'contribution_id', 'participant_id'
361 $form->_online
= TRUE;
365 if ($form->_isPaidEvent
) {
366 $params = array('id' => $form->_eventId
);
367 CRM_Event_BAO_Event
::retrieve($params, $event);
369 //retrieve custom information
370 $form->_values
= array();
371 CRM_Event_Form_Registration
::initEventFee($form, $event['id']);
372 CRM_Event_Form_Registration_Register
::buildAmount($form, TRUE, $form->_discountId
);
374 $invoiceSettings = Civi
::settings()->get('contribution_invoice_settings');
375 $invoicing = CRM_Utils_Array
::value('invoicing', $invoiceSettings);
377 if (!CRM_Utils_System
::isNull(CRM_Utils_Array
::value('line_items', $form->_values
))) {
378 $lineItem[] = $form->_values
['line_items'];
379 foreach ($form->_values
['line_items'] as $key => $value) {
380 $totalTaxAmount = $value['tax_amount'] +
$totalTaxAmount;
384 $form->assign('totalTaxAmount', $totalTaxAmount);
386 $form->assign('lineItem', empty($lineItem) ?
FALSE : $lineItem);
387 $discounts = array();
388 if (!empty($form->_values
['discount'])) {
389 foreach ($form->_values
['discount'] as $key => $value) {
390 $value = current($value);
391 $discounts[$key] = $value['name'];
394 $element = $form->add('select', 'discount_id',
397 0 => ts('- select -'),
400 array('class' => "crm-select2")
403 if ($form->_online
) {
407 if (CRM_Financial_BAO_FinancialType
::isACLFinancialTypeStatus()
408 && !CRM_Utils_Array
::value('fee', $form->_values
)
409 && CRM_Utils_Array
::value('snippet', $_REQUEST) == CRM_Core_Smarty
::PRINT_NOFORM
411 CRM_Core_Session
::setStatus(ts('You do not have all the permissions needed for this page.'), 'Permission Denied', 'error');
415 CRM_Core_Payment_Form
::buildPaymentForm($form, $form->_paymentProcessor
, FALSE, TRUE, self
::getDefaultPaymentInstrumentId());
417 $form->addElement('checkbox', 'record_contribution', ts('Record Payment?'), NULL,
418 array('onclick' => "return showHideByValue('record_contribution','','payment_information','table-row','radio',false);")
420 // Check permissions for financial type first
421 if (CRM_Financial_BAO_FinancialType
::isACLFinancialTypeStatus()) {
422 CRM_Financial_BAO_FinancialType
::getAvailableFinancialTypes($financialTypes, $form->_action
);
425 $financialTypes = CRM_Contribute_PseudoConstant
::financialType();
428 $form->add('select', 'financial_type_id',
429 ts('Financial Type'),
430 array('' => ts('- select -')) +
$financialTypes
433 $form->addDateTime('receive_date', ts('Received'), FALSE, array('formatType' => 'activityDateTime'));
435 $form->add('select', 'payment_instrument_id',
436 ts('Payment Method'),
437 array('' => ts('- select -')) + CRM_Contribute_PseudoConstant
::paymentInstrument(),
438 FALSE, array('onChange' => "return showHideByValue('payment_instrument_id','4','checkNumber','table-row','select',false);")
440 // don't show transaction id in batch update mode
441 $path = CRM_Utils_System
::currentPath();
442 $form->assign('showTransactionId', FALSE);
443 if ($path != 'civicrm/contact/search/basic') {
444 $form->add('text', 'trxn_id', ts('Transaction ID'));
445 $form->addRule('trxn_id', ts('Transaction ID already exists in Database.'),
446 'objectExists', array('CRM_Contribute_DAO_Contribution', $form->_eventId
, 'trxn_id')
448 $form->assign('showTransactionId', TRUE);
451 $form->add('select', 'contribution_status_id',
452 ts('Payment Status'), CRM_Contribute_BAO_Contribution_Utils
::getContributionStatuses('participant')
455 $form->add('text', 'check_number', ts('Check Number'),
456 CRM_Core_DAO
::getAttribute('CRM_Contribute_DAO_Contribution', 'check_number')
459 $form->add('text', 'total_amount', ts('Amount'),
460 CRM_Core_DAO
::getAttribute('CRM_Contribute_DAO_Contribution', 'total_amount')
465 $form->add('text', 'amount', ts('Event Fee(s)'));
467 $form->assign('onlinePendingContributionId', $form->get('onlinePendingContributionId'));
469 $form->assign('paid', $form->_isPaidEvent
);
471 $form->addElement('checkbox',
473 ts('Send Confirmation?'), NULL,
474 array('onclick' => "showHideByValue('send_receipt','','notice','table-row','radio',false); showHideByValue('send_receipt','','from-email','table-row','radio',false);")
477 $form->add('select', 'from_email_address', ts('Receipt From'), $form->_fromEmails
['from_email_id']);
479 $form->add('textarea', 'receipt_text', ts('Confirmation Message'));
481 // Retrieve the name and email of the contact - form will be the TO for receipt email ( only if context is not standalone)
482 if ($form->_context
!= 'standalone') {
483 if ($form->_contactId
) {
484 list($form->_contributorDisplayName
,
485 $form->_contributorEmail
486 ) = CRM_Contact_BAO_Contact_Location
::getEmailDetails($form->_contactId
);
487 $form->assign('email', $form->_contributorEmail
);
490 //show email block for batch update for event
491 $form->assign('batchEmail', TRUE);
495 $mailingInfo = Civi
::settings()->get('mailing_backend');
496 $form->assign('outBound_option', $mailingInfo['outBound_option']);
497 $form->assign('hasPayment', $form->_paymentId
);
501 * Get the default payment instrument id.
503 * @todo resolve relationship between this form & abstractEdit -which should be it's parent.
507 protected static function getDefaultPaymentInstrumentId() {
508 $paymentInstrumentID = CRM_Utils_Request
::retrieve('payment_instrument_id', 'Integer');
509 if ($paymentInstrumentID) {
510 return $paymentInstrumentID;
512 return key(CRM_Core_OptionGroup
::values('payment_instrument', FALSE, FALSE, FALSE, 'AND is_default = 1'));