CRM/Price/BAO/PriceField.php

   1 <?php
   2 /*
   3   +--------------------------------------------------------------------+
   4   | CiviCRM version 5                                                  |
   5   +--------------------------------------------------------------------+
   6   | Copyright CiviCRM LLC (c) 2004-2019                                |
   7   +--------------------------------------------------------------------+
   8   | This file is a part of CiviCRM.                                    |
   9   |                                                                    |
  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.   |
  13   |                                                                    |
  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.        |
  18   |                                                                    |
  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   +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2019
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * Business objects for managing price fields.
  38  *
  39  */
  40 class CRM_Price_BAO_PriceField extends CRM_Price_DAO_PriceField {
  41
  42   protected $_options;
  43
  44   /**
  45    * List of visibility option ID's, of the form name => ID
  46    *
  47    * @var array
  48    */
  49   private static $visibilityOptionsKeys;
  50
  51   /**
  52    * Takes an associative array and creates a price field object.
  53    *
  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
  56    * pairs
  57    *
  58    * @param array $params
  59    *   (reference) an assoc array of name/value pairs.
  60    *
  61    * @return CRM_Price_BAO_PriceField
  62    */
  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);
  66
  67     $priceFieldBAO = new CRM_Price_BAO_PriceField();
  68
  69     $priceFieldBAO->copyValues($params);
  70
  71     if ($id = CRM_Utils_Array::value('id', $params)) {
  72       $priceFieldBAO->id = $id;
  73     }
  74
  75     $priceFieldBAO->save();
  76     CRM_Utils_Hook::post($hook, 'PriceField', $priceFieldBAO->id, $priceFieldBAO);
  77     return $priceFieldBAO;
  78   }
  79
  80   /**
  81    * Takes an associative array and creates a price field object.
  82    *
  83    * This function is invoked from within the web form layer and also from the api layer
  84    *
  85    * @param array $params
  86    *   (reference) an assoc array of name/value pairs.
  87    *
  88    * @return CRM_Price_DAO_PriceField
  89    *
  90    * @throws \CRM_Core_Exception
  91    * @throws \CiviCRM_API3_Exception
  92    */
  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));
  96     }
  97     $transaction = new CRM_Core_Transaction();
  98
  99     $priceField = self::add($params);
 100
 101     if (is_a($priceField, 'CRM_Core_Error')) {
 102       $transaction->rollback();
 103       return $priceField;
 104     }
 105
 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');
 108     }
 109     $optionsIds = [];
 110     $maxIndex = CRM_Price_Form_Field::NUM_OPTION;
 111     if ($priceField->html_type == 'Text') {
 112       $maxIndex = 1;
 113       $fieldOptions = civicrm_api3('price_field_value', 'get', [
 114         'price_field_id' => $priceField->id,
 115         'sequential' => 1,
 116       ]);
 117       foreach ($fieldOptions['values'] as $option) {
 118         $optionsIds['id'] = $option['id'];
 119         $params['option_id'] = [1 => $option['id']];
 120         // CRM-19741 If we are dealing with price fields that are Text only set the field value label to match
 121         if (!empty($params['id']) && $priceField->label != $option['label']) {
 122           $fieldValue = new CRM_Price_DAO_PriceFieldValue();
 123           $fieldValue->label = $priceField->label;
 124           $fieldValue->id = $option['id'];
 125           $fieldValue->save();
 126         }
 127       }
 128     }
 129     $defaultArray = [];
 130     //html type would be empty in update scenario not sure what would happen ...
 131     if (!empty($params['html_type']) && $params['html_type'] == 'CheckBox' && isset($params['default_checkbox_option'])) {
 132       $tempArray = array_keys($params['default_checkbox_option']);
 133       foreach ($tempArray as $v) {
 134         if ($params['option_amount'][$v]) {
 135           $defaultArray[$v] = 1;
 136         }
 137       }
 138     }
 139     else {
 140       if (!empty($params['default_option'])) {
 141         $defaultArray[$params['default_option']] = 1;
 142       }
 143     }
 144
 145     for ($index = 1; $index <= $maxIndex; $index++) {
 146       if (array_key_exists('option_amount', $params) &&
 147         array_key_exists($index, $params['option_amount']) &&
 148         (CRM_Utils_Array::value($index, CRM_Utils_Array::value('option_label', $params)) || !empty($params['is_quick_config'])) &&
 149         !CRM_Utils_System::isNull($params['option_amount'][$index])
 150       ) {
 151         $options = [
 152           'price_field_id' => $priceField->id,
 153           'label' => trim($params['option_label'][$index]),
 154           'name' => CRM_Utils_String::munge($params['option_label'][$index], '_', 64),
 155           'amount' => trim($params['option_amount'][$index]),
 156           'count' => CRM_Utils_Array::value($index, CRM_Utils_Array::value('option_count', $params), NULL),
 157           'max_value' => CRM_Utils_Array::value($index, CRM_Utils_Array::value('option_max_value', $params), NULL),
 158           'description' => CRM_Utils_Array::value($index, CRM_Utils_Array::value('option_description', $params), NULL),
 159           'membership_type_id' => CRM_Utils_Array::value($index, CRM_Utils_Array::value('membership_type_id', $params), NULL),
 160           'weight' => $params['option_weight'][$index],
 161           'is_active' => 1,
 162           'is_default' => CRM_Utils_Array::value($params['option_weight'][$index], $defaultArray) ? $defaultArray[$params['option_weight'][$index]] : 0,
 163           'membership_num_terms' => NULL,
 164           'non_deductible_amount' => CRM_Utils_Array::value('non_deductible_amount', $params),
 165           'visibility_id' => CRM_Utils_Array::value($index, CRM_Utils_Array::value('option_visibility_id', $params), self::getVisibilityOptionID('public')),
 166         ];
 167
 168         if ($options['membership_type_id']) {
 169           $options['membership_num_terms'] = CRM_Utils_Array::value($index, CRM_Utils_Array::value('membership_num_terms', $params), 1);
 170           $options['is_default'] = CRM_Utils_Array::value($params['membership_type_id'][$index], $defaultArray) ? $defaultArray[$params['membership_type_id'][$index]] : 0;
 171         }
 172
 173         if (CRM_Utils_Array::value($index, CRM_Utils_Array::value('option_financial_type_id', $params))) {
 174           $options['financial_type_id'] = $params['option_financial_type_id'][$index];
 175         }
 176         elseif (!empty($params['financial_type_id'])) {
 177           $options['financial_type_id'] = $params['financial_type_id'];
 178         }
 179         if ($opIds = CRM_Utils_Array::value('option_id', $params)) {
 180           if ($opId = CRM_Utils_Array::value($index, $opIds)) {
 181             $options['id'] = $opId;
 182           }
 183           else {
 184             $options['id'] = NULL;
 185           }
 186         }
 187         try {
 188           CRM_Price_BAO_PriceFieldValue::create($options, $optionsIds);
 189         }
 190         catch (Exception $e) {
 191           $transaction->rollback();
 192           throw new CRM_Core_Exception($e->getMessage());
 193         }
 194       }
 195       elseif (!empty($optionsIds) && !empty($optionsIds['id'])) {
 196         $optionsLoad = civicrm_api3('price_field_value', 'get', ['id' => $optionsIds['id']]);
 197         $options = $optionsLoad['values'][$optionsIds['id']];
 198         $options['is_active'] = CRM_Utils_Array::value('is_active', $params, 1);
 199         try {
 200           CRM_Price_BAO_PriceFieldValue::create($options, $optionsIds);
 201         }
 202         catch (Exception $e) {
 203           $transaction->rollback();
 204           throw new CRM_Core_Exception($e->getMessage());
 205         }
 206       }
 207     }
 208
 209     $transaction->commit();
 210     return $priceField;
 211   }
 212
 213   /**
 214    * Fetch object based on array of properties.
 215    *
 216    * @param array $params
 217    *   (reference ) an assoc array of name/value pairs.
 218    * @param array $defaults
 219    *   (reference ) an assoc array to hold the flattened values.
 220    *
 221    * @return CRM_Price_DAO_PriceField
 222    */
 223   public static function retrieve(&$params, &$defaults) {
 224     return CRM_Core_DAO::commonRetrieve('CRM_Price_DAO_PriceField', $params, $defaults);
 225   }
 226
 227   /**
 228    * Update the is_active flag in the db.
 229    *
 230    * @param int $id
 231    *   Id of the database record.
 232    * @param bool $is_active
 233    *   Value we want to set the is_active field.
 234    *
 235    * @return bool
 236    *   true if we found and updated the object, else false
 237    */
 238   public static function setIsActive($id, $is_active) {
 239     return CRM_Core_DAO::setFieldValue('CRM_Price_DAO_PriceField', $id, 'is_active', $is_active);
 240   }
 241
 242   /**
 243    * Freeze form if the event is full.
 244    *
 245    * @param $element
 246    * @param $fieldOptions
 247    *
 248    * @return null
 249    */
 250   public static function freezeIfEnabled(&$element, $fieldOptions) {
 251     if (!empty($fieldOptions['is_full'])) {
 252       $element->freeze();
 253     }
 254     return NULL;
 255   }
 256
 257   /**
 258    * Get the field title.
 259    *
 260    * @param int $id
 261    *   Id of field.
 262    *
 263    * @return string
 264    *   name
 265    *
 266    */
 267   public static function getTitle($id) {
 268     return CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceField', $id, 'label');
 269   }
 270
 271   /**
 272    * This function for building custom fields.
 273    *
 274    * @param CRM_Core_Form $qf
 275    *   Form object (reference).
 276    * @param string $elementName
 277    *   Name of the custom field.
 278    * @param int $fieldId
 279    * @param bool $inactiveNeeded
 280    * @param bool $useRequired
 281    *   True if required else false.
 282    * @param string $label
 283    *   Label for custom field.
 284    *
 285    * @param null $fieldOptions
 286    * @param array $freezeOptions
 287    *
 288    * @return null
 289    */
 290   public static function addQuickFormElement(
 291     &$qf,
 292     $elementName,
 293     $fieldId,
 294     $inactiveNeeded,
 295     $useRequired = TRUE,
 296     $label = NULL,
 297     $fieldOptions = NULL,
 298     $freezeOptions = []
 299   ) {
 300
 301     $field = new CRM_Price_DAO_PriceField();
 302     $field->id = $fieldId;
 303     if (!$field->find(TRUE)) {
 304       /* FIXME: failure! */
 305       return NULL;
 306     }
 307
 308     $is_pay_later = 0;
 309     if (isset($qf->_mode) && empty($qf->_mode)) {
 310       $is_pay_later = 1;
 311     }
 312     elseif (isset($qf->_values)) {
 313       $is_pay_later = CRM_Utils_Array::value('is_pay_later', $qf->_values);
 314     }
 315
 316     $otherAmount = $qf->get('values');
 317     $config = CRM_Core_Config::singleton();
 318     $currencySymbol = CRM_Core_DAO::getFieldValue('CRM_Financial_DAO_Currency', $config->defaultCurrency, 'symbol', 'name');
 319     $qf->assign('currencySymbol', $currencySymbol);
 320     // get currency name for price field and option attributes
 321     $currencyName = $config->defaultCurrency;
 322
 323     if (!isset($label)) {
 324       $label = (!empty($qf->_membershipBlock) && $field->name == 'contribution_amount') ? ts('Additional Contribution') : $field->label;
 325     }
 326
 327     if ($field->name == 'contribution_amount') {
 328       $qf->_contributionAmount = 1;
 329     }
 330
 331     if (isset($qf->_online) && $qf->_online) {
 332       $useRequired = FALSE;
 333     }
 334
 335     $customOption = $fieldOptions;
 336     if (!is_array($customOption)) {
 337       $customOption = CRM_Price_BAO_PriceField::getOptions($field->id, $inactiveNeeded);
 338     }
 339
 340     //use value field.
 341     $valueFieldName = 'amount';
 342     $seperator = '|';
 343     $invoiceSettings = Civi::settings()->get('contribution_invoice_settings');
 344     $taxTerm = CRM_Utils_Array::value('tax_term', $invoiceSettings);
 345     $displayOpt = CRM_Utils_Array::value('tax_display_settings', $invoiceSettings);
 346     $invoicing = CRM_Utils_Array::value('invoicing', $invoiceSettings);
 347     switch ($field->html_type) {
 348       case 'Text':
 349         $optionKey = key($customOption);
 350         $count = CRM_Utils_Array::value('count', $customOption[$optionKey], '');
 351         $max_value = CRM_Utils_Array::value('max_value', $customOption[$optionKey], '');
 352         $taxAmount = CRM_Utils_Array::value('tax_amount', $customOption[$optionKey]);
 353         if (isset($taxAmount) && $displayOpt && $invoicing) {
 354           $qf->assign('displayOpt', $displayOpt);
 355           $qf->assign('taxTerm', $taxTerm);
 356           $qf->assign('invoicing', $invoicing);
 357         }
 358         $priceVal = implode($seperator, [
 359           $customOption[$optionKey][$valueFieldName] + $taxAmount,
 360           $count,
 361           $max_value,
 362         ]);
 363
 364         $extra = [];
 365         if (!empty($qf->_membershipBlock) && !empty($qf->_quickConfig) && $field->name == 'other_amount' && empty($qf->_contributionAmount)) {
 366           $useRequired = 0;
 367         }
 368         elseif (!empty($fieldOptions[$optionKey]['label'])) {
 369           //check for label.
 370           $label = $fieldOptions[$optionKey]['label'];
 371           if (!empty($qf->_quickConfig) && !empty($qf->_contributionAmount) && strtolower($fieldOptions[$optionKey]['name']) == 'other_amount') {
 372             $label .= '  ' . $currencySymbol;
 373             $qf->assign('priceset', $elementName);
 374             $extra = ['onclick' => 'useAmountOther();'];
 375           }
 376         }
 377
 378         $element = &$qf->add('text', $elementName, $label,
 379           array_merge($extra,
 380             [
 381               'price' => json_encode([$optionKey, $priceVal]),
 382               'size' => '4',
 383             ]
 384           ),
 385           $useRequired && $field->is_required
 386         );
 387         if ($is_pay_later) {
 388           $qf->add('text', 'txt-' . $elementName, $label, ['size' => '4']);
 389         }
 390
 391         // CRM-6902 - Add "max" option for a price set field
 392         if (in_array($optionKey, $freezeOptions)) {
 393           self::freezeIfEnabled($element, $fieldOptions[$optionKey]);
 394           // CRM-14696 - Improve display for sold out price set options
 395           $element->setLabel($label . '&nbsp;<span class="sold-out-option">' . ts('Sold out') . '</span>');
 396         }
 397
 398         //CRM-10117
 399         if (!empty($qf->_quickConfig)) {
 400           $message = ts('Please enter a valid amount.');
 401           $type = 'money';
 402         }
 403         else {
 404           $message = ts('%1 must be a number (with or without decimal point).', [1 => $label]);
 405           $type = 'numeric';
 406         }
 407         // integers will have numeric rule applied to them.
 408         $qf->addRule($elementName, $message, $type);
 409         break;
 410
 411       case 'Radio':
 412         $choice = [];
 413
 414         if (!empty($qf->_quickConfig) && !empty($qf->_contributionAmount)) {
 415           $qf->assign('contriPriceset', $elementName);
 416         }
 417
 418         foreach ($customOption as $opId => $opt) {
 419           $taxAmount = CRM_Utils_Array::value('tax_amount', $opt);
 420           if ($field->is_display_amounts) {
 421             $opt['label'] = !empty($opt['label']) ? $opt['label'] . '<span class="crm-price-amount-label-separator">&nbsp;-&nbsp;</span>' : '';
 422             $preHelpText = $postHelpText = '';
 423             if (!empty($opt['help_pre'])) {
 424               $preHelpText = '<span class="crm-price-amount-help-pre description">' . $opt['help_pre'] . '</span>: ';
 425             }
 426             if (!empty($opt['help_post'])) {
 427               $postHelpText = ': <span class="crm-price-amount-help-post description">' . $opt['help_post'] . '</span>';
 428             }
 429             if (isset($taxAmount) && $invoicing) {
 430               if ($displayOpt == 'Do_not_show') {
 431                 $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               }
 433               elseif ($displayOpt == 'Inclusive') {
 434                 $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>';
 435                 $opt['label'] .= '<span class="crm-price-amount-tax"> (includes ' . $taxTerm . ' of ' . CRM_Utils_Money::format($opt['tax_amount']) . ')</span>';
 436               }
 437               else {
 438                 $opt['label'] = '<span class="crm-price-amount-label">' . $opt['label'] . '</span>' . '<span class="crm-price-amount-amount">' . CRM_Utils_Money::format($opt[$valueFieldName]) . '</span>';
 439                 $opt['label'] .= '<span class="crm-price-amount-tax"> + ' . CRM_Utils_Money::format($opt['tax_amount']) . ' ' . $taxTerm . '</span>';
 440               }
 441             }
 442             else {
 443               $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             }
 445             $opt['label'] = $preHelpText . $opt['label'] . $postHelpText;
 446           }
 447           $count = CRM_Utils_Array::value('count', $opt, '');
 448           $max_value = CRM_Utils_Array::value('max_value', $opt, '');
 449           $priceVal = implode($seperator, [$opt[$valueFieldName] + $taxAmount, $count, $max_value]);
 450           if (isset($opt['visibility_id'])) {
 451             $visibility_id = $opt['visibility_id'];
 452           }
 453           else {
 454             $visibility_id = self::getVisibilityOptionID('public');
 455           }
 456           $extra = [
 457             'price' => json_encode([$elementName, $priceVal]),
 458             'data-amount' => $opt[$valueFieldName],
 459             'data-currency' => $currencyName,
 460             'data-price-field-values' => json_encode($customOption),
 461             'visibility' => $visibility_id,
 462           ];
 463           if (!empty($qf->_quickConfig) && $field->name == 'contribution_amount') {
 464             $extra += ['onclick' => 'clearAmountOther();'];
 465           }
 466           if ($field->name == 'membership_amount') {
 467             $extra += [
 468               'onclick' => "return showHideAutoRenew({$opt['membership_type_id']});",
 469               'membership-type' => $opt['membership_type_id'],
 470             ];
 471             $qf->assign('membershipFieldID', $field->id);
 472           }
 473
 474           $choice[$opId] = $qf->createElement('radio', NULL, '', $opt['label'], $opt['id'], $extra);
 475           if ($is_pay_later) {
 476             $qf->add('text', 'txt-' . $elementName, $label, ['size' => '4']);
 477           }
 478
 479           // CRM-6902 - Add "max" option for a price set field
 480           if (in_array($opId, $freezeOptions)) {
 481             self::freezeIfEnabled($choice[$opId], $customOption[$opId]);
 482             // CRM-14696 - Improve display for sold out price set options
 483             $choice[$opId]->setText('<span class="sold-out-option">' . $choice[$opId]->getText() . '&nbsp;(' . ts('Sold out') . ')</span>');
 484           }
 485         }
 486         if (!empty($qf->_membershipBlock) && $field->name == 'contribution_amount') {
 487           $choice[] = $qf->createElement('radio', NULL, '', ts('No thank you'), '-1',
 488             [
 489               'price' => json_encode([$elementName, '0|0']),
 490               'data-currency' => $currencyName,
 491               'onclick' => 'clearAmountOther();',
 492             ]
 493           );
 494         }
 495
 496         if (!$field->is_required) {
 497           // add "none" option
 498           if (!empty($otherAmount['is_allow_other_amount']) && $field->name == 'contribution_amount') {
 499             $none = ts('Other Amount');
 500           }
 501           elseif (!empty($qf->_membershipBlock) && empty($qf->_membershipBlock['is_required']) && $field->name == 'membership_amount') {
 502             $none = ts('No thank you');
 503           }
 504           else {
 505             $none = ts('- none -');
 506           }
 507
 508           $choice[] = $qf->createElement('radio', NULL, '', $none, '0',
 509             ['price' => json_encode([$elementName, '0'])]
 510           );
 511         }
 512
 513         $element = &$qf->addGroup($choice, $elementName, $label);
 514
 515         // make contribution field required for quick config when membership block is enabled
 516         if (($field->name == 'membership_amount' || $field->name == 'contribution_amount')
 517           && !empty($qf->_membershipBlock) && !$field->is_required
 518         ) {
 519           $useRequired = $field->is_required = TRUE;
 520         }
 521
 522         if ($useRequired && $field->is_required) {
 523           $qf->addRule($elementName, ts('%1 is a required field.', [1 => $label]), 'required');
 524         }
 525         break;
 526
 527       case 'Select':
 528         $selectOption = $allowedOptions = $priceVal = [];
 529
 530         foreach ($customOption as $opt) {
 531           $taxAmount = CRM_Utils_Array::value('tax_amount', $opt);
 532           $count = CRM_Utils_Array::value('count', $opt, '');
 533           $max_value = CRM_Utils_Array::value('max_value', $opt, '');
 534
 535           if ($field->is_display_amounts) {
 536             $opt['label'] .= '&nbsp;-&nbsp;';
 537             if (isset($taxAmount) && $invoicing) {
 538               $opt['label'] = $opt['label'] . self::getTaxLabel($opt, $valueFieldName, $displayOpt, $taxTerm);
 539             }
 540             else {
 541               $opt['label'] = $opt['label'] . CRM_Utils_Money::format($opt[$valueFieldName]);
 542             }
 543           }
 544
 545           $priceVal[$opt['id']] = implode($seperator, [$opt[$valueFieldName] + $taxAmount, $count, $max_value]);
 546
 547           if (!in_array($opt['id'], $freezeOptions)) {
 548             $allowedOptions[] = $opt['id'];
 549           }
 550           // CRM-14696 - Improve display for sold out price set options
 551           else {
 552             $opt['id'] = 'crm_disabled_opt-' . $opt['id'];
 553             $opt['label'] = $opt['label'] . ' (' . ts('Sold out') . ')';
 554           }
 555
 556           $selectOption[$opt['id']] = $opt['label'];
 557
 558           if ($is_pay_later) {
 559             $qf->add('text', 'txt-' . $elementName, $label, ['size' => '4']);
 560           }
 561         }
 562         if (isset($opt['visibility_id'])) {
 563           $visibility_id = $opt['visibility_id'];
 564         }
 565         else {
 566           $visibility_id = self::getVisibilityOptionID('public');
 567         }
 568         $element = &$qf->add('select', $elementName, $label,
 569           [
 570             '' => ts('- select -'),
 571           ] + $selectOption,
 572           $useRequired && $field->is_required,
 573           ['price' => json_encode($priceVal), 'class' => 'crm-select2', 'data-price-field-values' => json_encode($customOption)]
 574         );
 575
 576         // CRM-6902 - Add "max" option for a price set field
 577         $button = substr($qf->controller->getButtonName(), -4);
 578         if (!empty($freezeOptions) && $button != 'skip') {
 579           $qf->addRule($elementName, ts('Sorry, this option is currently sold out.'), 'regex', "/" . implode('|', $allowedOptions) . "/");
 580         }
 581         break;
 582
 583       case 'CheckBox':
 584
 585         $check = [];
 586         foreach ($customOption as $opId => $opt) {
 587           $taxAmount = CRM_Utils_Array::value('tax_amount', $opt);
 588           $count = CRM_Utils_Array::value('count', $opt, '');
 589           $max_value = CRM_Utils_Array::value('max_value', $opt, '');
 590
 591           if ($field->is_display_amounts) {
 592             $preHelpText = $postHelpText = '';
 593             if (isset($opt['help_pre'])) {
 594               $preHelpText = '<span class="crm-price-amount-help-pre description">' . $opt['help_pre'] . '</span>: ';
 595             }
 596             if (isset($opt['help_post'])) {
 597               $postHelpText = ': <span class="crm-price-amount-help-post description">' . $opt['help_post'] . '</span>';
 598             }
 599             $opt['label'] = '<span class="crm-price-amount-label">' . $opt['label'] . '</span>&nbsp;-&nbsp;';
 600             if (isset($taxAmount) && $invoicing) {
 601               $opt['label'] .= self::getTaxLabel($opt, $valueFieldName, $displayOpt, $taxTerm);
 602             }
 603             else {
 604               $opt['label'] .= CRM_Utils_Money::format($opt[$valueFieldName]);
 605             }
 606             $opt['label'] = $preHelpText . $opt['label'] . $postHelpText;
 607           }
 608           $priceVal = implode($seperator, [$opt[$valueFieldName] + $taxAmount, $count, $max_value]);
 609           $check[$opId] = &$qf->createElement('checkbox', $opt['id'], NULL, $opt['label'],
 610             [
 611               'price' => json_encode([$opt['id'], $priceVal]),
 612               'data-amount' => $opt[$valueFieldName],
 613               'data-currency' => $currencyName,
 614               'visibility' => $opt['visibility_id'],
 615             ]
 616           );
 617           if ($is_pay_later) {
 618             $txtcheck[$opId] =& $qf->createElement('text', $opId, $opt['label'], ['size' => '4']);
 619             $qf->addGroup($txtcheck, 'txt-' . $elementName, $label);
 620           }
 621           // CRM-6902 - Add "max" option for a price set field
 622           if (in_array($opId, $freezeOptions)) {
 623             self::freezeIfEnabled($check[$opId], $customOption[$opId]);
 624             // CRM-14696 - Improve display for sold out price set options
 625             $check[$opId]->setText('<span class="sold-out-option">' . $check[$opId]->getText() . '&nbsp;(' . ts('Sold out') . ')</span>');
 626           }
 627         }
 628         $element = &$qf->addGroup($check, $elementName, $label);
 629         if ($useRequired && $field->is_required) {
 630           $qf->addRule($elementName, ts('%1 is a required field.', [1 => $label]), 'required');
 631         }
 632         break;
 633     }
 634     if (isset($qf->_online) && $qf->_online) {
 635       $element->freeze();
 636     }
 637   }
 638
 639   /**
 640    * Retrieve a list of options for the specified field.
 641    *
 642    * @param int $fieldId
 643    *   Price field ID.
 644    * @param bool $inactiveNeeded
 645    *   Include inactive options.
 646    * @param bool $reset
 647    *   Discard stored values.
 648    * @param bool $isDefaultContributionPriceSet
 649    *   Discard tax amount calculation for price set = default_contribution_amount.
 650    *
 651    * @return array
 652    *   array of options
 653    */
 654   public static function getOptions($fieldId, $inactiveNeeded = FALSE, $reset = FALSE, $isDefaultContributionPriceSet = FALSE) {
 655     if ($reset || !isset(Civi::$statics[__CLASS__]['priceOptions'])) {
 656       Civi::$statics[__CLASS__]['priceOptions'] = [];
 657       // This would happen if the function was only called to clear the cache.
 658       if (empty($fieldId)) {
 659         return [];
 660       }
 661     }
 662
 663     if (empty(Civi::$statics[__CLASS__]['priceOptions'][$fieldId])) {
 664       $values = $options = [];
 665       CRM_Price_BAO_PriceFieldValue::getValues($fieldId, $values, 'weight', !$inactiveNeeded);
 666       $options[$fieldId] = $values;
 667       $taxRates = CRM_Core_PseudoConstant::getTaxRates();
 668
 669       // ToDo - Code for Hook Invoke
 670
 671       foreach ($options[$fieldId] as $priceFieldId => $priceFieldValues) {
 672         if (isset($priceFieldValues['financial_type_id']) && array_key_exists($priceFieldValues['financial_type_id'], $taxRates) && !$isDefaultContributionPriceSet) {
 673           $options[$fieldId][$priceFieldId]['tax_rate'] = $taxRates[$priceFieldValues['financial_type_id']];
 674           $taxAmount = CRM_Contribute_BAO_Contribution_Utils::calculateTaxAmount($priceFieldValues['amount'], $options[$fieldId][$priceFieldId]['tax_rate']);
 675           $options[$fieldId][$priceFieldId]['tax_amount'] = $taxAmount['tax_amount'];
 676         }
 677       }
 678       Civi::$statics[__CLASS__]['priceOptions'][$fieldId] = $options[$fieldId];
 679     }
 680
 681     return Civi::$statics[__CLASS__]['priceOptions'][$fieldId];
 682   }
 683
 684   /**
 685    * @param $optionLabel
 686    * @param int $fid
 687    *
 688    * @return mixed
 689    */
 690   public static function getOptionId($optionLabel, $fid) {
 691     if (!$optionLabel || !$fid) {
 692       return;
 693     }
 694
 695     $optionGroupName = "civicrm_price_field.amount.{$fid}";
 696
 697     $query = "
 698 SELECT
 699         option_value.id as id
 700 FROM
 701         civicrm_option_value option_value,
 702         civicrm_option_group option_group
 703 WHERE
 704         option_group.name = %1
 705     AND option_group.id = option_value.option_group_id
 706     AND option_value.label = %2";
 707
 708     $dao = CRM_Core_DAO::executeQuery($query, [
 709       1 => [$optionGroupName, 'String'],
 710       2 => [$optionLabel, 'String'],
 711     ]);
 712
 713     while ($dao->fetch()) {
 714       return $dao->id;
 715     }
 716   }
 717
 718   /**
 719    * Delete the price set field.
 720    *
 721    * @param int $id
 722    *   Field Id.
 723    *
 724    * @return bool
 725    *
 726    */
 727   public static function deleteField($id) {
 728     $field = new CRM_Price_DAO_PriceField();
 729     $field->id = $id;
 730
 731     if ($field->find(TRUE)) {
 732       // delete the options for this field
 733       CRM_Price_BAO_PriceFieldValue::deleteValues($id);
 734
 735       // reorder the weight before delete
 736       $fieldValues = ['price_set_id' => $field->price_set_id];
 737
 738       CRM_Utils_Weight::delWeight('CRM_Price_DAO_PriceField', $field->id, $fieldValues);
 739
 740       // now delete the field
 741       return $field->delete();
 742     }
 743
 744     return NULL;
 745   }
 746
 747   /**
 748    * @return array
 749    */
 750   public static function &htmlTypes() {
 751     static $htmlTypes = NULL;
 752     if (!$htmlTypes) {
 753       $htmlTypes = [
 754         'Text' => ts('Text / Numeric Quantity'),
 755         'Select' => ts('Select'),
 756         'Radio' => ts('Radio'),
 757         'CheckBox' => ts('CheckBox'),
 758       ];
 759     }
 760     return $htmlTypes;
 761   }
 762
 763   /**
 764    * Validate the priceset.
 765    *
 766    * @param int $priceSetId
 767    *   , array $fields.
 768    *
 769    * retrun the error string
 770    *
 771    * @param $fields
 772    * @param $error
 773    * @param bool $allowNoneSelection
 774    *
 775    */
 776   public static function priceSetValidation($priceSetId, $fields, &$error, $allowNoneSelection = FALSE) {
 777     // check for at least one positive
 778     // amount price field should be selected.
 779     $priceField = new CRM_Price_DAO_PriceField();
 780     $priceField->price_set_id = $priceSetId;
 781     $priceField->find();
 782
 783     $priceFields = [];
 784
 785     if ($allowNoneSelection) {
 786       $noneSelectedPriceFields = [];
 787     }
 788
 789     while ($priceField->fetch()) {
 790       $key = "price_{$priceField->id}";
 791
 792       if ($allowNoneSelection) {
 793         if (array_key_exists($key, $fields)) {
 794           if ($fields[$key] == 0 && !$priceField->is_required) {
 795             $noneSelectedPriceFields[] = $priceField->id;
 796           }
 797         }
 798       }
 799
 800       if (!empty($fields[$key])) {
 801         $priceFields[$priceField->id] = $fields[$key];
 802       }
 803     }
 804
 805     if (!empty($priceFields)) {
 806       // we should has to have positive amount.
 807       $sql = "
 808 SELECT  id, html_type
 809 FROM  civicrm_price_field
 810 WHERE  id IN (" . implode(',', array_keys($priceFields)) . ')';
 811       $fieldDAO = CRM_Core_DAO::executeQuery($sql);
 812       $htmlTypes = [];
 813       while ($fieldDAO->fetch()) {
 814         $htmlTypes[$fieldDAO->id] = $fieldDAO->html_type;
 815       }
 816
 817       $selectedAmounts = [];
 818
 819       foreach ($htmlTypes as $fieldId => $type) {
 820         $options = [];
 821         CRM_Price_BAO_PriceFieldValue::getValues($fieldId, $options);
 822
 823         if (empty($options)) {
 824           continue;
 825         }
 826
 827         if ($type == 'Text') {
 828           foreach ($options as $opId => $option) {
 829             $selectedAmounts[$opId] = $priceFields[$fieldId] * $option['amount'];
 830             break;
 831           }
 832         }
 833         elseif (is_array($fields["price_{$fieldId}"])) {
 834           foreach (array_keys($fields["price_{$fieldId}"]) as $opId) {
 835             $selectedAmounts[$opId] = $options[$opId]['amount'];
 836           }
 837         }
 838         elseif (in_array($fields["price_{$fieldId}"], array_keys($options))) {
 839           $selectedAmounts[$fields["price_{$fieldId}"]] = $options[$fields["price_{$fieldId}"]]['amount'];
 840         }
 841       }
 842
 843       list($componentName) = explode(':', $fields['_qf_default']);
 844       // now we have all selected amount in hand.
 845       $totalAmount = array_sum($selectedAmounts);
 846       // The form offers a field to enter the amount paid. This may differ from the amount that is due to complete the purchase
 847       $totalPaymentAmountEnteredOnForm = CRM_Utils_Array::value('partial_payment_total', $fields, CRM_Utils_Array::value('total_amount', $fields));
 848       if ($totalAmount < 0) {
 849         $error['_qf_default'] = ts('%1 amount can not be less than zero. Please select the options accordingly.', [1 => $componentName]);
 850       }
 851       elseif ($totalAmount > 0 &&
 852       // if total amount is equal to all selected amount in hand
 853         $totalPaymentAmountEnteredOnForm >= $totalAmount &&
 854         (CRM_Utils_Array::value('contribution_status_id', $fields) == CRM_Core_PseudoConstant::getKey('CRM_Contribute_DAO_Contribution', 'contribution_status_id', 'Partially paid'))
 855       ) {
 856         $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');
 857       }
 858     }
 859     else {
 860       if ($allowNoneSelection) {
 861         if (empty($noneSelectedPriceFields)) {
 862           $error['_qf_default'] = ts('Please select at least one option from price set.');
 863         }
 864       }
 865       else {
 866         $error['_qf_default'] = ts('Please select at least one option from price set.');
 867       }
 868     }
 869   }
 870
 871   /**
 872    * Generate the label for price fields based on tax display setting option on CiviContribute Component Settings page.
 873    *
 874    * @param array $opt
 875    * @param string $valueFieldName
 876    *   Amount.
 877    * @param string $displayOpt
 878    *   Tax display setting option.
 879    *
 880    * @param string $taxTerm
 881    *
 882    * @return string
 883    *   Tax label for custom field.
 884    */
 885   public static function getTaxLabel($opt, $valueFieldName, $displayOpt, $taxTerm) {
 886     if ($displayOpt == 'Do_not_show') {
 887       $label = CRM_Utils_Money::format($opt[$valueFieldName] + $opt['tax_amount']);
 888     }
 889     elseif ($displayOpt == 'Inclusive') {
 890       $label = CRM_Utils_Money::format($opt[$valueFieldName] + $opt['tax_amount']);
 891       $label .= '<span class="crm-price-amount-tax"> (includes ' . $taxTerm . ' of ' . CRM_Utils_Money::format($opt['tax_amount']) . ')</span>';
 892     }
 893     else {
 894       $label = CRM_Utils_Money::format($opt[$valueFieldName]);
 895       $label .= '<span class="crm-price-amount-tax"> + ' . CRM_Utils_Money::format($opt['tax_amount']) . ' ' . $taxTerm . '</span>';
 896     }
 897
 898     return $label;
 899   }
 900
 901   /**
 902    * Given the name of a visibility option, returns its ID.
 903    *
 904    * @param string $visibilityName
 905    *
 906    * @return int
 907    */
 908   public static function getVisibilityOptionID($visibilityName) {
 909
 910     if (!isset(self::$visibilityOptionsKeys)) {
 911       self::$visibilityOptionsKeys = CRM_Price_BAO_PriceField::buildOptions(
 912         'visibility_id',
 913         NULL,
 914         [
 915           'labelColumn' => 'name',
 916           'flip' => TRUE,
 917         ]
 918       );
 919     }
 920
 921     if (isset(self::$visibilityOptionsKeys[$visibilityName])) {
 922       return self::$visibilityOptionsKeys[$visibilityName];
 923     }
 924
 925     return 0;
 926   }
 927
 928 }