You are here

class Range in Zircon Profile 8

Same name in this branch
  1. 8 vendor/symfony/validator/Constraints/Range.php \Symfony\Component\Validator\Constraints\Range
  2. 8 core/lib/Drupal/Core/Render/Element/Range.php \Drupal\Core\Render\Element\Range
Same name and namespace in other branches
  1. 8.0 core/lib/Drupal/Core/Render/Element/Range.php \Drupal\Core\Render\Element\Range

Provides a slider for input of a number within a specific range.

Provides an HTML5 input element with type of "range".

Properties:

  • #min: Minimum value (defaults to 0).
  • #max: Maximum value (defaults to 100).

Refer to \Drupal\Core\Render\Element\Number for additional properties.

Usage example:

$form['quantity'] = array(
  '#type' => 'number',
  '#title' => t('Quantity'),
);

Plugin annotation

@FormElement("range");

Hierarchy

Expanded class hierarchy of Range

See also

\Drupal\Core\Render\Element\Number

5 string references to 'Range'
BinaryFileResponse::prepare in vendor/symfony/http-foundation/BinaryFileResponse.php
Prepares the Response before it is sent to the client.
BinaryFileResponseTest::testFullFileRequests in vendor/symfony/http-foundation/Tests/BinaryFileResponseTest.php
@dataProvider provideFullFileRanges
BinaryFileResponseTest::testInvalidRequests in vendor/symfony/http-foundation/Tests/BinaryFileResponseTest.php
@dataProvider provideInvalidRanges
BinaryFileResponseTest::testRequests in vendor/symfony/http-foundation/Tests/BinaryFileResponseTest.php
@dataProvider provideRanges
form_test.routing.yml in core/modules/system/tests/modules/form_test/form_test.routing.yml
core/modules/system/tests/modules/form_test/form_test.routing.yml
2 #type uses of Range
FormTestRangeForm::buildForm in core/modules/system/tests/modules/form_test/src/Form/FormTestRangeForm.php
Form constructor.
FormTestRangeInvalidForm::buildForm in core/modules/system/tests/modules/form_test/src/Form/FormTestRangeInvalidForm.php
Form constructor.

File

core/lib/Drupal/Core/Render/Element/Range.php, line 35
Contains \Drupal\Core\Render\Element\Range.

Namespace

Drupal\Core\Render\Element
View source
class Range extends Number {

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    $info = parent::getInfo();
    $class = get_class($this);
    return array(
      '#min' => 0,
      '#max' => 100,
      '#pre_render' => array(
        array(
          $class,
          'preRenderRange',
        ),
      ),
      '#theme' => 'input__range',
    ) + $info;
  }

  /**
   * Prepares a #type 'range' render element for input.html.twig.
   *
   * @param array $element
   *   An associative array containing the properties of the element.
   *   Properties used: #title, #value, #description, #min, #max, #attributes,
   *   #step.
   *
   * @return array
   *   The $element with prepared variables ready for input.html.twig.
   */
  public static function preRenderRange($element) {
    $element['#attributes']['type'] = 'range';
    Element::setAttributes($element, array(
      'id',
      'name',
      'value',
      'step',
      'min',
      'max',
    ));
    static::setAttributes($element, array(
      'form-range',
    ));
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public static function valueCallback(&$element, $input, FormStateInterface $form_state) {
    if ($input === '') {
      $offset = ($element['#max'] - $element['#min']) / 2;

      // Round to the step.
      if (strtolower($element['#step']) != 'any') {
        $steps = round($offset / $element['#step']);
        $offset = $element['#step'] * $steps;
      }
      return $element['#min'] + $offset;
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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
FormElement::processAutocomplete public static function Adds autocomplete functionality to elements.
FormElement::processPattern public static function #process callback for #pattern form element property.
FormElement::validatePattern public static function #element_validate callback for #pattern form element property.
Number::preRenderNumber public static function Prepares a #type 'number' render element for input.html.twig.
Number::validateNumber public static function Form element validation handler for #type 'number'.
PluginBase::$configuration protected property Configuration information passed into the plugin. 2
PluginBase::$pluginDefinition protected property The plugin implementation definition.
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
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::__construct public function Constructs a Drupal\Component\Plugin\PluginBase object. 69
Range::getInfo public function Returns the element properties for this element. Overrides Number::getInfo
Range::preRenderRange public static function Prepares a #type 'range' render element for input.html.twig.
Range::valueCallback public static function Determines how user input is mapped to an element's #value property. Overrides FormElement::valueCallback
RenderElement::preRenderAjaxForm public static function Adds Ajax information about an element to communicate with JavaScript.
RenderElement::preRenderGroup public static function Adds members of this group as actual elements for rendering.
RenderElement::processAjaxForm public static function Form element processing handler for the #ajax form property.
RenderElement::processGroup public static function Arranges elements into groups.
RenderElement::setAttributes public static function Sets a form element's class attribute. Overrides ElementInterface::setAttributes
StringTranslationTrait::$stringTranslation protected property The string translation service.
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.