class Number

Same name in this branch
  1. 9 core/lib/Drupal/Component/Utility/Number.php \Drupal\Component\Utility\Number
Same name in other branches
  1. 8.9.x core/lib/Drupal/Core/Render/Element/Number.php \Drupal\Core\Render\Element\Number
  2. 8.9.x core/lib/Drupal/Component/Utility/Number.php \Drupal\Component\Utility\Number
  3. 10 core/lib/Drupal/Core/Render/Element/Number.php \Drupal\Core\Render\Element\Number
  4. 10 core/lib/Drupal/Component/Utility/Number.php \Drupal\Component\Utility\Number
  5. 11.x core/lib/Drupal/Core/Render/Element/Number.php \Drupal\Core\Render\Element\Number
  6. 11.x core/lib/Drupal/Component/Utility/Number.php \Drupal\Component\Utility\Number

Provides a form element for numeric input, with special numeric validation.

Properties:

  • #default_value: A valid floating point number.
  • #min: Minimum value.
  • #max: Maximum value.
  • #step: Ensures that the number is an even multiple of step, offset by #min if specified. A #min of 1 and a #step of 2 would allow values of 1, 3, 5, etc.

Usage example:

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

Plugin annotation

@FormElement("number");

Hierarchy

Expanded class hierarchy of Number

See also

\Drupal\Core\Render\Element\Range

\Drupal\Core\Render\Element\Textfield

1 file declares its use of Number
WeightTest.php in core/tests/Drupal/KernelTests/Core/Render/Element/WeightTest.php
45 string references to 'Number'
claro_preprocess_input in core/themes/claro/claro.theme
Implements template_preprocess_HOOK() for input.
ConfigEntityQueryTest::testTableSort in core/tests/Drupal/KernelTests/Core/Entity/ConfigEntityQueryTest.php
Tests sorting with tableSort on config entity queries.
ConfigEntityQueryTest::testTableSort in core/tests/Drupal/KernelTests/Core/Entity/ConfigEntityQueryTest.php
Tests sorting with tableSort on config entity queries.
config_test.schema.yml in core/modules/config/tests/config_test/config/schema/config_test.schema.yml
core/modules/config/tests/config_test/config/schema/config_test.schema.yml
core.entity_form_display.node.recipe.default.yml in core/profiles/demo_umami/config/install/core.entity_form_display.node.recipe.default.yml
core/profiles/demo_umami/config/install/core.entity_form_display.node.recipe.default.yml

... See full list

41 #type uses of Number
AjaxFormsTestValidationForm::buildForm in core/modules/system/tests/modules/ajax_forms_test/src/Form/AjaxFormsTestValidationForm.php
Form constructor.
AjaxTestImageEffect::buildConfigurationForm in core/modules/image/tests/modules/image_module_test/src/Plugin/ImageEffect/AjaxTestImageEffect.php
CommentItem::fieldSettingsForm in core/modules/comment/src/Plugin/Field/FieldType/CommentItem.php
Returns a form for the field-level settings.
DecimalFormatter::settingsForm in core/lib/Drupal/Core/Field/Plugin/Field/FieldFormatter/DecimalFormatter.php
Returns a form to configure settings for the formatter.
DecimalItem::storageSettingsForm in core/lib/Drupal/Core/Field/Plugin/Field/FieldType/DecimalItem.php
Returns a form for the storage-level settings.

... See full list

File

core/lib/Drupal/Core/Render/Element/Number.php, line 33

Namespace

Drupal\Core\Render\Element
View source
class Number extends FormElement {
    
    /**
     * {@inheritdoc}
     */
    public function getInfo() {
        $class = static::class;
        return [
            '#input' => TRUE,
            '#step' => 1,
            '#process' => [
                [
                    $class,
                    'processAjaxForm',
                ],
            ],
            '#element_validate' => [
                [
                    $class,
                    'validateNumber',
                ],
            ],
            '#pre_render' => [
                [
                    $class,
                    'preRenderNumber',
                ],
            ],
            '#theme' => 'input__number',
            '#theme_wrappers' => [
                'form_element',
            ],
        ];
    }
    
    /**
     * Form element validation handler for #type 'number'.
     *
     * Note that #required is validated by _form_validate() already.
     */
    public static function validateNumber(&$element, FormStateInterface $form_state, &$complete_form) {
        $value = $element['#value'];
        if ($value === '') {
            return;
        }
        $name = empty($element['#title']) ? $element['#parents'][0] : $element['#title'];
        // Ensure the input is numeric.
        if (!is_numeric($value)) {
            $form_state->setError($element, t('%name must be a number.', [
                '%name' => $name,
            ]));
            return;
        }
        // Ensure that the input is greater than the #min property, if set.
        if (isset($element['#min']) && $value < $element['#min']) {
            $form_state->setError($element, t('%name must be higher than or equal to %min.', [
                '%name' => $name,
                '%min' => $element['#min'],
            ]));
        }
        // Ensure that the input is less than the #max property, if set.
        if (isset($element['#max']) && $value > $element['#max']) {
            $form_state->setError($element, t('%name must be lower than or equal to %max.', [
                '%name' => $name,
                '%max' => $element['#max'],
            ]));
        }
        if (isset($element['#step']) && strtolower($element['#step']) != 'any') {
            // Check that the input is an allowed multiple of #step (offset by #min if
            // #min is set).
            $offset = $element['#min'] ?? 0.0;
            if (!NumberUtility::validStep($value, $element['#step'], $offset)) {
                $form_state->setError($element, t('%name is not a valid number.', [
                    '%name' => $name,
                ]));
            }
        }
    }
    
    /**
     * Prepares a #type 'number' 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, #placeholder,
     *   #required, #attributes, #step, #size.
     *
     * @return array
     *   The $element with prepared variables ready for input.html.twig.
     */
    public static function preRenderNumber($element) {
        $element['#attributes']['type'] = 'number';
        Element::setAttributes($element, [
            'id',
            'name',
            'value',
            'step',
            'min',
            'max',
            'placeholder',
            'size',
        ]);
        static::setAttributes($element, [
            'form-number',
        ]);
        return $element;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
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.
FormElement::valueCallback public static function Determines how user input is mapped to an element&#039;s #value property. Overrides FormElementInterface::valueCallback 16
Number::getInfo public function Returns the element properties for this element. Overrides ElementInterface::getInfo 1
Number::preRenderNumber public static function Prepares a #type &#039;number&#039; render element for input.html.twig.
Number::validateNumber public static function Form element validation handler for #type &#039;number&#039;.
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 6
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance. 2
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. 1
RenderElement::processGroup public static function Arranges elements into groups.
RenderElement::setAttributes public static function Sets a form element&#039;s class attribute. Overrides ElementInterface::setAttributes

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.