class DateRangeWidgetBase

Same name in other branches
  1. 8.9.x core/modules/datetime_range/src/Plugin/Field/FieldWidget/DateRangeWidgetBase.php \Drupal\datetime_range\Plugin\Field\FieldWidget\DateRangeWidgetBase
  2. 10 core/modules/datetime_range/src/Plugin/Field/FieldWidget/DateRangeWidgetBase.php \Drupal\datetime_range\Plugin\Field\FieldWidget\DateRangeWidgetBase
  3. 11.x core/modules/datetime_range/src/Plugin/Field/FieldWidget/DateRangeWidgetBase.php \Drupal\datetime_range\Plugin\Field\FieldWidget\DateRangeWidgetBase

Base class for the 'daterange_*' widgets.

Hierarchy

Expanded class hierarchy of DateRangeWidgetBase

File

core/modules/datetime_range/src/Plugin/Field/FieldWidget/DateRangeWidgetBase.php, line 15

Namespace

Drupal\datetime_range\Plugin\Field\FieldWidget
View source
class DateRangeWidgetBase extends DateTimeWidgetBase {
    
    /**
     * {@inheritdoc}
     */
    public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {
        $element = parent::formElement($items, $delta, $element, $form, $form_state);
        // Wrap all of the select elements with a fieldset.
        $element['#theme_wrappers'][] = 'fieldset';
        $element['#element_validate'][] = [
            $this,
            'validateStartEnd',
        ];
        $element['value']['#title'] = $this->t('Start date');
        $element['end_value'] = [
            '#title' => $this->t('End date'),
        ] + $element['value'];
        if ($items[$delta]->start_date) {
            
            /** @var \Drupal\Core\Datetime\DrupalDateTime $start_date */
            $start_date = $items[$delta]->start_date;
            $element['value']['#default_value'] = $this->createDefaultValue($start_date, $element['value']['#date_timezone']);
        }
        if ($items[$delta]->end_date) {
            
            /** @var \Drupal\Core\Datetime\DrupalDateTime $end_date */
            $end_date = $items[$delta]->end_date;
            $element['end_value']['#default_value'] = $this->createDefaultValue($end_date, $element['end_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 === DateRangeItem::DATETIME_TYPE_DATE) {
            $storage_format = DateTimeItemInterface::DATE_STORAGE_FORMAT;
        }
        else {
            $storage_format = DateTimeItemInterface::DATETIME_STORAGE_FORMAT;
        }
        $storage_timezone = new \DateTimeZone(DateTimeItemInterface::STORAGE_TIMEZONE);
        $user_timezone = new \DateTimeZone(date_default_timezone_get());
        foreach ($values as &$item) {
            if (!empty($item['value']) && $item['value'] instanceof DrupalDateTime) {
                
                /** @var \Drupal\Core\Datetime\DrupalDateTime $start_date */
                $start_date = $item['value'];
                if ($datetime_type === DateRangeItem::DATETIME_TYPE_ALLDAY) {
                    // All day fields start at midnight on the starting date, but are
                    // stored like datetime fields, so we need to adjust the time.
                    // This function is called twice, so to prevent a double conversion
                    // we need to explicitly set the timezone.
                    $start_date->setTimeZone($user_timezone)
                        ->setTime(0, 0, 0);
                }
                // Adjust the date for storage.
                $item['value'] = $start_date->setTimezone($storage_timezone)
                    ->format($storage_format);
            }
            if (!empty($item['end_value']) && $item['end_value'] instanceof DrupalDateTime) {
                
                /** @var \Drupal\Core\Datetime\DrupalDateTime $end_date */
                $end_date = $item['end_value'];
                if ($datetime_type === DateRangeItem::DATETIME_TYPE_ALLDAY) {
                    // All day fields start at midnight on the starting date, but are
                    // stored like datetime fields, so we need to adjust the time.
                    // This function is called twice, so to prevent a double conversion
                    // we need to explicitly set the timezone.
                    $end_date->setTimeZone($user_timezone)
                        ->setTime(23, 59, 59);
                }
                // Adjust the date for storage.
                $item['end_value'] = $end_date->setTimezone($storage_timezone)
                    ->format($storage_format);
            }
        }
        return $values;
    }
    
    /**
     * #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_date = $element['value']['#value']['object'];
        $end_date = $element['end_value']['#value']['object'];
        if ($start_date instanceof DrupalDateTime && $end_date instanceof DrupalDateTime) {
            if ($start_date->getTimestamp() !== $end_date->getTimestamp()) {
                $interval = $start_date->diff($end_date);
                if ($interval->invert === 1) {
                    $form_state->setError($element, $this->t('The @title end date cannot be before the start date', [
                        '@title' => $element['#title'],
                    ]));
                }
            }
        }
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
DateRangeWidgetBase::formElement public function Returns the form for a single field widget. Overrides DateTimeWidgetBase::formElement 2
DateRangeWidgetBase::massageFormValues public function Massages the form values into the format expected for field values. Overrides DateTimeWidgetBase::massageFormValues
DateRangeWidgetBase::validateStartEnd public function #element_validate callback to ensure that the start date &lt;= the end date.
DateTimeWidgetBase::createDefaultValue protected function Creates a date object for use as a default value.
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 43
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 &quot;Add another item&quot; button.
WidgetBase::addMoreSubmit public static function Submission handler for the &quot;Add another item&quot; 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::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.