class RangeWidget in Range 8

Plugin implementation of the 'range' widget.

Plugin annotation


@FieldWidget(
  id = "range",
  label = @Translation("Text fields"),
  field_types = {
    "range_integer",
    "range_float",
    "range_decimal"
  }
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\Core\Field\PluginSettingsBase implements DependentPluginInterface, PluginSettingsInterface
    class \Drupal\Core\Field\WidgetBase implements WidgetInterface, ContainerFactoryPluginInterface uses AllowedTagsXssTrait
    class \Drupal\range\Plugin\Field\FieldWidget\RangeWidget

Expanded class hierarchy of RangeWidget

File

src/Plugin/Field/FieldWidget/RangeWidget.php, line 23

Namespace

Drupal\range\Plugin\Field\FieldWidget

View source

class RangeWidget extends WidgetBase {

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'placeholder' => [
        'from' => '',
        'to' => '',
      ],
      'label' => [
        'from' => t('From'),
        'to' => t('to'),
      ],
    ] + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $element = [];
    $element['label']['from'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('FROM form element label'),
      '#default_value' => $this
        ->getSetting('label')['from'],
      '#description' => $this
        ->t('Define label for the form element.'),
      '#required' => TRUE,
    ];
    $element['label']['to'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('TO form element label'),
      '#default_value' => $this
        ->getSetting('label')['to'],
      '#description' => $this
        ->t('Define label for the form element.'),
      '#required' => TRUE,
    ];
    $element['placeholder']['from'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('FROM placeholder'),
      '#default_value' => $this
        ->getSetting('placeholder')['from'],
      '#description' => $this
        ->t('Text that will be shown inside the field until a value is entered. This hint is usually a sample value or a brief description of the expected format.'),
    ];
    $element['placeholder']['to'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('TO placeholder'),
      '#default_value' => $this
        ->getSetting('placeholder')['to'],
      '#description' => $this
        ->t('Text that will be shown inside the field until a value is entered. This hint is usually a sample value or a brief description of the expected format.'),
    ];
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = [];
    $summary[] = $this
      ->t('FROM form element label: @label', [
      '@label' => $this
        ->getSetting('label')['from'],
    ]);
    $summary[] = $this
      ->t('TO form element label: @label', [
      '@label' => $this
        ->getSetting('label')['to'],
    ]);
    $placeholder = $this
      ->getSetting('placeholder');
    $summary[] = !empty($placeholder['from']) ? $this
      ->t('FROM placeholder: @placeholder', [
      '@placeholder' => $placeholder['from'],
    ]) : $this
      ->t('No FROM placeholder');
    $summary[] = !empty($placeholder['to']) ? $this
      ->t('TO placeholder: @placeholder', [
      '@placeholder' => $placeholder['to'],
    ]) : $this
      ->t('No TO placeholder');
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {
    $from = isset($items[$delta]->from) ? $items[$delta]->from : NULL;
    $to = isset($items[$delta]->to) ? $items[$delta]->to : NULL;
    $base = [
      '#type' => 'number',
      '#required' => $element['#required'],
    ];

    // Set the step for floating point and decimal numbers.
    switch ($this->fieldDefinition
      ->getType()) {
      case 'range_decimal':
        $base['#step'] = pow(0.1, $this
          ->getFieldSetting('scale'));
        break;
      case 'range_float':
        $base['#step'] = 'any';
        break;
    }

    // Set minimum and maximum.
    if (is_numeric($this
      ->getFieldSetting('min'))) {
      $base['#min'] = $this
        ->getFieldSetting('min');
    }
    if (is_numeric($this
      ->getFieldSetting('max'))) {
      $base['#max'] = $this
        ->getFieldSetting('max');
    }
    $element += [
      // Wrap in a fieldset for single field.
      '#type' => $this->fieldDefinition
        ->getFieldStorageDefinition()
        ->getCardinality() === 1 ? 'fieldset' : 'container',
      '#attributes' => [
        'class' => [
          'field--widget-range-text-fields',
          'clearfix',
        ],
      ],
    ];
    $element['from'] = [
      '#title' => $this
        ->getSetting('label')['from'],
      '#default_value' => $from,
      '#placeholder' => $this
        ->getSetting('placeholder')['from'],
    ] + $base;
    $element['to'] = [
      '#title' => $this
        ->getSetting('label')['to'],
      '#default_value' => $to,
      '#placeholder' => $this
        ->getSetting('placeholder')['to'],
    ] + $base;

    // Add FROM/TO prefixes and suffixes.
    $this
      ->formElementSubElementPrefixSuffix($element, 'from');
    $this
      ->formElementSubElementPrefixSuffix($element, 'to');

    // Add FIELD prefix and suffix.
    $element['from']['#field_prefix'] = FieldFilteredMarkup::create($this
      ->getFieldSetting('field')['prefix'] ?? '') . $element['from']['#field_prefix'];
    $element['to']['#field_suffix'] .= FieldFilteredMarkup::create($this
      ->getFieldSetting('field')['suffix'] ?? '');
    $element['#attached']['library'][] = 'range/range.field-widget';
    return $element;
  }

  /**
   * Helper method. Adds prefix/suffix to a range field widget subelements.
   *
   * @param array $element
   *   Range field widget definition array.
   * @param string $element_name
   *   Form element machine name.
   */
  protected function formElementSubElementPrefixSuffix(array &$element, $element_name) {
    $setting = $this
      ->getFieldSetting($element_name);
    $element[$element_name]['#field_prefix'] = FieldFilteredMarkup::create($setting['prefix']);
    $element[$element_name]['#field_suffix'] = FieldFilteredMarkup::create($setting['suffix']);
  }

}

Members

Name	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::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
RangeWidget::defaultSettings	public static	function	Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
RangeWidget::formElement	public	function	Returns the form for a single field widget. Overrides WidgetInterface::formElement
RangeWidget::formElementSubElementPrefixSuffix	protected	function	Helper method. Adds prefix/suffix to a range field widget subelements.
RangeWidget::settingsForm	public	function	Returns a form to configure settings for the widget. Overrides WidgetBase::settingsForm
RangeWidget::settingsSummary	public	function	Returns a short summary for the current widget settings. Overrides WidgetBase::settingsSummary
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::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

You are here

class RangeWidget in Range 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation