class Tel
Same name and namespace in other branches
- 9 core/lib/Drupal/Core/Render/Element/Tel.php \Drupal\Core\Render\Element\Tel
- 8.9.x core/lib/Drupal/Core/Render/Element/Tel.php \Drupal\Core\Render\Element\Tel
- 10 core/lib/Drupal/Core/Render/Element/Tel.php \Drupal\Core\Render\Element\Tel
Provides a form element for entering a telephone number.
Provides an HTML5 input element with type of "tel". It provides no special validation.
Properties:
@property $size The size of the input element in characters. @property $pattern A string for the native HTML5 pattern attribute.
Usage example:
$form['phone'] = [
'#type' => 'tel',
'#title' => $this->t('Phone'),
'#pattern' => '[^\\d]*',
];
Attributes
#[FormElement('tel')]
Hierarchy
- class \Drupal\Component\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait implements \Drupal\Component\Plugin\PluginBase
- class \Drupal\Core\Render\Element\RenderElementBase extends \Drupal\Core\Render\Element\ElementInterface, \Drupal\Core\Plugin\ContainerFactoryPluginInterface implements \Drupal\Core\Plugin\PluginBase
- class \Drupal\Core\Render\Element\FormElementBase extends \Drupal\Core\Render\Element\FormElementInterface implements \Drupal\Core\Render\Element\RenderElementBase
- class \Drupal\Core\Render\Element\Tel implements \Drupal\Core\Render\Element\FormElementBase
- class \Drupal\Core\Render\Element\FormElementBase extends \Drupal\Core\Render\Element\FormElementInterface implements \Drupal\Core\Render\Element\RenderElementBase
- class \Drupal\Core\Render\Element\RenderElementBase extends \Drupal\Core\Render\Element\ElementInterface, \Drupal\Core\Plugin\ContainerFactoryPluginInterface implements \Drupal\Core\Plugin\PluginBase
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait implements \Drupal\Component\Plugin\PluginBase
Expanded class hierarchy of Tel
See also
12 string references to 'Tel'
- claro_preprocess_input in core/
themes/ claro/ claro.theme - Implements template_preprocess_HOOK() for input.
- core.services.yml in core/
core.services.yml - core/core.services.yml
- default.services.yml in sites/
default/ default.services.yml - sites/default/default.services.yml
- default.services.yml in core/
assets/ scaffold/ files/ default.services.yml - core/assets/scaffold/files/default.services.yml
- ElementTest::testPlaceHolderText in core/
modules/ system/ tests/ src/ Functional/ Form/ ElementTest.php - Tests placeholder text for elements that support placeholders.
3 #type uses of Tel
- FormTest::testRequiredFields in core/
modules/ system/ tests/ src/ Functional/ Form/ FormTest.php - Check several empty values for required forms elements.
- FormTestPatternForm::buildForm in core/
modules/ system/ tests/ modules/ form_test/ src/ Form/ FormTestPatternForm.php - Form constructor.
- TelephoneDefaultWidget::formElement in core/
modules/ telephone/ src/ Plugin/ Field/ FieldWidget/ TelephoneDefaultWidget.php - Returns the form for a single field widget.
File
-
core/
lib/ Drupal/ Core/ Render/ Element/ Tel.php, line 32
Namespace
Drupal\Core\Render\ElementView source
class Tel extends FormElementBase {
/**
* {@inheritdoc}
*/
public function getInfo() {
return [
'#input' => TRUE,
'#size' => 30,
'#maxlength' => 128,
'#autocomplete_route_name' => FALSE,
'#process' => [
[
static::class,
'processAutocomplete',
],
[
static::class,
'processAjaxForm',
],
[
static::class,
'processPattern',
],
],
'#pre_render' => [
[
static::class,
'preRenderTel',
],
],
'#theme' => 'input__tel',
'#theme_wrappers' => [
'form_element',
],
];
}
/**
* Prepares a #type 'tel' render element for input.html.twig.
*
* @param array $element
* An associative array containing the properties of the element.
* Properties used: #title, #value, #description, #size, #maxlength,
* #placeholder, #required, #attributes.
*
* @return array
* The $element with prepared variables ready for input.html.twig.
*/
public static function preRenderTel($element) {
$element['#attributes']['type'] = 'tel';
Element::setAttributes($element, [
'id',
'name',
'value',
'size',
'maxlength',
'placeholder',
]);
static::setAttributes($element, [
'form-tel',
]);
return $element;
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
FormElementBase::processAutocomplete | public static | function | Adds autocomplete functionality to elements. | 1 | |
FormElementBase::processPattern | public static | function | Render API callback: Handles the #pattern form element property. | 1 | |
FormElementBase::validatePattern | public static | function | Render API callback: Handles the #pattern form element property.. | 1 | |
FormElementBase::valueCallback | public static | function | Determines how user input is mapped to an element's #value property. | Overrides FormElementInterface::valueCallback | 17 |
PluginInspectionInterface::getPluginDefinition | public | function | Gets the definition of the plugin implementation. | 7 | |
PluginInspectionInterface::getPluginId | public | function | Gets the plugin ID of the plugin instance. | 3 | |
RenderElementBase::$renderParent | protected | property | The parent element. | ||
RenderElementBase::$renderParentName | protected | property | The parent key. | ||
RenderElementBase::$storage | protected | property | The storage. | ||
RenderElementBase::addChild | public | function | Adds a child render element. | Overrides ElementInterface::addChild | |
RenderElementBase::changeType | public | function | Change the type of the element. | Overrides ElementInterface::changeType | |
RenderElementBase::create | public static | function | Creates an instance of the plugin. | Overrides ContainerFactoryPluginInterface::create | |
RenderElementBase::createChild | public | function | Creates a render object and attaches it to the current render object. | Overrides ElementInterface::createChild | |
RenderElementBase::elementInfoManager | protected | function | Returns the element info manager. | ||
RenderElementBase::getChild | public | function | Gets a child. | Overrides ElementInterface::getChild | |
RenderElementBase::getChildren | public | function | Returns child elements. | Overrides ElementInterface::getChildren | |
RenderElementBase::initializeInternalStorage | public | function | Initialize storage. | Overrides ElementInterface::initializeInternalStorage | |
RenderElementBase::preRenderAjaxForm | public static | function | Adds Ajax information about an element to communicate with JavaScript. | 2 | |
RenderElementBase::preRenderGroup | public static | function | Adds members of this group as actual elements for rendering. | 2 | |
RenderElementBase::processAjaxForm | public static | function | Form element processing handler for the #ajax form property. | 3 | |
RenderElementBase::processGroup | public static | function | Arranges elements into groups. | 2 | |
RenderElementBase::removeChild | public | function | Removes a child. | Overrides ElementInterface::removeChild | |
RenderElementBase::setAttributes | public static | function | Sets a form element's class attribute. | Overrides ElementInterface::setAttributes | 2 |
RenderElementBase::setType | protected | function | Set type on initialize. | ||
RenderElementBase::toRenderable | public | function | Returns a render array. | Overrides ElementInterface::toRenderable | |
RenderElementBase::__construct | public | function | Constructs a new render element object. | ||
RenderElementBase::__get | public | function | Magic method: gets a property value. | ||
RenderElementBase::__isset | public | function | Magic method: checks if a property value is set. | ||
RenderElementBase::__set | public | function | Magic method: Sets a property value. | ||
RenderElementBase::__sleep | public | function | |||
RenderElementBase::__unset | public | function | Magic method: unsets a property value. | ||
RenderElementBase::__wakeup | public | function | |||
Tel::getInfo | public | function | Returns the element properties for this element. | Overrides ElementInterface::getInfo | |
Tel::preRenderTel | public static | function | Prepares a #type 'tel' render element for input.html.twig. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.