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         // 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'];
 124           $fieldValue->save();
 125         }
 126       }
 127     }
 128     $defaultArray = [];
 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;
 135         }
 136       }
 137     }
 138     else {
 139       if (!empty($params['default_option'])) {
 140         $defaultArray[$params['default_option']] = 1;
 141       }
 142     }
 143
 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])
 149       ) {
 150         $options = [
 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],
 160           'is_active' => 1,
 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')),
 165         ];
 166
 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;
 170         }
 171
 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];
 174         }
 175         elseif (!empty($params['financial_type_id'])) {
 176           $options['financial_type_id'] = $params['financial_type_id'];
 177         }
 178         if ($opIds = CRM_Utils_Array::value('option_id', $params)) {
 179           if ($opId = CRM_Utils_Array::value($index, $opIds)) {
 180             $optionsIds['id'] = $opId;
 181           }
 182           else {
 183             $optionsIds['id'] = NULL;
 184           }
 185         }
 186         try {
 187           CRM_Price_BAO_PriceFieldValue::create($options, $optionsIds);
 188         }
 189         catch (Exception $e) {
 190           $transaction->rollback();
 191           throw new CRM_Core_Exception($e->getMessage());
 192         }
 193       }
 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);
 198         try {
 199           CRM_Price_BAO_PriceFieldValue::create($options, $optionsIds);
 200         }
 201         catch (Exception $e) {
 202           $transaction->rollback();
 203           throw new CRM_Core_Exception($e->getMessage());
 204         }
 205       }
 206     }
 207
 208     $transaction->commit();
 209     return $priceField;
 210   }
 211
 212   /**
 213    * Fetch object based on array of properties.
 214    *
 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.
 219    *
 220    * @return CRM_Price_DAO_PriceField
 221    */
 222   public static function retrieve(&$params, &$defaults) {
 223     return CRM_Core_DAO::commonRetrieve('CRM_Price_DAO_PriceField', $params, $defaults);
 224   }
 225
 226   /**
 227    * Update the is_active flag in the db.
 228    *
 229    * @param int $id
 230    *   Id of the database record.
 231    * @param bool $is_active
 232    *   Value we want to set the is_active field.
 233    *
 234    * @return bool
 235    *   true if we found and updated the object, else false
 236    */
 237   public static function setIsActive($id, $is_active) {
 238     return CRM_Core_DAO::setFieldValue('CRM_Price_DAO_PriceField', $id, 'is_active', $is_active);
 239   }
 240
 241   /**
 242    * Freeze form if the event is full.
 243    *
 244    * @param $element
 245    * @param $fieldOptions
 246    *
 247    * @return null
 248    */
 249   public static function freezeIfEnabled(&$element, $fieldOptions) {
 250     if (!empty($fieldOptions['is_full'])) {
 251       $element->freeze();
 252     }
 253     return NULL;
 254   }
 255
 256   /**
 257    * Get the field title.
 258    *
 259    * @param int $id
 260    *   Id of field.
 261    *
 262    * @return string
 263    *   name
 264    *
 265    */
 266   public static function getTitle($id) {
 267     return CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceField', $id, 'label');
 268   }
 269
 270   /**
 271    * This function for building custom fields.
 272    *
 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.
 283    *
 284    * @param null $fieldOptions
 285    * @param array $freezeOptions
 286    *
 287    * @return null
 288    */
 289   public static function addQuickFormElement(
 290     &$qf,
 291     $elementName,
 292     $fieldId,
 293     $inactiveNeeded,
 294     $useRequired = TRUE,
 295     $label = NULL,
 296     $fieldOptions = NULL,
 297     $freezeOptions = []
 298   ) {
 299
 300     $field = new CRM_Price_DAO_PriceField();
 301     $field->id = $fieldId;
 302     if (!$field->find(TRUE)) {
 303       /* FIXME: failure! */
 304       return NULL;
 305     }
 306
 307     $is_pay_later = 0;
 308     if (isset($qf->_mode) && empty($qf->_mode)) {
 309       $is_pay_later = 1;
 310     }
 311     elseif (isset($qf->_values)) {
 312       $is_pay_later = CRM_Utils_Array::value('is_pay_later', $qf->_values);
 313     }
 314
 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;
 321
 322     if (!isset($label)) {
 323       $label = (!empty($qf->_membershipBlock) && $field->name == 'contribution_amount') ? ts('Additional Contribution') : $field->label;
 324     }
 325
 326     if ($field->name == 'contribution_amount') {
 327       $qf->_contributionAmount = 1;
 328     }
 329
 330     if (isset($qf->_online) && $qf->_online) {
 331       $useRequired = FALSE;
 332     }
 333
 334     $customOption = $fieldOptions;
 335     if (!is_array($customOption)) {
 336       $customOption = CRM_Price_BAO_PriceField::getOptions($field->id, $inactiveNeeded);
 337     }
 338
 339     //use value field.
 340     $valueFieldName = 'amount';
 341     $seperator = '|';
 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) {
 347       case 'Text':
 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);
 356         }
 357         $priceVal = implode($seperator, [
 358           $customOption[$optionKey][$valueFieldName] + $taxAmount,
 359           $count,
 360           $max_value,
 361         ]);
 362
 363         $extra = [];
 364         if (!empty($qf->_membershipBlock) && !empty($qf->_quickConfig) && $field->name == 'other_amount' && empty($qf->_contributionAmount)) {
 365           $useRequired = 0;
 366         }
 367         elseif (!empty($fieldOptions[$optionKey]['label'])) {
 368           //check for 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();'];
 374           }
 375         }
 376
 377         $element = &$qf->add('text', $elementName, $label,
 378           array_merge($extra,
 379             [
 380               'price' => json_encode([$optionKey, $priceVal]),
 381               'size' => '4',
 382             ]
 383           ),
 384           $useRequired && $field->is_required
 385         );
 386         if ($is_pay_later) {
 387           $qf->add('text', 'txt-' . $elementName, $label, ['size' => '4']);
 388         }
 389
 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 . '&nbsp;<span class="sold-out-option">' . ts('Sold out') . '</span>');
 395         }
 396
 397         //CRM-10117
 398         if (!empty($qf->_quickConfig)) {
 399           $message = ts('Please enter a valid amount.');
 400           $type = 'money';
 401         }
 402         else {
 403           $message = ts('%1 must be a number (with or without decimal point).', [1 => $label]);
 404           $type = 'numeric';
 405         }
 406         // integers will have numeric rule applied to them.
 407         $qf->addRule($elementName, $message, $type);
 408         break;
 409
 410       case 'Radio':
 411         $choice = [];
 412
 413         if (!empty($qf->_quickConfig) && !empty($qf->_contributionAmount)) {
 414           $qf->assign('contriPriceset', $elementName);
 415         }
 416
 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">&nbsp;-&nbsp;</span>' : '';
 421             $preHelpText = $postHelpText = '';
 422             if (!empty($opt['help_pre'])) {
 423               $preHelpText = '<span class="crm-price-amount-help-pre description">' . $opt['help_pre'] . '</span>: ';
 424             }
 425             if (!empty($opt['help_post'])) {
 426               $postHelpText = ': <span class="crm-price-amount-help-post description">' . $opt['help_post'] . '</span>';
 427             }
 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>';
 431               }
 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>';
 435               }
 436               else {
 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>';
 439               }
 440             }
 441             else {
 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>';
 443             }
 444             $opt['label'] = $preHelpText . $opt['label'] . $postHelpText;
 445           }
 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'];
 451           }
 452           else {
 453             $visibility_id = self::getVisibilityOptionID('public');
 454           }
 455           $extra = [
 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,
 461           ];
 462           if (!empty($qf->_quickConfig) && $field->name == 'contribution_amount') {
 463             $extra += ['onclick' => 'clearAmountOther();'];
 464           }
 465           if ($field->name == 'membership_amount') {
 466             $extra += [
 467               'onclick' => "return showHideAutoRenew({$opt['membership_type_id']});",
 468               'membership-type' => $opt['membership_type_id'],
 469             ];
 470             $qf->assign('membershipFieldID', $field->id);
 471           }
 472
 473           $choice[$opId] = $qf->createElement('radio', NULL, '', $opt['label'], $opt['id'], $extra);
 474           if ($is_pay_later) {
 475             $qf->add('text', 'txt-' . $elementName, $label, ['size' => '4']);
 476           }
 477
 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() . '&nbsp;(' . ts('Sold out') . ')</span>');
 483           }
 484         }
 485         if (!empty($qf->_membershipBlock) && $field->name == 'contribution_amount') {
 486           $choice[] = $qf->createElement('radio', NULL, '', ts('No thank you'), '-1',
 487             [
 488               'price' => json_encode([$elementName, '0|0']),
 489               'data-currency' => $currencyName,
 490               'onclick' => 'clearAmountOther();',
 491             ]
 492           );
 493         }
 494
 495         if (!$field->is_required) {
 496           // add "none" option
 497           if (!empty($otherAmount['is_allow_other_amount']) && $field->name == 'contribution_amount') {
 498             $none = ts('Other Amount');
 499           }
 500           elseif (!empty($qf->_membershipBlock) && empty($qf->_membershipBlock['is_required']) && $field->name == 'membership_amount') {
 501             $none = ts('No thank you');
 502           }
 503           else {
 504             $none = ts('- none -');
 505           }
 506
 507           $choice[] = $qf->createElement('radio', NULL, '', $none, '0',
 508             ['price' => json_encode([$elementName, '0'])]
 509           );
 510         }
 511
 512         $element = &$qf->addGroup($choice, $elementName, $label);
 513
 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
 517         ) {
 518           $useRequired = $field->is_required = TRUE;
 519         }
 520
 521         if ($useRequired && $field->is_required) {
 522           $qf->addRule($elementName, ts('%1 is a required field.', [1 => $label]), 'required');
 523         }
 524         break;
 525
 526       case 'Select':
 527         $selectOption = $allowedOptions = $priceVal = [];
 528
 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, '');
 533
 534           if ($field->is_display_amounts) {
 535             $opt['label'] .= '&nbsp;-&nbsp;';
 536             if (isset($taxAmount) && $invoicing) {
 537               $opt['label'] = $opt['label'] . self::getTaxLabel($opt, $valueFieldName, $displayOpt, $taxTerm);
 538             }
 539             else {
 540               $opt['label'] = $opt['label'] . CRM_Utils_Money::format($opt[$valueFieldName]);
 541             }
 542           }
 543
 544           $priceVal[$opt['id']] = implode($seperator, [$opt[$valueFieldName] + $taxAmount, $count, $max_value]);
 545
 546           if (!in_array($opt['id'], $freezeOptions)) {
 547             $allowedOptions[] = $opt['id'];
 548           }
 549           // CRM-14696 - Improve display for sold out price set options
 550           else {
 551             $opt['id'] = 'crm_disabled_opt-' . $opt['id'];
 552             $opt['label'] = $opt['label'] . ' (' . ts('Sold out') . ')';
 553           }
 554
 555           $selectOption[$opt['id']] = $opt['label'];
 556
 557           if ($is_pay_later) {
 558             $qf->add('text', 'txt-' . $elementName, $label, ['size' => '4']);
 559           }
 560         }
 561         if (isset($opt['visibility_id'])) {
 562           $visibility_id = $opt['visibility_id'];
 563         }
 564         else {
 565           $visibility_id = self::getVisibilityOptionID('public');
 566         }
 567         $element = &$qf->add('select', $elementName, $label,
 568           [
 569             '' => ts('- select -'),
 570           ] + $selectOption,
 571           $useRequired && $field->is_required,
 572           ['price' => json_encode($priceVal), 'class' => 'crm-select2', 'data-price-field-values' => json_encode($customOption)]
 573         );
 574
 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) . "/");
 579         }
 580         break;
 581
 582       case 'CheckBox':
 583
 584         $check = [];
 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, '');
 589
 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>: ';
 594             }
 595             if (isset($opt['help_post'])) {
 596               $postHelpText = ': <span class="crm-price-amount-help-post description">' . $opt['help_post'] . '</span>';
 597             }
 598             $opt['label'] = '<span class="crm-price-amount-label">' . $opt['label'] . '</span>&nbsp;-&nbsp;';
 599             if (isset($taxAmount) && $invoicing) {
 600               $opt['label'] .= self::getTaxLabel($opt, $valueFieldName, $displayOpt, $taxTerm);
 601             }
 602             else {
 603               $opt['label'] .= CRM_Utils_Money::format($opt[$valueFieldName]);
 604             }
 605             $opt['label'] = $preHelpText . $opt['label'] . $postHelpText;
 606           }
 607           $priceVal = implode($seperator, [$opt[$valueFieldName] + $taxAmount, $count, $max_value]);
 608           $check[$opId] = &$qf->createElement('checkbox', $opt['id'], NULL, $opt['label'],
 609             [
 610               'price' => json_encode([$opt['id'], $priceVal]),
 611               'data-amount' => $opt[$valueFieldName],
 612               'data-currency' => $currencyName,
 613               'visibility' => $opt['visibility_id'],
 614             ]
 615           );
 616           if ($is_pay_later) {
 617             $txtcheck[$opId] =& $qf->createElement('text', $opId, $opt['label'], ['size' => '4']);
 618             $qf->addGroup($txtcheck, 'txt-' . $elementName, $label);
 619           }
 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() . '&nbsp;(' . ts('Sold out') . ')</span>');
 625           }
 626         }
 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');
 630         }
 631         break;
 632     }
 633     if (isset($qf->_online) && $qf->_online) {
 634       $element->freeze();
 635     }
 636   }
 637
 638   /**
 639    * Retrieve a list of options for the specified field.
 640    *
 641    * @param int $fieldId
 642    *   Price field ID.
 643    * @param bool $inactiveNeeded
 644    *   Include inactive options.
 645    * @param bool $reset
 646    *   Discard stored values.
 647    * @param bool $isDefaultContributionPriceSet
 648    *   Discard tax amount calculation for price set = default_contribution_amount.
 649    *
 650    * @return array
 651    *   array of options
 652    */
 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)) {
 658         return [];
 659       }
 660     }
 661
 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();
 667
 668       // ToDo - Code for Hook Invoke
 669
 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'];
 675         }
 676       }
 677       Civi::$statics[__CLASS__]['priceOptions'][$fieldId] = $options[$fieldId];
 678     }
 679
 680     return Civi::$statics[__CLASS__]['priceOptions'][$fieldId];
 681   }
 682
 683   /**
 684    * @param $optionLabel
 685    * @param int $fid
 686    *
 687    * @return mixed
 688    */
 689   public static function getOptionId($optionLabel, $fid) {
 690     if (!$optionLabel || !$fid) {
 691       return;
 692     }
 693
 694     $optionGroupName = "civicrm_price_field.amount.{$fid}";
 695
 696     $query = "
 697 SELECT
 698         option_value.id as id
 699 FROM
 700         civicrm_option_value option_value,
 701         civicrm_option_group option_group
 702 WHERE
 703         option_group.name = %1
 704     AND option_group.id = option_value.option_group_id
 705     AND option_value.label = %2";
 706
 707     $dao = CRM_Core_DAO::executeQuery($query, [
 708       1 => [$optionGroupName, 'String'],
 709       2 => [$optionLabel, 'String'],
 710     ]);
 711
 712     while ($dao->fetch()) {
 713       return $dao->id;
 714     }
 715   }
 716
 717   /**
 718    * Delete the price set field.
 719    *
 720    * @param int $id
 721    *   Field Id.
 722    *
 723    * @return bool
 724    *
 725    */
 726   public static function deleteField($id) {
 727     $field = new CRM_Price_DAO_PriceField();
 728     $field->id = $id;
 729
 730     if ($field->find(TRUE)) {
 731       // delete the options for this field
 732       CRM_Price_BAO_PriceFieldValue::deleteValues($id);
 733
 734       // reorder the weight before delete
 735       $fieldValues = ['price_set_id' => $field->price_set_id];
 736
 737       CRM_Utils_Weight::delWeight('CRM_Price_DAO_PriceField', $field->id, $fieldValues);
 738
 739       // now delete the field
 740       return $field->delete();
 741     }
 742
 743     return NULL;
 744   }
 745
 746   /**
 747    * @return array
 748    */
 749   public static function &htmlTypes() {
 750     static $htmlTypes = NULL;
 751     if (!$htmlTypes) {
 752       $htmlTypes = [
 753         'Text' => ts('Text / Numeric Quantity'),
 754         'Select' => ts('Select'),
 755         'Radio' => ts('Radio'),
 756         'CheckBox' => ts('CheckBox'),
 757       ];
 758     }
 759     return $htmlTypes;
 760   }
 761
 762   /**
 763    * Validate the priceset.
 764    *
 765    * @param int $priceSetId
 766    *   , array $fields.
 767    *
 768    * retrun the error string
 769    *
 770    * @param $fields
 771    * @param $error
 772    * @param bool $allowNoneSelection
 773    *
 774    */
 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;
 780     $priceField->find();
 781
 782     $priceFields = [];
 783
 784     if ($allowNoneSelection) {
 785       $noneSelectedPriceFields = [];
 786     }
 787
 788     while ($priceField->fetch()) {
 789       $key = "price_{$priceField->id}";
 790
 791       if ($allowNoneSelection) {
 792         if (array_key_exists($key, $fields)) {
 793           if ($fields[$key] == 0 && !$priceField->is_required) {
 794             $noneSelectedPriceFields[] = $priceField->id;
 795           }
 796         }
 797       }
 798
 799       if (!empty($fields[$key])) {
 800         $priceFields[$priceField->id] = $fields[$key];
 801       }
 802     }
 803
 804     if (!empty($priceFields)) {
 805       // we should has to have positive amount.
 806       $sql = "
 807 SELECT  id, html_type
 808 FROM  civicrm_price_field
 809 WHERE  id IN (" . implode(',', array_keys($priceFields)) . ')';
 810       $fieldDAO = CRM_Core_DAO::executeQuery($sql);
 811       $htmlTypes = [];
 812       while ($fieldDAO->fetch()) {
 813         $htmlTypes[$fieldDAO->id] = $fieldDAO->html_type;
 814       }
 815
 816       $selectedAmounts = [];
 817
 818       foreach ($htmlTypes as $fieldId => $type) {
 819         $options = [];
 820         CRM_Price_BAO_PriceFieldValue::getValues($fieldId, $options);
 821
 822         if (empty($options)) {
 823           continue;
 824         }
 825
 826         if ($type == 'Text') {
 827           foreach ($options as $opId => $option) {
 828             $selectedAmounts[$opId] = $priceFields[$fieldId] * $option['amount'];
 829             break;
 830           }
 831         }
 832         elseif (is_array($fields["price_{$fieldId}"])) {
 833           foreach (array_keys($fields["price_{$fieldId}"]) as $opId) {
 834             $selectedAmounts[$opId] = $options[$opId]['amount'];
 835           }
 836         }
 837         elseif (in_array($fields["price_{$fieldId}"], array_keys($options))) {
 838           $selectedAmounts[$fields["price_{$fieldId}"]] = $options[$fields["price_{$fieldId}"]]['amount'];
 839         }
 840       }
 841
 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]);
 849       }
 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'))
 854       ) {
 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');
 856       }
 857     }
 858     else {
 859       if ($allowNoneSelection) {
 860         if (empty($noneSelectedPriceFields)) {
 861           $error['_qf_default'] = ts('Please select at least one option from price set.');
 862         }
 863       }
 864       else {
 865         $error['_qf_default'] = ts('Please select at least one option from price set.');
 866       }
 867     }
 868   }
 869
 870   /**
 871    * Generate the label for price fields based on tax display setting option on CiviContribute Component Settings page.
 872    *
 873    * @param array $opt
 874    * @param string $valueFieldName
 875    *   Amount.
 876    * @param string $displayOpt
 877    *   Tax display setting option.
 878    *
 879    * @param string $taxTerm
 880    *
 881    * @return string
 882    *   Tax label for custom field.
 883    */
 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']);
 887     }
 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>';
 891     }
 892     else {
 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>';
 895     }
 896
 897     return $label;
 898   }
 899
 900   /**
 901    * Given the name of a visibility option, returns its ID.
 902    *
 903    * @param string $visibilityName
 904    *
 905    * @return int
 906    */
 907   public static function getVisibilityOptionID($visibilityName) {
 908
 909     if (!isset(self::$visibilityOptionsKeys)) {
 910       self::$visibilityOptionsKeys = CRM_Price_BAO_PriceField::buildOptions(
 911         'visibility_id',
 912         NULL,
 913         [
 914           'labelColumn' => 'name',
 915           'flip' => TRUE,
 916         ]
 917       );
 918     }
 919
 920     if (isset(self::$visibilityOptionsKeys[$visibilityName])) {
 921       return self::$visibilityOptionsKeys[$visibilityName];
 922     }
 923
 924     return 0;
 925   }
 926
 927 }