class DateTimeWidgetBase

Same name in other branches
  1. 9 core/modules/datetime/src/Plugin/Field/FieldWidget/DateTimeWidgetBase.php \Drupal\datetime\Plugin\Field\FieldWidget\DateTimeWidgetBase
  2. 8.9.x core/modules/datetime/src/Plugin/Field/FieldWidget/DateTimeWidgetBase.php \Drupal\datetime\Plugin\Field\FieldWidget\DateTimeWidgetBase
  3. 11.x core/modules/datetime/src/Plugin/Field/FieldWidget/DateTimeWidgetBase.php \Drupal\datetime\Plugin\Field\FieldWidget\DateTimeWidgetBase

Base class for the 'datetime_*' widgets.

Hierarchy

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\FieldWidget
View 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 Modifiers Object type Summary Overriden Title Overrides
DateTimeWidgetBase::createDefaultValue protected function Creates a date object for use as a default value.
DateTimeWidgetBase::formElement public function Returns the form for a single field widget. Overrides WidgetInterface::formElement 3
DateTimeWidgetBase::massageFormValues public function Massages the form values into the format expected for field values. Overrides WidgetBase::massageFormValues 1
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
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 Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies 6
PluginSettingsBase::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsInterface::defaultSettings 42
PluginSettingsBase::getSetting public function Returns the value of a setting, or its default value if absent. Overrides PluginSettingsInterface::getSetting
PluginSettingsBase::getSettings public function Returns the array of settings, including defaults for missing settings. Overrides PluginSettingsInterface::getSettings
PluginSettingsBase::getThirdPartyProviders public function Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
PluginSettingsBase::getThirdPartySetting public function Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
PluginSettingsBase::getThirdPartySettings public function Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
PluginSettingsBase::mergeDefaults protected function Merges default settings values into $settings.
PluginSettingsBase::onDependencyRemoval public function Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsInterface::onDependencyRemoval 3
PluginSettingsBase::setSetting public function Sets the value of a setting for the plugin. Overrides PluginSettingsInterface::setSetting
PluginSettingsBase::setSettings public function Sets the settings for the plugin. Overrides PluginSettingsInterface::setSettings
PluginSettingsBase::setThirdPartySetting public function Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
PluginSettingsBase::unsetThirdPartySetting public function Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
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 Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::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 Assigns a field-level validation error to the right widget sub-element. Overrides WidgetInterface::errorElement 8
WidgetBase::extractFormValues public function Extracts field values from submitted form values. Overrides WidgetBaseInterface::extractFormValues 3
WidgetBase::flagErrors public function Reports field-level validation errors against actual form elements. Overrides WidgetBaseInterface::flagErrors 2
WidgetBase::form public function Creates a form element for a field. 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 Retrieves processing information about the widget from $form_state. 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 Returns if the widget can be used for the provided field. Overrides WidgetInterface::isApplicable 4
WidgetBase::isDefaultValueWidget protected function Returns whether the widget used for default value form.
WidgetBase::settingsForm public function Returns a form to configure settings for the widget. Overrides WidgetInterface::settingsForm 16
WidgetBase::settingsSummary public function Returns a short summary for the current widget settings. Overrides WidgetInterface::settingsSummary 15
WidgetBase::setWidgetState public static function Stores processing information about the widget in $form_state. Overrides WidgetBaseInterface::setWidgetState
WidgetBase::__construct public function Constructs a WidgetBase object. 5

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