class DateTimeWidgetBase
Base class for the 'datetime_*' widgets.
Hierarchy
- class \Drupal\datetime\Plugin\Field\FieldWidget\DateTimeWidgetBase extends \Drupal\Core\Field\WidgetBase
Expanded class hierarchy of DateTimeWidgetBase
1 file declares its use of DateTimeWidgetBase
- DateRangeWidgetBase.php in core/
modules/ datetime_range/ src/ Plugin/ Field/ FieldWidget/ DateRangeWidgetBase.php
File
-
core/
modules/ datetime/ src/ Plugin/ Field/ FieldWidget/ DateTimeWidgetBase.php, line 15
Namespace
Drupal\datetime\Plugin\Field\FieldWidgetView source
class DateTimeWidgetBase extends WidgetBase {
/**
* {@inheritdoc}
*/
public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {
$element['value'] = [
'#type' => 'datetime',
'#default_value' => NULL,
'#date_increment' => 1,
'#date_timezone' => date_default_timezone_get(),
'#required' => $element['#required'],
];
if ($this->getFieldSetting('datetime_type') == DateTimeItem::DATETIME_TYPE_DATE) {
// A date-only field should have no timezone conversion performed, so
// use the same timezone as for storage.
$element['value']['#date_timezone'] = DateTimeItemInterface::STORAGE_TIMEZONE;
}
if ($items[$delta]->date) {
$element['value']['#default_value'] = $this->createDefaultValue($items[$delta]->date, $element['value']['#date_timezone']);
}
return $element;
}
/**
* {@inheritdoc}
*/
public function massageFormValues(array $values, array $form, FormStateInterface $form_state) {
// The widget form element type has transformed the value to a
// DrupalDateTime object at this point. We need to convert it back to the
// storage timezone and format.
$datetime_type = $this->getFieldSetting('datetime_type');
if ($datetime_type === DateTimeItem::DATETIME_TYPE_DATE) {
$storage_format = DateTimeItemInterface::DATE_STORAGE_FORMAT;
}
else {
$storage_format = DateTimeItemInterface::DATETIME_STORAGE_FORMAT;
}
$storage_timezone = new \DateTimeZone(DateTimeItemInterface::STORAGE_TIMEZONE);
foreach ($values as &$item) {
if (!empty($item['value']) && $item['value'] instanceof DrupalDateTime) {
/** @var \Drupal\Core\Datetime\DrupalDateTime $date */
$date = $item['value'];
// Adjust the date for storage.
$item['value'] = $date->setTimezone($storage_timezone)
->format($storage_format);
}
}
return $values;
}
/**
* Creates a date object for use as a default value.
*
* This will take a default value, apply the proper timezone for display in
* a widget, and set the default time for date-only fields.
*
* @param \Drupal\Core\Datetime\DrupalDateTime $date
* The UTC default date.
* @param string $timezone
* The timezone to apply.
*
* @return \Drupal\Core\Datetime\DrupalDateTime
* A date object for use as a default value in a field widget.
*/
protected function createDefaultValue($date, $timezone) {
// The date was created and verified during field_load(), so it is safe to
// use without further inspection.
$year = $date->format('Y');
$month = $date->format('m');
$day = $date->format('d');
$date->setTimezone(new \DateTimeZone($timezone));
if ($this->getFieldSetting('datetime_type') === DateTimeItem::DATETIME_TYPE_DATE) {
$date->setDefaultDateTime();
// Reset the date to handle cases where the UTC offset is greater than
// 12 hours.
$date->setDate($year, $month, $day);
}
return $date;
}
}
Members
| Title Sort descending | Deprecated | Modifiers | Object type | Summary | Overriden Title | Overrides |
|---|---|---|---|---|---|---|
| AutowiredInstanceTrait::createInstanceAutowired | public static | function | Instantiates a new instance of the implementing class using autowiring. | |||
| DateTimeWidgetBase::createDefaultValue | protected | function | Creates a date object for use as a default value. | |||
| DateTimeWidgetBase::formElement | public | function | Overrides WidgetInterface::formElement | 3 | ||
| DateTimeWidgetBase::massageFormValues | public | function | Overrides WidgetBase::massageFormValues | 1 | ||
| DependencySerializationTrait::$_entityStorages | protected | property | An array of entity type IDs keyed by the property name of their storages. | |||
| DependencySerializationTrait::$_serviceIds | protected | property | An array of service IDs keyed by property name used for serialization. | |||
| DependencySerializationTrait::__sleep | public | function | 2 | |||
| DependencySerializationTrait::__wakeup | public | function | 2 | |||
| MessengerTrait::$messenger | protected | property | The messenger. | 25 | ||
| MessengerTrait::messenger | public | function | Gets the messenger. | 25 | ||
| MessengerTrait::setMessenger | public | function | Sets the messenger. | |||
| PluginBase::$configuration | protected | property | Configuration information passed into the plugin. | 1 | ||
| PluginBase::$pluginDefinition | protected | property | The plugin implementation definition. | 1 | ||
| 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 | 2 | |
| PluginBase::getPluginId | public | function | Gets the plugin ID of the plugin instance. | Overrides PluginInspectionInterface::getPluginId | ||
| PluginBase::isConfigurable | Deprecated | public | function | Determines if the plugin is configurable. | ||
| PluginSettingsBase::$defaultSettingsMerged | protected | property | Whether default settings have been merged into the current $settings. | |||
| PluginSettingsBase::$thirdPartySettings | protected | property | The plugin settings injected by third party modules. | |||
| PluginSettingsBase::calculateDependencies | public | function | Overrides DependentPluginInterface::calculateDependencies | 6 | ||
| PluginSettingsBase::defaultSettings | public static | function | Overrides PluginSettingsInterface::defaultSettings | 42 | ||
| PluginSettingsBase::getSetting | public | function | Overrides PluginSettingsInterface::getSetting | |||
| PluginSettingsBase::getSettings | public | function | Overrides PluginSettingsInterface::getSettings | |||
| PluginSettingsBase::getThirdPartyProviders | public | function | Overrides ThirdPartySettingsInterface::getThirdPartyProviders | |||
| PluginSettingsBase::getThirdPartySetting | public | function | Overrides ThirdPartySettingsInterface::getThirdPartySetting | |||
| PluginSettingsBase::getThirdPartySettings | public | function | Overrides ThirdPartySettingsInterface::getThirdPartySettings | |||
| PluginSettingsBase::mergeDefaults | protected | function | Merges default settings values into $settings. | |||
| PluginSettingsBase::onDependencyRemoval | public | function | Overrides PluginSettingsInterface::onDependencyRemoval | 3 | ||
| PluginSettingsBase::setSetting | public | function | Overrides PluginSettingsInterface::setSetting | |||
| PluginSettingsBase::setSettings | public | function | Overrides PluginSettingsInterface::setSettings | |||
| PluginSettingsBase::setThirdPartySetting | public | function | Overrides ThirdPartySettingsInterface::setThirdPartySetting | |||
| PluginSettingsBase::unsetThirdPartySetting | public | function | Overrides ThirdPartySettingsInterface::unsetThirdPartySetting | |||
| StringTranslationTrait::$stringTranslation | protected | property | The string translation service. | 3 | ||
| 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. | 1 | ||
| WidgetBase::$fieldDefinition | protected | property | The field definition. | |||
| WidgetBase::$settings | protected | property | The widget settings. | Overrides PluginSettingsBase::$settings | ||
| WidgetBase::addMoreAjax | public static | function | Ajax callback for the "Add another item" button. | |||
| WidgetBase::addMoreSubmit | public static | function | Submission handler for the "Add another item" button. | |||
| WidgetBase::afterBuild | public static | function | After-build handler for field elements in a form. | |||
| WidgetBase::create | public static | function | Overrides PluginBase::create | 5 | ||
| WidgetBase::deleteAjax | public static | function | Ajax refresh callback for the "Remove" button. | |||
| WidgetBase::deleteSubmit | public static | function | Ajax submit callback for the "Remove" button. | |||
| WidgetBase::errorElement | public | function | Overrides WidgetInterface::errorElement | 10 | ||
| WidgetBase::extractFormValues | public | function | Overrides WidgetBaseInterface::extractFormValues | 3 | ||
| WidgetBase::flagErrors | public | function | Overrides WidgetBaseInterface::flagErrors | 2 | ||
| WidgetBase::form | public | function | Overrides WidgetBaseInterface::form | 3 | ||
| WidgetBase::formMultipleElements | protected | function | Special handling to create form elements for multiple values. | 1 | ||
| WidgetBase::formSingleElement | protected | function | Generates the form element for a single copy of the widget. | |||
| WidgetBase::getFieldSetting | protected | function | Returns the value of a field setting. | |||
| WidgetBase::getFieldSettings | protected | function | Returns the array of field settings. | |||
| WidgetBase::getFilteredDescription | protected | function | Returns the filtered field description. | |||
| WidgetBase::getWidgetState | public static | function | Overrides WidgetBaseInterface::getWidgetState | |||
| WidgetBase::getWidgetStateParents | protected static | function | Returns the location of processing information within $form_state. | |||
| WidgetBase::handlesMultipleValues | protected | function | Returns whether the widget handles multiple values. | |||
| WidgetBase::isApplicable | public static | function | Overrides WidgetInterface::isApplicable | 4 | ||
| WidgetBase::isDefaultValueWidget | protected | function | Returns whether the widget used for default value form. | |||
| WidgetBase::settingsForm | public | function | Overrides WidgetInterface::settingsForm | 16 | ||
| WidgetBase::settingsSummary | public | function | Overrides WidgetInterface::settingsSummary | 15 | ||
| WidgetBase::setWidgetState | public static | function | Overrides WidgetBaseInterface::setWidgetState | |||
| WidgetBase::__construct | public | function | Constructs a WidgetBase object. | Overrides PluginBase::__construct | 5 |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.