class TimeElement in Time Field For Drupal 8.x / 9.x 8
Same name and namespace in other branches
- 2.x src/Element/TimeElement.php \Drupal\time_field\Element\TimeElement
Provides a time field form element.
Usage example:
$form['time'] = array(
'#type' => 'time',
'#title' => $this
->t('Time'),
'#required' => TRUE,
);
Plugin annotation
@FormElement("time");
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
- class \Drupal\Core\Render\Element\RenderElement implements ElementInterface
- class \Drupal\Core\Render\Element\FormElement implements FormElementInterface
- class \Drupal\time_field\Element\TimeElement
- class \Drupal\Core\Render\Element\FormElement implements FormElementInterface
- class \Drupal\Core\Render\Element\RenderElement implements ElementInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of TimeElement
2 #type uses of TimeElement
- TimeRangeWidget::formElement in src/
Plugin/ Field/ FieldWidget/ TimeRangeWidget.php - Returns the form for a single field widget.
- TimeWidget::formElement in src/
Plugin/ Field/ FieldWidget/ TimeWidget.php
File
- src/
Element/ TimeElement.php, line 25
Namespace
Drupal\time_field\ElementView source
class TimeElement extends FormElement {
/**
* {@inheritdoc}
*/
public function getInfo() {
$class = get_class($this);
return [
'#show_seconds' => false,
'#input' => TRUE,
'#process' => [
[
$class,
'processAjaxForm',
],
],
'#pre_render' => [
[
$class,
'preRenderTime',
],
],
'#theme' => 'input__time',
'#theme_wrappers' => [
'form_element',
],
];
}
/**
* {@inheritdoc}
*/
public static function valueCallback(&$element, $input, FormStateInterface $form_state) {
if ($input === FALSE && !empty($element['#default_value'])) {
$input = $element['#default_value'];
}
if (!empty($input)) {
$time = Time::createFromHtml5Format($input);
return $time
->getTimestamp();
}
return NULL;
}
/**
* Prepares a #type 'time' 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.
*
* @see \Drupal\time_field\Plugin\Field\FieldWidget\TimeWidget::formElement()
*/
public static function preRenderTime(array $element) {
$element['#attributes']['type'] = 'time';
$element['#attributes']['class'] = [
'form-time',
];
// In ajax request value is set to raw timestamp
// perform a better solution here.
$isValuePassedInTimestampFormat = preg_match('/^\\d+$/', $element['#value']);
if ($isValuePassedInTimestampFormat) {
$element['#value'] = Time::createFromTimestamp($element['#value'])
->formatForWidget($element['#show_seconds']);
}
Element::setAttributes($element, [
'id',
'name',
'value',
'size',
'maxlength',
'placeholder',
]);
static::setAttributes($element, [
'form-text',
]);
return $element;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
FormElement:: |
public static | function | Adds autocomplete functionality to elements. | |
FormElement:: |
public static | function | #process callback for #pattern form element property. | |
FormElement:: |
public static | function | #element_validate callback for #pattern form element property. | |
MessengerTrait:: |
protected | property | The messenger. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
MessengerTrait:: |
public | function | Sets the messenger. | |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
3 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
PluginBase:: |
public | function | Constructs a \Drupal\Component\Plugin\PluginBase object. | 92 |
RenderElement:: |
public static | function | Adds Ajax information about an element to communicate with JavaScript. | |
RenderElement:: |
public static | function | Adds members of this group as actual elements for rendering. | |
RenderElement:: |
public static | function | Form element processing handler for the #ajax form property. | 1 |
RenderElement:: |
public static | function | Arranges elements into groups. | |
RenderElement:: |
public static | function |
Sets a form element's class attribute. Overrides ElementInterface:: |
|
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. | |
TimeElement:: |
public | function |
Returns the element properties for this element. Overrides ElementInterface:: |
|
TimeElement:: |
public static | function | Prepares a #type 'time' render element for input.html.twig. | |
TimeElement:: |
public static | function |
Determines how user input is mapped to an element's #value property. Overrides FormElement:: |