class TimeRangePickerWidget in Time Field Picker 8.5
Plugin implementation of the 'time_range_picker_widget' widget.
Plugin annotation
@FieldWidget(
id = "time_range_picker_widget",
label = @Translation("Time range picker"),
field_types = {
"time_range_picker"
}
)
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\time_picker\Plugin\Field\FieldWidget\TimeRangePickerWidget
- class \Drupal\Core\Field\WidgetBase implements WidgetInterface, ContainerFactoryPluginInterface uses AllowedTagsXssTrait
- class \Drupal\Core\Field\PluginSettingsBase implements DependentPluginInterface, PluginSettingsInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of TimeRangePickerWidget
File
- src/
Plugin/ Field/ FieldWidget/ TimeRangePickerWidget.php, line 21
Namespace
Drupal\time_picker\Plugin\Field\FieldWidgetView source
class TimeRangePickerWidget extends WidgetBase {
/**
* {@inheritdoc}
*/
public static function defaultSettings() {
return [] + parent::defaultSettings();
}
/**
* Gets the initial values for the widget.
*
* This is a replacement for the disabled default values functionality.
*
* @return array
* The initial values, keyed by property.
*/
protected function getInitialValues() {
$initial_values = [
'start' => '',
'end' => '',
];
return $initial_values;
}
/**
* {@inheritdoc}
*/
public function settingsForm(array $form, FormStateInterface $form_state) {
$elements = [];
return $elements;
}
/**
* {@inheritdoc}
*/
public function settingsSummary() {
$summary = [];
return $summary;
}
/**
* {@inheritdoc}
*/
public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {
$start = isset($items[$delta]->start) ? $items[$delta]->start : '';
$end = isset($items[$delta]->end) ? $items[$delta]->end : '';
if ($this->fieldDefinition
->getFieldStorageDefinition()
->getCardinality() == 1) {
$element += [
'#type' => 'fieldset',
'#attributes' => [
'class' => [
'time_range_fieldset',
],
],
];
}
$element['start'] = [
'#type' => 'textfield',
'#title' => $this
->t('Start time'),
'#default_value' => $start,
'#attributes' => [
'class' => [
'time_range_picker',
],
],
'#size' => 10,
'#maxlength' => 10,
'#element_validate' => [
[
$this,
'validate',
],
],
];
$element['end'] = [
'#type' => 'textfield',
'#title' => $this
->t('End time'),
'#default_value' => $end,
'#attributes' => [
'class' => [
'time_range_picker',
],
],
'#size' => 10,
'#maxlength' => 10,
'#element_validate' => [
[
$this,
'validate',
],
],
];
$element['#element_validate'][] = [
$this,
'validateStartEnd',
];
$element['#attached']['library'][] = 'time_picker/time_picker';
$element['#attached']['drupalSettings']['time_range_picker'] = [
'hour_format' => $this
->getFieldSetting('hour_format'),
'theme_color' => $this
->getFieldSetting('time_picker_theme'),
];
return $element;
}
/**
* Validate the color text field.
*/
public function validate($element, FormStateInterface $form_state) {
$value = $element['#value'];
if (strlen($value) === 0) {
$form_state
->setValueForElement($element, '');
return;
}
$hour_format = $this
->getFieldSetting('hour_format');
if ($hour_format === '12h') {
if (!preg_match('/^(0?[1-9]|1[012])(:[0-5]\\d) [APap][mM]$/', $value)) {
$form_state
->setError($element, $this
->t('Please enter valid time formate.'));
}
}
elseif ($hour_format === '24h') {
if (!preg_match('/^([0-9]|0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$/', $value)) {
$form_state
->setError($element, $this
->t('Please enter valid time formate.'));
}
}
}
/**
* Element_validate callback to ensure that the start date <= the end date.
*
* @param array $element
* An associative array containing the properties and children of the
* generic form element.
* @param \Drupal\Core\Form\FormStateInterface $form_state
* The current state of the form.
* @param array $complete_form
* The complete form structure.
*/
public function validateStartEnd(array &$element, FormStateInterface $form_state, array &$complete_form) {
$start_time = $element['start']['#value'];
$end_time = $element['end']['#value'];
if (!empty($start_time) && !empty($end_time)) {
$tz = date_default_timezone_get();
$start = new DrupalDateTime($start_time, $tz);
$end = new DrupalDateTime($end_time, $tz);
if ($start > $end) {
$form_state
->setError($element, $this
->t('Please enter valid time formate : End time greater than Start time.'));
}
}
}
}
Members
Name![]() |
Modifiers | Type | Description | Overrides |
---|---|---|---|---|
AllowedTagsXssTrait:: |
public | function | Returns a list of tags allowed by AllowedTagsXssTrait::fieldFilterXss(). | |
AllowedTagsXssTrait:: |
public | function | Returns a human-readable list of allowed tags for display in help texts. | |
AllowedTagsXssTrait:: |
public | function | Filters an HTML string to prevent XSS vulnerabilities. | |
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 | |
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. | |
PluginSettingsBase:: |
protected | property | Whether default settings have been merged into the current $settings. | |
PluginSettingsBase:: |
protected | property | The plugin settings injected by third party modules. | |
PluginSettingsBase:: |
public | function |
Calculates dependencies for the configured plugin. Overrides DependentPluginInterface:: |
6 |
PluginSettingsBase:: |
public | function |
Returns the value of a setting, or its default value if absent. Overrides PluginSettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Returns the array of settings, including defaults for missing settings. Overrides PluginSettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface:: |
|
PluginSettingsBase:: |
protected | function | Merges default settings values into $settings. | |
PluginSettingsBase:: |
public | function |
Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsInterface:: |
3 |
PluginSettingsBase:: |
public | function |
Sets the value of a setting for the plugin. Overrides PluginSettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Sets the settings for the plugin. Overrides PluginSettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Unsets a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
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. | |
TimeRangePickerWidget:: |
public static | function |
Defines the default settings for this plugin. Overrides PluginSettingsBase:: |
|
TimeRangePickerWidget:: |
public | function |
Returns the form for a single field widget. Overrides WidgetInterface:: |
|
TimeRangePickerWidget:: |
protected | function | Gets the initial values for the widget. | |
TimeRangePickerWidget:: |
public | function |
Returns a form to configure settings for the widget. Overrides WidgetBase:: |
|
TimeRangePickerWidget:: |
public | function |
Returns a short summary for the current widget settings. Overrides WidgetBase:: |
|
TimeRangePickerWidget:: |
public | function | Validate the color text field. | |
TimeRangePickerWidget:: |
public | function | Element_validate callback to ensure that the start date <= the end date. | |
WidgetBase:: |
protected | property | The field definition. | |
WidgetBase:: |
protected | property |
The widget settings. Overrides PluginSettingsBase:: |
|
WidgetBase:: |
public static | function | Ajax callback for the "Add another item" button. | |
WidgetBase:: |
public static | function | Submission handler for the "Add another item" button. | |
WidgetBase:: |
public static | function | After-build handler for field elements in a form. | |
WidgetBase:: |
public static | function |
Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface:: |
5 |
WidgetBase:: |
public | function |
Assigns a field-level validation error to the right widget sub-element. Overrides WidgetInterface:: |
8 |
WidgetBase:: |
public | function |
Extracts field values from submitted form values. Overrides WidgetBaseInterface:: |
2 |
WidgetBase:: |
public | function |
Reports field-level validation errors against actual form elements. Overrides WidgetBaseInterface:: |
2 |
WidgetBase:: |
public | function |
Creates a form element for a field. Overrides WidgetBaseInterface:: |
3 |
WidgetBase:: |
protected | function | Special handling to create form elements for multiple values. | 1 |
WidgetBase:: |
protected | function | Generates the form element for a single copy of the widget. | |
WidgetBase:: |
protected | function | Returns the value of a field setting. | |
WidgetBase:: |
protected | function | Returns the array of field settings. | |
WidgetBase:: |
protected | function | Returns the filtered field description. | |
WidgetBase:: |
public static | function |
Retrieves processing information about the widget from $form_state. Overrides WidgetBaseInterface:: |
|
WidgetBase:: |
protected static | function | Returns the location of processing information within $form_state. | |
WidgetBase:: |
protected | function | Returns whether the widget handles multiple values. | |
WidgetBase:: |
public static | function |
Returns if the widget can be used for the provided field. Overrides WidgetInterface:: |
4 |
WidgetBase:: |
protected | function | Returns whether the widget used for default value form. | |
WidgetBase:: |
public | function |
Massages the form values into the format expected for field values. Overrides WidgetInterface:: |
7 |
WidgetBase:: |
public static | function |
Stores processing information about the widget in $form_state. Overrides WidgetBaseInterface:: |
|
WidgetBase:: |
public | function |
Constructs a WidgetBase object. Overrides PluginBase:: |
5 |