You are here

Home » API reference » Commerce Price Table 8 » PriceTableDefaultWidget.php

class PriceTableDefaultWidget in Commerce Price Table 8

Plugin implementation of the 'commerce_price_table' widget.

Plugin annotation


@FieldWidget(
  id = "commerce_price_table_multiple",
  label = @Translation("Price table"),
  field_types = {
    "commerce_price_table"
  }
)

Hierarchy

Expanded class hierarchy of PriceTableDefaultWidget

File

src/Plugin/Field/FieldWidget/PriceTableDefaultWidget.php, line 20

Namespace

Drupal\commerce_price_table\Plugin\Field\FieldWidget
View source 
class PriceTableDefaultWidget extends WidgetBase {

  /**
   * {@inheritdoc}
   */
  public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {
    $currencies = \Drupal::entityTypeManager()
      ->getStorage('commerce_currency')
      ->loadMultiple();
    $currency_codes = array_keys($currencies);
    $default_currency_code = $this
      ->getFieldSetting('currency_code');
    $element['#attributes']['class'][] = 'form-type-commerce-price';
    $element['amount'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Price'),
      '#default_value' => isset($items[$delta]->amount) ? $items[$delta]->amount : '',
      '#size' => 10,
      '#prefix' => '<div class="form-type-commerce-price-table">',
      '#suffix' => '</div>',
    ];
    $element['currency_code'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Currency'),
      '#default_value' => $items[$delta]->currency_code ? $items[$delta]->currency_code : $default_currency_code,
      '#options' => array_combine($currency_codes, $currency_codes),
    ];
    $element['min_qty'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Minimum quantity'),
      '#default_value' => isset($items[$delta]->min_qty) ? $items[$delta]->min_qty : '',
      '#size' => 10,
      '#prefix' => '<div class="clear-commerce-price-table">',
      '#suffix' => '</div>',
    ];
    $element['max_qty'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Maximum quantity'),
      '#description' => $this
        ->t('Use -1 for no upper limit.'),
      '#default_value' => isset($items[$delta]->max_qty) ? $items[$delta]->max_qty : '',
      '#size' => 10,
    ];
    $element['#attached']['library'][] = 'commerce_price_table/admin';
    $element['#element_validate'][] = [
      get_class($this),
      'validateElement',
    ];
    return $element;
  }

  /**
   * Form validation handler for widget elements.
   */
  public static function validateElement(array $element, FormStateInterface $form_state) {
    if ($element['amount']['#value'] !== '') {

      // Ensure the price is numeric.
      if (!is_numeric($element['amount']['#value'])) {
        $form_state
          ->setError($element['amount'], t('%title: you must enter a numeric value for the price amount.', [
          '%title' => $element['amount']['#title'],
        ]));
      }
      else {
        $form_state
          ->setValueForElement($element['amount'], $element['amount']['#value']);
      }

      // Ensure the quantity fields are valid values.
      if (!isset($element['min_qty']['#value']) || $element['min_qty']['#value'] == '' || !ctype_digit($element['min_qty']['#value']) || $element['min_qty']['#value'] < 1) {
        $form_state
          ->setError($element['min_qty'], t('%name: Minimum quantity values must be integers greater than 0.', [
          '%name' => $element['min_qty']['#title'],
        ]));
      }
      else {
        $form_state
          ->setValueForElement($element['min_qty'], $element['min_qty']['#value']);
      }
      if (!isset($element['max_qty']['#value']) || $element['max_qty']['#value'] == '' || !ctype_digit($element['max_qty']['#value']) && $element['max_qty']['#value'] != -1 || $element['max_qty']['#value'] < -1 || $element['max_qty']['#value'] == 0) {
        $form_state
          ->setError($element['max_qty'], t('%name: Maximum quantity values must be integers greater than 0 or -1 for unlimited.', [
          '%name' => $element['max_qty']['#title'],
        ]));
      }
      if ($element['max_qty']['#value'] < $element['min_qty']['#value'] && $element['max_qty']['#value'] != -1) {
        $form_state
          ->setError($element['max_qty'], t('%name: Maximum quantity values must be higher than their related minimum quantity values.', [
          '%name' => $element['max_qty']['#title'],
        ]));
      }
      else {
        $form_state
          ->setValueForElement($element['max_qty'], $element['max_qty']['#value']);
      }
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AllowedTagsXssTrait::allowedTags public function Returns a list of tags allowed by AllowedTagsXssTrait::fieldFilterXss().
AllowedTagsXssTrait::displayAllowedTags public function Returns a human-readable list of allowed tags for display in help texts.
AllowedTagsXssTrait::fieldFilterXss public function Filters an HTML string to prevent XSS vulnerabilities.
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
PluginSettingsBase::$defaultSettingsMerged protected property Whether default settings have been merged into the current $settings.
PluginSettingsBase::$thirdPartySettings protected property The plugin settings injected by third party modules.
PluginSettingsBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies 6
PluginSettingsBase::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsInterface::defaultSettings 42
PluginSettingsBase::getSetting public function Returns the value of a setting, or its default value if absent. Overrides PluginSettingsInterface::getSetting
PluginSettingsBase::getSettings public function Returns the array of settings, including defaults for missing settings. Overrides PluginSettingsInterface::getSettings
PluginSettingsBase::getThirdPartyProviders public function Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
PluginSettingsBase::getThirdPartySetting public function Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
PluginSettingsBase::getThirdPartySettings public function Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
PluginSettingsBase::mergeDefaults protected function Merges default settings values into $settings.
PluginSettingsBase::onDependencyRemoval public function Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsInterface::onDependencyRemoval 3
PluginSettingsBase::setSetting public function Sets the value of a setting for the plugin. Overrides PluginSettingsInterface::setSetting
PluginSettingsBase::setSettings public function Sets the settings for the plugin. Overrides PluginSettingsInterface::setSettings
PluginSettingsBase::setThirdPartySetting public function Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
PluginSettingsBase::unsetThirdPartySetting public function Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
PriceTableDefaultWidget::formElement public function Returns the form for a single field widget. Overrides WidgetInterface::formElement
PriceTableDefaultWidget::validateElement public static function Form validation handler for widget elements.
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
WidgetBase::$fieldDefinition protected property The field definition.
WidgetBase::$settings protected property The widget settings. Overrides PluginSettingsBase::$settings
WidgetBase::addMoreAjax public static function Ajax callback for the "Add another item" button.
WidgetBase::addMoreSubmit public static function Submission handler for the "Add another item" button.
WidgetBase::afterBuild public static function After-build handler for field elements in a form.
WidgetBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 5
WidgetBase::errorElement public function Assigns a field-level validation error to the right widget sub-element. Overrides WidgetInterface::errorElement 8
WidgetBase::extractFormValues public function Extracts field values from submitted form values. Overrides WidgetBaseInterface::extractFormValues 2
WidgetBase::flagErrors public function Reports field-level validation errors against actual form elements. Overrides WidgetBaseInterface::flagErrors 2
WidgetBase::form public function Creates a form element for a field. Overrides WidgetBaseInterface::form 3
WidgetBase::formMultipleElements protected function Special handling to create form elements for multiple values. 1
WidgetBase::formSingleElement protected function Generates the form element for a single copy of the widget.
WidgetBase::getFieldSetting protected function Returns the value of a field setting.
WidgetBase::getFieldSettings protected function Returns the array of field settings.
WidgetBase::getFilteredDescription protected function Returns the filtered field description.
WidgetBase::getWidgetState public static function Retrieves processing information about the widget from $form_state. Overrides WidgetBaseInterface::getWidgetState
WidgetBase::getWidgetStateParents protected static function Returns the location of processing information within $form_state.
WidgetBase::handlesMultipleValues protected function Returns whether the widget handles multiple values.
WidgetBase::isApplicable public static function Returns if the widget can be used for the provided field. Overrides WidgetInterface::isApplicable 4
WidgetBase::isDefaultValueWidget protected function Returns whether the widget used for default value form.
WidgetBase::massageFormValues public function Massages the form values into the format expected for field values. Overrides WidgetInterface::massageFormValues 7
WidgetBase::settingsForm public function Returns a form to configure settings for the widget. Overrides WidgetInterface::settingsForm 16
WidgetBase::settingsSummary public function Returns a short summary for the current widget settings. Overrides WidgetInterface::settingsSummary 15
WidgetBase::setWidgetState public static function Stores processing information about the widget in $form_state. Overrides WidgetBaseInterface::setWidgetState
WidgetBase::__construct public function Constructs a WidgetBase object. Overrides PluginBase::__construct 5