3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
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-2019
37 * Business objects for managing price fields.
40 class CRM_Price_BAO_PriceField
extends CRM_Price_DAO_PriceField
{
45 * List of visibility option ID's, of the form name => ID
49 private static $visibilityOptionsKeys;
52 * Takes an associative array and creates a price field object.
54 * the function extract all the params it needs to initialize the create a
55 * price field object. the params array could contain additional unused name/value
58 * @param array $params
59 * (reference) an assoc array of name/value pairs.
61 * @return CRM_Price_BAO_PriceField
63 public static function add(&$params) {
64 $hook = empty($params['id']) ?
'create' : 'edit';
65 CRM_Utils_Hook
::pre($hook, 'PriceField', CRM_Utils_Array
::value('id', $params), $params);
67 $priceFieldBAO = new CRM_Price_BAO_PriceField();
69 $priceFieldBAO->copyValues($params);
71 if ($id = CRM_Utils_Array
::value('id', $params)) {
72 $priceFieldBAO->id
= $id;
75 $priceFieldBAO->save();
76 CRM_Utils_Hook
::post($hook, 'PriceField', $priceFieldBAO->id
, $priceFieldBAO);
77 return $priceFieldBAO;
81 * Takes an associative array and creates a price field object.
83 * This function is invoked from within the web form layer and also from the api layer
85 * @param array $params
86 * (reference) an assoc array of name/value pairs.
88 * @return CRM_Price_DAO_PriceField
90 * @throws \CRM_Core_Exception
91 * @throws \CiviCRM_API3_Exception
93 public static function create(&$params) {
94 if (empty($params['id']) && empty($params['name'])) {
95 $params['name'] = strtolower(CRM_Utils_String
::munge($params['label'], '_', 242));
97 $transaction = new CRM_Core_Transaction();
99 $priceField = self
::add($params);
101 if (is_a($priceField, 'CRM_Core_Error')) {
102 $transaction->rollback();
106 if (!empty($params['id']) && empty($priceField->html_type
)) {
107 $priceField->html_type
= CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceField', $params['id'], 'html_type');
110 $maxIndex = CRM_Price_Form_Field
::NUM_OPTION
;
111 if ($priceField->html_type
== 'Text') {
113 $fieldOptions = civicrm_api3('price_field_value', 'get', [
114 'price_field_id' => $priceField->id
,
117 foreach ($fieldOptions['values'] as $option) {
118 $optionsIds['id'] = $option['id'];
119 // CRM-19741 If we are dealing with price fields that are Text only set the field value label to match
120 if (!empty($params['id']) && $priceField->label
!= $option['label']) {
121 $fieldValue = new CRM_Price_DAO_PriceFieldValue();
122 $fieldValue->label
= $priceField->label
;
123 $fieldValue->id
= $option['id'];
129 //html type would be empty in update scenario not sure what would happen ...
130 if (!empty($params['html_type']) && $params['html_type'] == 'CheckBox' && isset($params['default_checkbox_option'])) {
131 $tempArray = array_keys($params['default_checkbox_option']);
132 foreach ($tempArray as $v) {
133 if ($params['option_amount'][$v]) {
134 $defaultArray[$v] = 1;
139 if (!empty($params['default_option'])) {
140 $defaultArray[$params['default_option']] = 1;
144 for ($index = 1; $index <= $maxIndex; $index++
) {
145 if (array_key_exists('option_amount', $params) &&
146 array_key_exists($index, $params['option_amount']) &&
147 (CRM_Utils_Array
::value($index, CRM_Utils_Array
::value('option_label', $params)) ||
!empty($params['is_quick_config'])) &&
148 !CRM_Utils_System
::isNull($params['option_amount'][$index])
151 'price_field_id' => $priceField->id
,
152 'label' => trim($params['option_label'][$index]),
153 'name' => CRM_Utils_String
::munge($params['option_label'][$index], '_', 64),
154 'amount' => trim($params['option_amount'][$index]),
155 'count' => CRM_Utils_Array
::value($index, CRM_Utils_Array
::value('option_count', $params), NULL),
156 'max_value' => CRM_Utils_Array
::value($index, CRM_Utils_Array
::value('option_max_value', $params), NULL),
157 'description' => CRM_Utils_Array
::value($index, CRM_Utils_Array
::value('option_description', $params), NULL),
158 'membership_type_id' => CRM_Utils_Array
::value($index, CRM_Utils_Array
::value('membership_type_id', $params), NULL),
159 'weight' => $params['option_weight'][$index],
161 'is_default' => CRM_Utils_Array
::value($params['option_weight'][$index], $defaultArray) ?
$defaultArray[$params['option_weight'][$index]] : 0,
162 'membership_num_terms' => NULL,
163 'non_deductible_amount' => CRM_Utils_Array
::value('non_deductible_amount', $params),
164 'visibility_id' => CRM_Utils_Array
::value($index, CRM_Utils_Array
::value('option_visibility_id', $params), self
::getVisibilityOptionID('public')),
167 if ($options['membership_type_id']) {
168 $options['membership_num_terms'] = CRM_Utils_Array
::value($index, CRM_Utils_Array
::value('membership_num_terms', $params), 1);
169 $options['is_default'] = CRM_Utils_Array
::value($params['membership_type_id'][$index], $defaultArray) ?
$defaultArray[$params['membership_type_id'][$index]] : 0;
172 if (CRM_Utils_Array
::value($index, CRM_Utils_Array
::value('option_financial_type_id', $params))) {
173 $options['financial_type_id'] = $params['option_financial_type_id'][$index];
175 elseif (!empty($params['financial_type_id'])) {
176 $options['financial_type_id'] = $params['financial_type_id'];
178 if ($opIds = CRM_Utils_Array
::value('option_id', $params)) {
179 if ($opId = CRM_Utils_Array
::value($index, $opIds)) {
180 $optionsIds['id'] = $opId;
183 $optionsIds['id'] = NULL;
187 CRM_Price_BAO_PriceFieldValue
::create($options, $optionsIds);
189 catch (Exception
$e) {
190 $transaction->rollback();
191 throw new CRM_Core_Exception($e->getMessage());
194 elseif (!empty($optionsIds) && !empty($optionsIds['id'])) {
195 $optionsLoad = civicrm_api3('price_field_value', 'get', ['id' => $optionsIds['id']]);
196 $options = $optionsLoad['values'][$optionsIds['id']];
197 $options['is_active'] = CRM_Utils_Array
::value('is_active', $params, 1);
199 CRM_Price_BAO_PriceFieldValue
::create($options, $optionsIds);
201 catch (Exception
$e) {
202 $transaction->rollback();
203 throw new CRM_Core_Exception($e->getMessage());
208 $transaction->commit();
213 * Fetch object based on array of properties.
215 * @param array $params
216 * (reference ) an assoc array of name/value pairs.
217 * @param array $defaults
218 * (reference ) an assoc array to hold the flattened values.
220 * @return CRM_Price_DAO_PriceField
222 public static function retrieve(&$params, &$defaults) {
223 return CRM_Core_DAO
::commonRetrieve('CRM_Price_DAO_PriceField', $params, $defaults);
227 * Update the is_active flag in the db.
230 * Id of the database record.
231 * @param bool $is_active
232 * Value we want to set the is_active field.
235 * true if we found and updated the object, else false
237 public static function setIsActive($id, $is_active) {
238 return CRM_Core_DAO
::setFieldValue('CRM_Price_DAO_PriceField', $id, 'is_active', $is_active);
242 * Freeze form if the event is full.
245 * @param $fieldOptions
249 public static function freezeIfEnabled(&$element, $fieldOptions) {
250 if (!empty($fieldOptions['is_full'])) {
257 * Get the field title.
266 public static function getTitle($id) {
267 return CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceField', $id, 'label');
271 * This function for building custom fields.
273 * @param CRM_Core_Form $qf
274 * Form object (reference).
275 * @param string $elementName
276 * Name of the custom field.
277 * @param int $fieldId
278 * @param bool $inactiveNeeded
279 * @param bool $useRequired
280 * True if required else false.
281 * @param string $label
282 * Label for custom field.
284 * @param null $fieldOptions
285 * @param array $freezeOptions
289 public static function addQuickFormElement(
296 $fieldOptions = NULL,
300 $field = new CRM_Price_DAO_PriceField();
301 $field->id
= $fieldId;
302 if (!$field->find(TRUE)) {
303 /* FIXME: failure! */
308 if (isset($qf->_mode
) && empty($qf->_mode
)) {
311 elseif (isset($qf->_values
)) {
312 $is_pay_later = CRM_Utils_Array
::value('is_pay_later', $qf->_values
);
315 $otherAmount = $qf->get('values');
316 $config = CRM_Core_Config
::singleton();
317 $currencySymbol = CRM_Core_DAO
::getFieldValue('CRM_Financial_DAO_Currency', $config->defaultCurrency
, 'symbol', 'name');
318 $qf->assign('currencySymbol', $currencySymbol);
319 // get currency name for price field and option attributes
320 $currencyName = $config->defaultCurrency
;
322 if (!isset($label)) {
323 $label = (!empty($qf->_membershipBlock
) && $field->name
== 'contribution_amount') ?
ts('Additional Contribution') : $field->label
;
326 if ($field->name
== 'contribution_amount') {
327 $qf->_contributionAmount
= 1;
330 if (isset($qf->_online
) && $qf->_online
) {
331 $useRequired = FALSE;
334 $customOption = $fieldOptions;
335 if (!is_array($customOption)) {
336 $customOption = CRM_Price_BAO_PriceField
::getOptions($field->id
, $inactiveNeeded);
340 $valueFieldName = 'amount';
342 $invoiceSettings = Civi
::settings()->get('contribution_invoice_settings');
343 $taxTerm = CRM_Utils_Array
::value('tax_term', $invoiceSettings);
344 $displayOpt = CRM_Utils_Array
::value('tax_display_settings', $invoiceSettings);
345 $invoicing = CRM_Utils_Array
::value('invoicing', $invoiceSettings);
346 switch ($field->html_type
) {
348 $optionKey = key($customOption);
349 $count = CRM_Utils_Array
::value('count', $customOption[$optionKey], '');
350 $max_value = CRM_Utils_Array
::value('max_value', $customOption[$optionKey], '');
351 $taxAmount = CRM_Utils_Array
::value('tax_amount', $customOption[$optionKey]);
352 if (isset($taxAmount) && $displayOpt && $invoicing) {
353 $qf->assign('displayOpt', $displayOpt);
354 $qf->assign('taxTerm', $taxTerm);
355 $qf->assign('invoicing', $invoicing);
357 $priceVal = implode($seperator, [
358 $customOption[$optionKey][$valueFieldName] +
$taxAmount,
364 if (!empty($qf->_membershipBlock
) && !empty($qf->_quickConfig
) && $field->name
== 'other_amount' && empty($qf->_contributionAmount
)) {
367 elseif (!empty($fieldOptions[$optionKey]['label'])) {
369 $label = $fieldOptions[$optionKey]['label'];
370 if (!empty($qf->_quickConfig
) && !empty($qf->_contributionAmount
) && strtolower($fieldOptions[$optionKey]['name']) == 'other_amount') {
371 $label .= ' ' . $currencySymbol;
372 $qf->assign('priceset', $elementName);
373 $extra = ['onclick' => 'useAmountOther();'];
377 $element = &$qf->add('text', $elementName, $label,
380 'price' => json_encode([$optionKey, $priceVal]),
384 $useRequired && $field->is_required
387 $qf->add('text', 'txt-' . $elementName, $label, ['size' => '4']);
390 // CRM-6902 - Add "max" option for a price set field
391 if (in_array($optionKey, $freezeOptions)) {
392 self
::freezeIfEnabled($element, $fieldOptions[$optionKey]);
393 // CRM-14696 - Improve display for sold out price set options
394 $element->setLabel($label . ' <span class="sold-out-option">' . ts('Sold out') . '</span>');
398 if (!empty($qf->_quickConfig
)) {
399 $message = ts('Please enter a valid amount.');
403 $message = ts('%1 must be a number (with or without decimal point).', [1 => $label]);
406 // integers will have numeric rule applied to them.
407 $qf->addRule($elementName, $message, $type);
413 if (!empty($qf->_quickConfig
) && !empty($qf->_contributionAmount
)) {
414 $qf->assign('contriPriceset', $elementName);
417 foreach ($customOption as $opId => $opt) {
418 $taxAmount = CRM_Utils_Array
::value('tax_amount', $opt);
419 if ($field->is_display_amounts
) {
420 $opt['label'] = !empty($opt['label']) ?
$opt['label'] . '<span class="crm-price-amount-label-separator"> - </span>' : '';
421 $preHelpText = $postHelpText = '';
422 if (!empty($opt['help_pre'])) {
423 $preHelpText = '<span class="crm-price-amount-help-pre description">' . $opt['help_pre'] . '</span>: ';
425 if (!empty($opt['help_post'])) {
426 $postHelpText = ': <span class="crm-price-amount-help-post description">' . $opt['help_post'] . '</span>';
428 if (isset($taxAmount) && $invoicing) {
429 if ($displayOpt == 'Do_not_show') {
430 $opt['label'] = '<span class="crm-price-amount-label">' . $opt['label'] . '</span>' . '<span class="crm-price-amount-amount">' . CRM_Utils_Money
::format($opt[$valueFieldName] +
$taxAmount) . '</span>';
432 elseif ($displayOpt == 'Inclusive') {
433 $opt['label'] = '<span class="crm-price-amount-label">' . $opt['label'] . '</span>' . '<span class="crm-price-amount-amount">' . CRM_Utils_Money
::format($opt[$valueFieldName] +
$taxAmount) . '</span>';
434 $opt['label'] .= '<span class="crm-price-amount-tax"> (includes ' . $taxTerm . ' of ' . CRM_Utils_Money
::format($opt['tax_amount']) . ')</span>';
437 $opt['label'] = '<span class="crm-price-amount-label">' . $opt['label'] . '</span>' . '<span class="crm-price-amount-amount">' . CRM_Utils_Money
::format($opt[$valueFieldName]) . '</span>';
438 $opt['label'] .= '<span class="crm-price-amount-tax"> + ' . CRM_Utils_Money
::format($opt['tax_amount']) . ' ' . $taxTerm . '</span>';
442 $opt['label'] = '<span class="crm-price-amount-label">' . $opt['label'] . '</span>' . '<span class="crm-price-amount-amount">' . CRM_Utils_Money
::format($opt[$valueFieldName]) . '</span>';
444 $opt['label'] = $preHelpText . $opt['label'] . $postHelpText;
446 $count = CRM_Utils_Array
::value('count', $opt, '');
447 $max_value = CRM_Utils_Array
::value('max_value', $opt, '');
448 $priceVal = implode($seperator, [$opt[$valueFieldName] +
$taxAmount, $count, $max_value]);
449 if (isset($opt['visibility_id'])) {
450 $visibility_id = $opt['visibility_id'];
453 $visibility_id = self
::getVisibilityOptionID('public');
456 'price' => json_encode([$elementName, $priceVal]),
457 'data-amount' => $opt[$valueFieldName],
458 'data-currency' => $currencyName,
459 'data-price-field-values' => json_encode($customOption),
460 'visibility' => $visibility_id,
462 if (!empty($qf->_quickConfig
) && $field->name
== 'contribution_amount') {
463 $extra +
= ['onclick' => 'clearAmountOther();'];
465 if ($field->name
== 'membership_amount') {
467 'onclick' => "return showHideAutoRenew({$opt['membership_type_id']});",
468 'membership-type' => $opt['membership_type_id'],
470 $qf->assign('membershipFieldID', $field->id
);
473 $choice[$opId] = $qf->createElement('radio', NULL, '', $opt['label'], $opt['id'], $extra);
475 $qf->add('text', 'txt-' . $elementName, $label, ['size' => '4']);
478 // CRM-6902 - Add "max" option for a price set field
479 if (in_array($opId, $freezeOptions)) {
480 self
::freezeIfEnabled($choice[$opId], $customOption[$opId]);
481 // CRM-14696 - Improve display for sold out price set options
482 $choice[$opId]->setText('<span class="sold-out-option">' . $choice[$opId]->getText() . ' (' . ts('Sold out') . ')</span>');
485 if (!empty($qf->_membershipBlock
) && $field->name
== 'contribution_amount') {
486 $choice[] = $qf->createElement('radio', NULL, '', ts('No thank you'), '-1',
488 'price' => json_encode([$elementName, '0|0']),
489 'data-currency' => $currencyName,
490 'onclick' => 'clearAmountOther();',
495 if (!$field->is_required
) {
497 if (!empty($otherAmount['is_allow_other_amount']) && $field->name
== 'contribution_amount') {
498 $none = ts('Other Amount');
500 elseif (!empty($qf->_membershipBlock
) && empty($qf->_membershipBlock
['is_required']) && $field->name
== 'membership_amount') {
501 $none = ts('No thank you');
504 $none = ts('- none -');
507 $choice[] = $qf->createElement('radio', NULL, '', $none, '0',
508 ['price' => json_encode([$elementName, '0'])]
512 $element = &$qf->addGroup($choice, $elementName, $label);
514 // make contribution field required for quick config when membership block is enabled
515 if (($field->name
== 'membership_amount' ||
$field->name
== 'contribution_amount')
516 && !empty($qf->_membershipBlock
) && !$field->is_required
518 $useRequired = $field->is_required
= TRUE;
521 if ($useRequired && $field->is_required
) {
522 $qf->addRule($elementName, ts('%1 is a required field.', [1 => $label]), 'required');
527 $selectOption = $allowedOptions = $priceVal = [];
529 foreach ($customOption as $opt) {
530 $taxAmount = CRM_Utils_Array
::value('tax_amount', $opt);
531 $count = CRM_Utils_Array
::value('count', $opt, '');
532 $max_value = CRM_Utils_Array
::value('max_value', $opt, '');
534 if ($field->is_display_amounts
) {
535 $opt['label'] .= ' - ';
536 if (isset($taxAmount) && $invoicing) {
537 $opt['label'] = $opt['label'] . self
::getTaxLabel($opt, $valueFieldName, $displayOpt, $taxTerm);
540 $opt['label'] = $opt['label'] . CRM_Utils_Money
::format($opt[$valueFieldName]);
544 $priceVal[$opt['id']] = implode($seperator, [$opt[$valueFieldName] +
$taxAmount, $count, $max_value]);
546 if (!in_array($opt['id'], $freezeOptions)) {
547 $allowedOptions[] = $opt['id'];
549 // CRM-14696 - Improve display for sold out price set options
551 $opt['id'] = 'crm_disabled_opt-' . $opt['id'];
552 $opt['label'] = $opt['label'] . ' (' . ts('Sold out') . ')';
555 $selectOption[$opt['id']] = $opt['label'];
558 $qf->add('text', 'txt-' . $elementName, $label, ['size' => '4']);
561 if (isset($opt['visibility_id'])) {
562 $visibility_id = $opt['visibility_id'];
565 $visibility_id = self
::getVisibilityOptionID('public');
567 $element = &$qf->add('select', $elementName, $label,
569 '' => ts('- select -'),
571 $useRequired && $field->is_required
,
572 ['price' => json_encode($priceVal), 'class' => 'crm-select2', 'data-price-field-values' => json_encode($customOption)]
575 // CRM-6902 - Add "max" option for a price set field
576 $button = substr($qf->controller
->getButtonName(), -4);
577 if (!empty($freezeOptions) && $button != 'skip') {
578 $qf->addRule($elementName, ts('Sorry, this option is currently sold out.'), 'regex', "/" . implode('|', $allowedOptions) . "/");
585 foreach ($customOption as $opId => $opt) {
586 $taxAmount = CRM_Utils_Array
::value('tax_amount', $opt);
587 $count = CRM_Utils_Array
::value('count', $opt, '');
588 $max_value = CRM_Utils_Array
::value('max_value', $opt, '');
590 if ($field->is_display_amounts
) {
591 $preHelpText = $postHelpText = '';
592 if (isset($opt['help_pre'])) {
593 $preHelpText = '<span class="crm-price-amount-help-pre description">' . $opt['help_pre'] . '</span>: ';
595 if (isset($opt['help_post'])) {
596 $postHelpText = ': <span class="crm-price-amount-help-post description">' . $opt['help_post'] . '</span>';
598 $opt['label'] = '<span class="crm-price-amount-label">' . $opt['label'] . '</span> - ';
599 if (isset($taxAmount) && $invoicing) {
600 $opt['label'] .= self
::getTaxLabel($opt, $valueFieldName, $displayOpt, $taxTerm);
603 $opt['label'] .= CRM_Utils_Money
::format($opt[$valueFieldName]);
605 $opt['label'] = $preHelpText . $opt['label'] . $postHelpText;
607 $priceVal = implode($seperator, [$opt[$valueFieldName] +
$taxAmount, $count, $max_value]);
608 $check[$opId] = &$qf->createElement('checkbox', $opt['id'], NULL, $opt['label'],
610 'price' => json_encode([$opt['id'], $priceVal]),
611 'data-amount' => $opt[$valueFieldName],
612 'data-currency' => $currencyName,
613 'visibility' => $opt['visibility_id'],
617 $txtcheck[$opId] =& $qf->createElement('text', $opId, $opt['label'], ['size' => '4']);
618 $qf->addGroup($txtcheck, 'txt-' . $elementName, $label);
620 // CRM-6902 - Add "max" option for a price set field
621 if (in_array($opId, $freezeOptions)) {
622 self
::freezeIfEnabled($check[$opId], $customOption[$opId]);
623 // CRM-14696 - Improve display for sold out price set options
624 $check[$opId]->setText('<span class="sold-out-option">' . $check[$opId]->getText() . ' (' . ts('Sold out') . ')</span>');
627 $element = &$qf->addGroup($check, $elementName, $label);
628 if ($useRequired && $field->is_required
) {
629 $qf->addRule($elementName, ts('%1 is a required field.', [1 => $label]), 'required');
633 if (isset($qf->_online
) && $qf->_online
) {
639 * Retrieve a list of options for the specified field.
641 * @param int $fieldId
643 * @param bool $inactiveNeeded
644 * Include inactive options.
646 * Discard stored values.
647 * @param bool $isDefaultContributionPriceSet
648 * Discard tax amount calculation for price set = default_contribution_amount.
653 public static function getOptions($fieldId, $inactiveNeeded = FALSE, $reset = FALSE, $isDefaultContributionPriceSet = FALSE) {
654 if ($reset ||
!isset(Civi
::$statics[__CLASS__
]['priceOptions'])) {
655 Civi
::$statics[__CLASS__
]['priceOptions'] = [];
656 // This would happen if the function was only called to clear the cache.
657 if (empty($fieldId)) {
662 if (empty(Civi
::$statics[__CLASS__
]['priceOptions'][$fieldId])) {
663 $values = $options = [];
664 CRM_Price_BAO_PriceFieldValue
::getValues($fieldId, $values, 'weight', !$inactiveNeeded);
665 $options[$fieldId] = $values;
666 $taxRates = CRM_Core_PseudoConstant
::getTaxRates();
668 // ToDo - Code for Hook Invoke
670 foreach ($options[$fieldId] as $priceFieldId => $priceFieldValues) {
671 if (isset($priceFieldValues['financial_type_id']) && array_key_exists($priceFieldValues['financial_type_id'], $taxRates) && !$isDefaultContributionPriceSet) {
672 $options[$fieldId][$priceFieldId]['tax_rate'] = $taxRates[$priceFieldValues['financial_type_id']];
673 $taxAmount = CRM_Contribute_BAO_Contribution_Utils
::calculateTaxAmount($priceFieldValues['amount'], $options[$fieldId][$priceFieldId]['tax_rate']);
674 $options[$fieldId][$priceFieldId]['tax_amount'] = $taxAmount['tax_amount'];
677 Civi
::$statics[__CLASS__
]['priceOptions'][$fieldId] = $options[$fieldId];
680 return Civi
::$statics[__CLASS__
]['priceOptions'][$fieldId];
684 * @param $optionLabel
689 public static function getOptionId($optionLabel, $fid) {
690 if (!$optionLabel ||
!$fid) {
694 $optionGroupName = "civicrm_price_field.amount.{$fid}";
698 option_value.id as id
700 civicrm_option_value option_value,
701 civicrm_option_group option_group
703 option_group.name = %1
704 AND option_group.id = option_value.option_group_id
705 AND option_value.label = %2";
707 $dao = CRM_Core_DAO
::executeQuery($query, [
708 1 => [$optionGroupName, 'String'],
709 2 => [$optionLabel, 'String'],
712 while ($dao->fetch()) {
718 * Delete the price set field.
726 public static function deleteField($id) {
727 $field = new CRM_Price_DAO_PriceField();
730 if ($field->find(TRUE)) {
731 // delete the options for this field
732 CRM_Price_BAO_PriceFieldValue
::deleteValues($id);
734 // reorder the weight before delete
735 $fieldValues = ['price_set_id' => $field->price_set_id
];
737 CRM_Utils_Weight
::delWeight('CRM_Price_DAO_PriceField', $field->id
, $fieldValues);
739 // now delete the field
740 return $field->delete();
749 public static function &htmlTypes() {
750 static $htmlTypes = NULL;
753 'Text' => ts('Text / Numeric Quantity'),
754 'Select' => ts('Select'),
755 'Radio' => ts('Radio'),
756 'CheckBox' => ts('CheckBox'),
763 * Validate the priceset.
765 * @param int $priceSetId
768 * retrun the error string
772 * @param bool $allowNoneSelection
775 public static function priceSetValidation($priceSetId, $fields, &$error, $allowNoneSelection = FALSE) {
776 // check for at least one positive
777 // amount price field should be selected.
778 $priceField = new CRM_Price_DAO_PriceField();
779 $priceField->price_set_id
= $priceSetId;
784 if ($allowNoneSelection) {
785 $noneSelectedPriceFields = [];
788 while ($priceField->fetch()) {
789 $key = "price_{$priceField->id}";
791 if ($allowNoneSelection) {
792 if (array_key_exists($key, $fields)) {
793 if ($fields[$key] == 0 && !$priceField->is_required
) {
794 $noneSelectedPriceFields[] = $priceField->id
;
799 if (!empty($fields[$key])) {
800 $priceFields[$priceField->id
] = $fields[$key];
804 if (!empty($priceFields)) {
805 // we should has to have positive amount.
808 FROM civicrm_price_field
809 WHERE id IN (" . implode(',', array_keys($priceFields)) . ')';
810 $fieldDAO = CRM_Core_DAO
::executeQuery($sql);
812 while ($fieldDAO->fetch()) {
813 $htmlTypes[$fieldDAO->id
] = $fieldDAO->html_type
;
816 $selectedAmounts = [];
818 foreach ($htmlTypes as $fieldId => $type) {
820 CRM_Price_BAO_PriceFieldValue
::getValues($fieldId, $options);
822 if (empty($options)) {
826 if ($type == 'Text') {
827 foreach ($options as $opId => $option) {
828 $selectedAmounts[$opId] = $priceFields[$fieldId] * $option['amount'];
832 elseif (is_array($fields["price_{$fieldId}"])) {
833 foreach (array_keys($fields["price_{$fieldId}"]) as $opId) {
834 $selectedAmounts[$opId] = $options[$opId]['amount'];
837 elseif (in_array($fields["price_{$fieldId}"], array_keys($options))) {
838 $selectedAmounts[$fields["price_{$fieldId}"]] = $options[$fields["price_{$fieldId}"]]['amount'];
842 list($componentName) = explode(':', $fields['_qf_default']);
843 // now we have all selected amount in hand.
844 $totalAmount = array_sum($selectedAmounts);
845 // The form offers a field to enter the amount paid. This may differ from the amount that is due to complete the purchase
846 $totalPaymentAmountEnteredOnForm = CRM_Utils_Array
::value('partial_payment_total', $fields, CRM_Utils_Array
::value('total_amount', $fields));
847 if ($totalAmount < 0) {
848 $error['_qf_default'] = ts('%1 amount can not be less than zero. Please select the options accordingly.', [1 => $componentName]);
850 elseif ($totalAmount > 0 &&
851 // if total amount is equal to all selected amount in hand
852 $totalPaymentAmountEnteredOnForm >= $totalAmount &&
853 (CRM_Utils_Array
::value('contribution_status_id', $fields) == CRM_Core_PseudoConstant
::getKey('CRM_Contribute_DAO_Contribution', 'contribution_status_id', 'Partially paid'))
855 $error['total_amount'] = ts('You have specified the status Partially Paid but have entered an amount that equals or exceeds the amount due. Please adjust the status of the payment or the amount');
859 if ($allowNoneSelection) {
860 if (empty($noneSelectedPriceFields)) {
861 $error['_qf_default'] = ts('Please select at least one option from price set.');
865 $error['_qf_default'] = ts('Please select at least one option from price set.');
871 * Generate the label for price fields based on tax display setting option on CiviContribute Component Settings page.
874 * @param string $valueFieldName
876 * @param string $displayOpt
877 * Tax display setting option.
879 * @param string $taxTerm
882 * Tax label for custom field.
884 public static function getTaxLabel($opt, $valueFieldName, $displayOpt, $taxTerm) {
885 if ($displayOpt == 'Do_not_show') {
886 $label = CRM_Utils_Money
::format($opt[$valueFieldName] +
$opt['tax_amount']);
888 elseif ($displayOpt == 'Inclusive') {
889 $label = CRM_Utils_Money
::format($opt[$valueFieldName] +
$opt['tax_amount']);
890 $label .= '<span class="crm-price-amount-tax"> (includes ' . $taxTerm . ' of ' . CRM_Utils_Money
::format($opt['tax_amount']) . ')</span>';
893 $label = CRM_Utils_Money
::format($opt[$valueFieldName]);
894 $label .= '<span class="crm-price-amount-tax"> + ' . CRM_Utils_Money
::format($opt['tax_amount']) . ' ' . $taxTerm . '</span>';
901 * Given the name of a visibility option, returns its ID.
903 * @param string $visibilityName
907 public static function getVisibilityOptionID($visibilityName) {
909 if (!isset(self
::$visibilityOptionsKeys)) {
910 self
::$visibilityOptionsKeys = CRM_Price_BAO_PriceField
::buildOptions(
914 'labelColumn' => 'name',
920 if (isset(self
::$visibilityOptionsKeys[$visibilityName])) {
921 return self
::$visibilityOptionsKeys[$visibilityName];