3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
6 | This work is published under the GNU AGPLv3 license with some |
7 | permitted exceptions and without any warranty. For full license |
8 | and copyright information, see https://civicrm.org/licensing |
9 +--------------------------------------------------------------------+
13 * Business objects for managing price fields.
16 class CRM_Price_BAO_PriceField
extends CRM_Price_DAO_PriceField
{
21 * List of visibility option ID's, of the form name => ID
25 private static $visibilityOptionsKeys;
28 * Create or update a PriceField.
30 * @param array $params
31 * @return CRM_Price_DAO_PriceField
33 public static function add($params) {
34 return self
::writeRecord($params);
38 * Takes an associative array and creates a price field object.
40 * This function is invoked from within the web form layer and also from the api layer
42 * @param array $params
43 * (reference) an assoc array of name/value pairs.
45 * @return CRM_Price_DAO_PriceField
47 * @throws \CRM_Core_Exception
48 * @throws \CiviCRM_API3_Exception
50 public static function create(&$params) {
51 if (empty($params['id']) && empty($params['name'])) {
52 $params['name'] = strtolower(CRM_Utils_String
::munge($params['label'], '_', 242));
54 $transaction = new CRM_Core_Transaction();
56 $priceField = self
::add($params);
58 if (is_a($priceField, 'CRM_Core_Error')) {
59 $transaction->rollback();
63 if (!empty($params['id']) && empty($priceField->html_type
)) {
64 $priceField->html_type
= CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceField', $params['id'], 'html_type');
67 $maxIndex = CRM_Price_Form_Field
::NUM_OPTION
;
68 if ($priceField->html_type
== 'Text') {
70 $fieldOptions = civicrm_api3('price_field_value', 'get', [
71 'price_field_id' => $priceField->id
,
74 foreach ($fieldOptions['values'] as $option) {
75 $optionsIds['id'] = $option['id'];
76 $params['option_id'] = [1 => $option['id']];
77 // CRM-19741 If we are dealing with price fields that are Text only set the field value label to match
78 if (!empty($params['id']) && $priceField->label
!= $option['label']) {
79 $fieldValue = new CRM_Price_DAO_PriceFieldValue();
80 $fieldValue->label
= $priceField->label
;
81 $fieldValue->id
= $option['id'];
87 //html type would be empty in update scenario not sure what would happen ...
88 if (!empty($params['html_type']) && $params['html_type'] == 'CheckBox' && isset($params['default_checkbox_option'])) {
89 $tempArray = array_keys($params['default_checkbox_option']);
90 foreach ($tempArray as $v) {
91 if ($params['option_amount'][$v]) {
92 $defaultArray[$v] = 1;
97 if (!empty($params['default_option'])) {
98 $defaultArray[$params['default_option']] = 1;
102 for ($index = 1; $index <= $maxIndex; $index++
) {
103 if (array_key_exists('option_amount', $params) &&
104 array_key_exists($index, $params['option_amount']) &&
105 (CRM_Utils_Array
::value($index, CRM_Utils_Array
::value('option_label', $params)) ||
!empty($params['is_quick_config'])) &&
106 !CRM_Utils_System
::isNull($params['option_amount'][$index])
109 'price_field_id' => $priceField->id
,
110 'label' => trim($params['option_label'][$index]),
111 'name' => CRM_Utils_String
::munge($params['option_label'][$index], '_', 64),
112 'amount' => trim($params['option_amount'][$index]),
113 'count' => CRM_Utils_Array
::value($index, CRM_Utils_Array
::value('option_count', $params), NULL),
114 'max_value' => CRM_Utils_Array
::value($index, CRM_Utils_Array
::value('option_max_value', $params), NULL),
115 'description' => CRM_Utils_Array
::value($index, CRM_Utils_Array
::value('option_description', $params), NULL),
116 'membership_type_id' => CRM_Utils_Array
::value($index, CRM_Utils_Array
::value('membership_type_id', $params), NULL),
117 'weight' => $params['option_weight'][$index],
119 'is_default' => !empty($defaultArray[$params['option_weight'][$index]]) ?
$defaultArray[$params['option_weight'][$index]] : 0,
120 'membership_num_terms' => NULL,
121 'non_deductible_amount' => $params['non_deductible_amount'] ??
NULL,
122 'visibility_id' => CRM_Utils_Array
::value($index, CRM_Utils_Array
::value('option_visibility_id', $params), self
::getVisibilityOptionID('public')),
125 if ($options['membership_type_id']) {
126 $options['membership_num_terms'] = CRM_Utils_Array
::value($index, CRM_Utils_Array
::value('membership_num_terms', $params), 1);
127 $options['is_default'] = !empty($defaultArray[$params['membership_type_id'][$index]]) ?
$defaultArray[$params['membership_type_id'][$index]] : 0;
130 if (CRM_Utils_Array
::value($index, CRM_Utils_Array
::value('option_financial_type_id', $params))) {
131 $options['financial_type_id'] = $params['option_financial_type_id'][$index];
133 elseif (!empty($params['financial_type_id'])) {
134 $options['financial_type_id'] = $params['financial_type_id'];
136 if ($opIds = CRM_Utils_Array
::value('option_id', $params)) {
137 if ($opId = CRM_Utils_Array
::value($index, $opIds)) {
138 $options['id'] = $opId;
141 $options['id'] = NULL;
145 CRM_Price_BAO_PriceFieldValue
::create($options, $optionsIds);
147 catch (Exception
$e) {
148 $transaction->rollback();
149 throw new CRM_Core_Exception($e->getMessage());
152 elseif (!empty($optionsIds) && !empty($optionsIds['id'])) {
153 $optionsLoad = civicrm_api3('price_field_value', 'get', ['id' => $optionsIds['id']]);
154 $options = $optionsLoad['values'][$optionsIds['id']];
155 $options['is_active'] = CRM_Utils_Array
::value('is_active', $params, 1);
157 CRM_Price_BAO_PriceFieldValue
::create($options, $optionsIds);
159 catch (Exception
$e) {
160 $transaction->rollback();
161 throw new CRM_Core_Exception($e->getMessage());
166 $transaction->commit();
171 * Fetch object based on array of properties.
173 * @param array $params
174 * (reference ) an assoc array of name/value pairs.
175 * @param array $defaults
176 * (reference ) an assoc array to hold the flattened values.
178 * @return CRM_Price_DAO_PriceField
180 public static function retrieve(&$params, &$defaults) {
181 return CRM_Core_DAO
::commonRetrieve('CRM_Price_DAO_PriceField', $params, $defaults);
185 * Update the is_active flag in the db.
188 * Id of the database record.
189 * @param bool $is_active
190 * Value we want to set the is_active field.
193 * true if we found and updated the object, else false
195 public static function setIsActive($id, $is_active) {
196 return CRM_Core_DAO
::setFieldValue('CRM_Price_DAO_PriceField', $id, 'is_active', $is_active);
200 * Freeze form if the event is full.
203 * @param $fieldOptions
207 public static function freezeIfEnabled(&$element, $fieldOptions) {
208 if (!empty($fieldOptions['is_full'])) {
215 * Get the field title.
224 public static function getTitle($id) {
225 return CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceField', $id, 'label');
229 * This function for building custom fields.
231 * @param CRM_Core_Form $qf
232 * Form object (reference).
233 * @param string $elementName
234 * Name of the custom field.
235 * @param int $fieldId
236 * @param bool $inactiveNeeded
237 * @param bool $useRequired
238 * True if required else false.
239 * @param string $label
240 * Label for custom field.
242 * @param null $fieldOptions
243 * @param array $freezeOptions
247 public static function addQuickFormElement(
254 $fieldOptions = NULL,
258 $field = new CRM_Price_DAO_PriceField();
259 $field->id
= $fieldId;
260 if (!$field->find(TRUE)) {
261 /* FIXME: failure! */
266 if (isset($qf->_mode
) && empty($qf->_mode
)) {
269 elseif (isset($qf->_values
)) {
270 $is_pay_later = $qf->_values
['is_pay_later'] ??
NULL;
273 $otherAmount = $qf->get('values');
274 $config = CRM_Core_Config
::singleton();
275 $currencySymbol = CRM_Core_DAO
::getFieldValue('CRM_Financial_DAO_Currency', $config->defaultCurrency
, 'symbol', 'name');
276 $qf->assign('currencySymbol', $currencySymbol);
277 // get currency name for price field and option attributes
278 $currencyName = $config->defaultCurrency
;
280 if (!isset($label)) {
281 $label = (!empty($qf->_membershipBlock
) && $field->name
== 'contribution_amount') ?
ts('Additional Contribution') : $field->label
;
284 if ($field->name
== 'contribution_amount') {
285 $qf->_contributionAmount
= 1;
288 if (isset($qf->_online
) && $qf->_online
) {
289 $useRequired = FALSE;
292 $customOption = $fieldOptions;
293 if (!is_array($customOption)) {
294 $customOption = CRM_Price_BAO_PriceField
::getOptions($field->id
, $inactiveNeeded);
298 $valueFieldName = 'amount';
300 $invoiceSettings = Civi
::settings()->get('contribution_invoice_settings');
301 $taxTerm = Civi
::settings()->get('tax_term');
302 $displayOpt = $invoiceSettings['tax_display_settings'] ??
NULL;
303 $invoicing = $invoiceSettings['invoicing'] ??
NULL;
304 switch ($field->html_type
) {
306 $optionKey = key($customOption);
307 $count = CRM_Utils_Array
::value('count', $customOption[$optionKey], '');
308 $max_value = CRM_Utils_Array
::value('max_value', $customOption[$optionKey], '');
309 $taxAmount = $customOption[$optionKey]['tax_amount'] ??
NULL;
310 if (isset($taxAmount) && $displayOpt && $invoicing) {
311 $qf->assign('displayOpt', $displayOpt);
312 $qf->assign('taxTerm', $taxTerm);
313 $qf->assign('invoicing', $invoicing);
315 $priceVal = implode($seperator, [
316 $customOption[$optionKey][$valueFieldName] +
$taxAmount,
322 if (!empty($qf->_membershipBlock
) && !empty($qf->_quickConfig
) && $field->name
== 'other_amount' && empty($qf->_contributionAmount
)) {
325 elseif (!empty($fieldOptions[$optionKey]['label'])) {
327 $label = $fieldOptions[$optionKey]['label'];
328 if (!empty($qf->_quickConfig
) && !empty($qf->_contributionAmount
) && strtolower($fieldOptions[$optionKey]['name']) == 'other_amount') {
329 $label .= ' ' . $currencySymbol;
330 $qf->assign('priceset', $elementName);
331 $extra = ['onclick' => 'useAmountOther();'];
335 $element = &$qf->add('text', $elementName, $label,
338 'price' => json_encode([$optionKey, $priceVal]),
342 $useRequired && $field->is_required
345 $qf->add('text', 'txt-' . $elementName, $label, ['size' => '4']);
348 // CRM-6902 - Add "max" option for a price set field
349 if (in_array($optionKey, $freezeOptions)) {
350 self
::freezeIfEnabled($element, $fieldOptions[$optionKey]);
351 // CRM-14696 - Improve display for sold out price set options
352 $element->setLabel($label . ' <span class="sold-out-option">' . ts('Sold out') . '</span>');
356 if (!empty($qf->_quickConfig
)) {
357 $message = ts('Please enter a valid amount.');
361 $message = ts('%1 must be a number (with or without decimal point).', [1 => $label]);
364 // integers will have numeric rule applied to them.
365 $qf->addRule($elementName, $message, $type);
371 if (!empty($qf->_quickConfig
) && !empty($qf->_contributionAmount
)) {
372 $qf->assign('contriPriceset', $elementName);
375 foreach ($customOption as $opId => $opt) {
376 $taxAmount = $opt['tax_amount'] ??
NULL;
377 if ($field->is_display_amounts
) {
378 $opt['label'] = !empty($opt['label']) ?
$opt['label'] . '<span class="crm-price-amount-label-separator"> - </span>' : '';
379 $preHelpText = $postHelpText = '';
380 if (!empty($opt['help_pre'])) {
381 $preHelpText = '<span class="crm-price-amount-help-pre description">' . $opt['help_pre'] . '</span><span class="crm-price-amount-help-pre-separator">: </span>';
383 if (!empty($opt['help_post'])) {
384 $postHelpText = '<span class="crm-price-amount-help-post-separator">: </span><span class="crm-price-amount-help-post description">' . $opt['help_post'] . '</span>';
386 if (isset($taxAmount) && $invoicing) {
387 if ($displayOpt == 'Do_not_show') {
388 $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>';
390 elseif ($displayOpt == 'Inclusive') {
391 $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>';
392 $opt['label'] .= '<span class="crm-price-amount-tax"> (includes ' . $taxTerm . ' of ' . CRM_Utils_Money
::format($opt['tax_amount']) . ')</span>';
395 $opt['label'] = '<span class="crm-price-amount-label">' . $opt['label'] . '</span>' . '<span class="crm-price-amount-amount">' . CRM_Utils_Money
::format($opt[$valueFieldName]) . '</span>';
396 $opt['label'] .= '<span class="crm-price-amount-tax"> + ' . CRM_Utils_Money
::format($opt['tax_amount']) . ' ' . $taxTerm . '</span>';
400 $opt['label'] = '<span class="crm-price-amount-label">' . $opt['label'] . '</span>' . '<span class="crm-price-amount-amount">' . CRM_Utils_Money
::format($opt[$valueFieldName]) . '</span>';
402 $opt['label'] = $preHelpText . $opt['label'] . $postHelpText;
404 $count = CRM_Utils_Array
::value('count', $opt, '');
405 $max_value = CRM_Utils_Array
::value('max_value', $opt, '');
406 $priceVal = implode($seperator, [$opt[$valueFieldName] +
$taxAmount, $count, $max_value]);
407 if (isset($opt['visibility_id'])) {
408 $visibility_id = $opt['visibility_id'];
411 $visibility_id = self
::getVisibilityOptionID('public');
414 'price' => json_encode([$elementName, $priceVal]),
415 'data-amount' => $opt[$valueFieldName],
416 'data-currency' => $currencyName,
417 'data-price-field-values' => json_encode($customOption),
418 'visibility' => $visibility_id,
420 if (!empty($qf->_quickConfig
) && $field->name
== 'contribution_amount') {
421 $extra +
= ['onclick' => 'clearAmountOther();'];
423 if ($field->name
== 'membership_amount') {
425 'onclick' => "return showHideAutoRenew({$opt['membership_type_id']});",
426 'membership-type' => $opt['membership_type_id'],
428 $qf->assign('membershipFieldID', $field->id
);
431 $choice[$opId] = $qf->createElement('radio', NULL, '', $opt['label'], $opt['id'], $extra);
433 $qf->add('text', 'txt-' . $elementName, $label, ['size' => '4']);
436 // CRM-6902 - Add "max" option for a price set field
437 if (in_array($opId, $freezeOptions)) {
438 self
::freezeIfEnabled($choice[$opId], $customOption[$opId]);
439 // CRM-14696 - Improve display for sold out price set options
440 $choice[$opId]->setText('<span class="sold-out-option">' . $choice[$opId]->getText() . ' (' . ts('Sold out') . ')</span>');
443 if (!empty($qf->_membershipBlock
) && $field->name
== 'contribution_amount') {
444 $choice[] = $qf->createElement('radio', NULL, '', ts('No thank you'), '-1',
446 'price' => json_encode([$elementName, '0|0']),
447 'data-currency' => $currencyName,
448 'onclick' => 'clearAmountOther();',
453 if (!$field->is_required
) {
455 if (!empty($otherAmount['is_allow_other_amount']) && $field->name
== 'contribution_amount') {
456 $none = ts('Other Amount');
458 elseif (!empty($qf->_membershipBlock
) && empty($qf->_membershipBlock
['is_required']) && $field->name
== 'membership_amount') {
459 $none = ts('No thank you');
462 $none = ts('- none -');
465 $choice[] = $qf->createElement('radio', NULL, '', $none, '0',
466 ['price' => json_encode([$elementName, '0'])]
470 $element = &$qf->addGroup($choice, $elementName, $label);
472 // make contribution field required for quick config when membership block is enabled
473 if (($field->name
== 'membership_amount' ||
$field->name
== 'contribution_amount')
474 && !empty($qf->_membershipBlock
) && !$field->is_required
476 $useRequired = $field->is_required
= TRUE;
479 if ($useRequired && $field->is_required
) {
480 $qf->addRule($elementName, ts('%1 is a required field.', [1 => $label]), 'required');
485 $selectOption = $allowedOptions = $priceVal = [];
487 foreach ($customOption as $opt) {
488 $taxAmount = $opt['tax_amount'] ??
NULL;
489 $count = CRM_Utils_Array
::value('count', $opt, '');
490 $max_value = CRM_Utils_Array
::value('max_value', $opt, '');
492 if ($field->is_display_amounts
) {
493 $opt['label'] .= ' - ';
494 if (isset($taxAmount) && $invoicing) {
495 $opt['label'] = $opt['label'] . self
::getTaxLabel($opt, $valueFieldName, $displayOpt, $taxTerm);
498 $opt['label'] = $opt['label'] . CRM_Utils_Money
::format($opt[$valueFieldName]);
502 $priceVal[$opt['id']] = implode($seperator, [$opt[$valueFieldName] +
$taxAmount, $count, $max_value]);
504 if (!in_array($opt['id'], $freezeOptions)) {
505 $allowedOptions[] = $opt['id'];
507 // CRM-14696 - Improve display for sold out price set options
509 $opt['id'] = 'crm_disabled_opt-' . $opt['id'];
510 $opt['label'] = $opt['label'] . ' (' . ts('Sold out') . ')';
513 $selectOption[$opt['id']] = $opt['label'];
516 $qf->add('text', 'txt-' . $elementName, $label, ['size' => '4']);
519 if (isset($opt['visibility_id'])) {
520 $visibility_id = $opt['visibility_id'];
523 $visibility_id = self
::getVisibilityOptionID('public');
525 $element = &$qf->add('select', $elementName, $label,
527 '' => ts('- select -'),
529 $useRequired && $field->is_required
,
530 ['price' => json_encode($priceVal), 'class' => 'crm-select2', 'data-price-field-values' => json_encode($customOption)]
533 // CRM-6902 - Add "max" option for a price set field
534 $button = substr($qf->controller
->getButtonName(), -4);
535 if (!empty($freezeOptions) && $button != 'skip') {
536 $qf->addRule($elementName, ts('Sorry, this option is currently sold out.'), 'regex', "/" . implode('|', $allowedOptions) . "/");
543 foreach ($customOption as $opId => $opt) {
544 $taxAmount = $opt['tax_amount'] ??
NULL;
545 $count = CRM_Utils_Array
::value('count', $opt, '');
546 $max_value = CRM_Utils_Array
::value('max_value', $opt, '');
548 if ($field->is_display_amounts
) {
549 $preHelpText = $postHelpText = '';
550 if (isset($opt['help_pre'])) {
551 $preHelpText = '<span class="crm-price-amount-help-pre description">' . $opt['help_pre'] . '</span>: ';
553 if (isset($opt['help_post'])) {
554 $postHelpText = ': <span class="crm-price-amount-help-post description">' . $opt['help_post'] . '</span>';
556 $opt['label'] = '<span class="crm-price-amount-label">' . $opt['label'] . '</span> - ';
557 if (isset($taxAmount) && $invoicing) {
558 $opt['label'] .= self
::getTaxLabel($opt, $valueFieldName, $displayOpt, $taxTerm);
561 $opt['label'] .= CRM_Utils_Money
::format($opt[$valueFieldName]);
563 $opt['label'] = $preHelpText . $opt['label'] . $postHelpText;
565 $priceVal = implode($seperator, [$opt[$valueFieldName] +
$taxAmount, $count, $max_value]);
566 $check[$opId] = &$qf->createElement('checkbox', $opt['id'], NULL, $opt['label'],
568 'price' => json_encode([$opt['id'], $priceVal]),
569 'data-amount' => $opt[$valueFieldName],
570 'data-currency' => $currencyName,
571 'visibility' => $opt['visibility_id'],
575 $txtcheck[$opId] =& $qf->createElement('text', $opId, $opt['label'], ['size' => '4']);
576 $qf->addGroup($txtcheck, 'txt-' . $elementName, $label);
578 // CRM-6902 - Add "max" option for a price set field
579 if (in_array($opId, $freezeOptions)) {
580 self
::freezeIfEnabled($check[$opId], $customOption[$opId]);
581 // CRM-14696 - Improve display for sold out price set options
582 $check[$opId]->setText('<span class="sold-out-option">' . $check[$opId]->getText() . ' (' . ts('Sold out') . ')</span>');
585 $element = &$qf->addGroup($check, $elementName, $label);
586 if ($useRequired && $field->is_required
) {
587 $qf->addRule($elementName, ts('%1 is a required field.', [1 => $label]), 'required');
591 if (isset($qf->_online
) && $qf->_online
) {
597 * Retrieve a list of options for the specified field.
599 * @param int $fieldId
601 * @param bool $inactiveNeeded
602 * Include inactive options.
604 * Discard stored values.
605 * @param bool $isDefaultContributionPriceSet
606 * Discard tax amount calculation for price set = default_contribution_amount.
611 public static function getOptions($fieldId, $inactiveNeeded = FALSE, $reset = FALSE, $isDefaultContributionPriceSet = FALSE) {
612 if ($reset ||
!isset(Civi
::$statics[__CLASS__
]['priceOptions'])) {
613 Civi
::$statics[__CLASS__
]['priceOptions'] = [];
614 // This would happen if the function was only called to clear the cache.
615 if (empty($fieldId)) {
620 if (empty(Civi
::$statics[__CLASS__
]['priceOptions'][$fieldId])) {
621 $values = $options = [];
622 CRM_Price_BAO_PriceFieldValue
::getValues($fieldId, $values, 'weight', !$inactiveNeeded);
623 $options[$fieldId] = $values;
624 $taxRates = CRM_Core_PseudoConstant
::getTaxRates();
626 // ToDo - Code for Hook Invoke
628 foreach ($options[$fieldId] as $priceFieldId => $priceFieldValues) {
629 if (isset($priceFieldValues['financial_type_id']) && array_key_exists($priceFieldValues['financial_type_id'], $taxRates) && !$isDefaultContributionPriceSet) {
630 $options[$fieldId][$priceFieldId]['tax_rate'] = $taxRates[$priceFieldValues['financial_type_id']];
631 $taxAmount = CRM_Contribute_BAO_Contribution_Utils
::calculateTaxAmount($priceFieldValues['amount'], $options[$fieldId][$priceFieldId]['tax_rate']);
632 $options[$fieldId][$priceFieldId]['tax_amount'] = $taxAmount['tax_amount'];
635 Civi
::$statics[__CLASS__
]['priceOptions'][$fieldId] = $options[$fieldId];
638 return Civi
::$statics[__CLASS__
]['priceOptions'][$fieldId];
642 * @param $optionLabel
647 public static function getOptionId($optionLabel, $fid) {
648 if (!$optionLabel ||
!$fid) {
652 $optionGroupName = "civicrm_price_field.amount.{$fid}";
656 option_value.id as id
658 civicrm_option_value option_value,
659 civicrm_option_group option_group
661 option_group.name = %1
662 AND option_group.id = option_value.option_group_id
663 AND option_value.label = %2";
665 $dao = CRM_Core_DAO
::executeQuery($query, [
666 1 => [$optionGroupName, 'String'],
667 2 => [$optionLabel, 'String'],
670 while ($dao->fetch()) {
676 * Delete the price set field.
684 public static function deleteField($id) {
685 $field = new CRM_Price_DAO_PriceField();
688 if ($field->find(TRUE)) {
689 // delete the options for this field
690 CRM_Price_BAO_PriceFieldValue
::deleteValues($id);
692 // reorder the weight before delete
693 $fieldValues = ['price_set_id' => $field->price_set_id
];
695 CRM_Utils_Weight
::delWeight('CRM_Price_DAO_PriceField', $field->id
, $fieldValues);
697 // now delete the field
698 return $field->delete();
707 public static function &htmlTypes() {
708 static $htmlTypes = NULL;
711 'Text' => ts('Text / Numeric Quantity'),
712 'Select' => ts('Select'),
713 'Radio' => ts('Radio'),
714 'CheckBox' => ts('CheckBox'),
721 * Validate the priceset.
723 * @param int $priceSetId
726 * retrun the error string
730 * @param bool $allowNoneSelection
733 public static function priceSetValidation($priceSetId, $fields, &$error, $allowNoneSelection = FALSE) {
734 // check for at least one positive
735 // amount price field should be selected.
736 $priceField = new CRM_Price_DAO_PriceField();
737 $priceField->price_set_id
= $priceSetId;
742 if ($allowNoneSelection) {
743 $noneSelectedPriceFields = [];
746 while ($priceField->fetch()) {
747 $key = "price_{$priceField->id}";
749 if ($allowNoneSelection) {
750 if (array_key_exists($key, $fields)) {
751 if ($fields[$key] == 0 && !$priceField->is_required
) {
752 $noneSelectedPriceFields[] = $priceField->id
;
757 if (!empty($fields[$key])) {
758 $priceFields[$priceField->id
] = $fields[$key];
762 if (!empty($priceFields)) {
763 // we should has to have positive amount.
766 FROM civicrm_price_field
767 WHERE id IN (" . implode(',', array_keys($priceFields)) . ')';
768 $fieldDAO = CRM_Core_DAO
::executeQuery($sql);
770 while ($fieldDAO->fetch()) {
771 $htmlTypes[$fieldDAO->id
] = $fieldDAO->html_type
;
774 $selectedAmounts = [];
776 foreach ($htmlTypes as $fieldId => $type) {
778 CRM_Price_BAO_PriceFieldValue
::getValues($fieldId, $options);
780 if (empty($options)) {
784 if ($type == 'Text') {
785 foreach ($options as $opId => $option) {
786 $selectedAmounts[$opId] = $priceFields[$fieldId] * $option['amount'];
790 elseif (is_array($fields["price_{$fieldId}"])) {
791 foreach (array_keys($fields["price_{$fieldId}"]) as $opId) {
792 $selectedAmounts[$opId] = $options[$opId]['amount'];
795 elseif (in_array($fields["price_{$fieldId}"], array_keys($options))) {
796 $selectedAmounts[$fields["price_{$fieldId}"]] = $options[$fields["price_{$fieldId}"]]['amount'];
800 list($componentName) = explode(':', $fields['_qf_default']);
801 // now we have all selected amount in hand.
802 $totalAmount = array_sum($selectedAmounts);
803 // The form offers a field to enter the amount paid. This may differ from the amount that is due to complete the purchase
804 $totalPaymentAmountEnteredOnForm = CRM_Utils_Array
::value('partial_payment_total', $fields, CRM_Utils_Array
::value('total_amount', $fields));
805 if ($totalAmount < 0) {
806 $error['_qf_default'] = ts('%1 amount can not be less than zero. Please select the options accordingly.', [1 => $componentName]);
808 elseif ($totalAmount > 0 &&
809 // if total amount is equal to all selected amount in hand
810 $totalPaymentAmountEnteredOnForm >= $totalAmount &&
811 (CRM_Utils_Array
::value('contribution_status_id', $fields) == CRM_Core_PseudoConstant
::getKey('CRM_Contribute_DAO_Contribution', 'contribution_status_id', 'Partially paid'))
813 $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');
817 if ($allowNoneSelection) {
818 if (empty($noneSelectedPriceFields)) {
819 $error['_qf_default'] = ts('Please select at least one option from price set.');
823 $error['_qf_default'] = ts('Please select at least one option from price set.');
829 * Generate the label for price fields based on tax display setting option on CiviContribute Component Settings page.
832 * @param string $valueFieldName
834 * @param string $displayOpt
835 * Tax display setting option.
837 * @param string $taxTerm
840 * Tax label for custom field.
842 public static function getTaxLabel($opt, $valueFieldName, $displayOpt, $taxTerm) {
843 if ($displayOpt == 'Do_not_show') {
844 $label = CRM_Utils_Money
::format($opt[$valueFieldName] +
$opt['tax_amount']);
846 elseif ($displayOpt == 'Inclusive') {
847 $label = CRM_Utils_Money
::format($opt[$valueFieldName] +
$opt['tax_amount']);
848 $label .= '<span class="crm-price-amount-tax"> (includes ' . $taxTerm . ' of ' . CRM_Utils_Money
::format($opt['tax_amount']) . ')</span>';
851 $label = CRM_Utils_Money
::format($opt[$valueFieldName]);
852 $label .= '<span class="crm-price-amount-tax"> + ' . CRM_Utils_Money
::format($opt['tax_amount']) . ' ' . $taxTerm . '</span>';
859 * Given the name of a visibility option, returns its ID.
861 * @param string $visibilityName
865 public static function getVisibilityOptionID($visibilityName) {
867 if (!isset(self
::$visibilityOptionsKeys)) {
868 self
::$visibilityOptionsKeys = CRM_Core_PseudoConstant
::get('CRM_Price_BAO_PriceField', 'visibility_id', [
869 'labelColumn' => 'name',
874 if (isset(self
::$visibilityOptionsKeys[$visibilityName])) {
875 return self
::$visibilityOptionsKeys[$visibilityName];