class DateRangeDatelistWidget

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

Plugin implementation of the 'daterange_datelist' widget.

Hierarchy

Expanded class hierarchy of DateRangeDatelistWidget

File

core/modules/datetime_range/src/Plugin/Field/FieldWidget/DateRangeDatelistWidget.php, line 14

Namespace

Drupal\datetime_range\Plugin\Field\FieldWidget
View source
class DateRangeDatelistWidget extends DateRangeWidgetBase {
    
    /**
     * {@inheritdoc}
     */
    public static function defaultSettings() {
        return [
            'increment' => '15',
            'date_order' => 'YMD',
            'time_type' => '24',
        ] + parent::defaultSettings();
    }
    
    /**
     * {@inheritdoc}
     */
    public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {
        $element = parent::formElement($items, $delta, $element, $form, $form_state);
        $date_order = $this->getSetting('date_order');
        if ($this->getFieldSetting('datetime_type') == DateRangeItem::DATETIME_TYPE_DATETIME) {
            $time_type = $this->getSetting('time_type');
            $increment = $this->getSetting('increment');
        }
        else {
            $time_type = '';
            $increment = '';
        }
        // Set up the date part order array.
        switch ($date_order) {
            default:
            case 'YMD':
                $date_part_order = [
                    'year',
                    'month',
                    'day',
                ];
                break;
            case 'MDY':
                $date_part_order = [
                    'month',
                    'day',
                    'year',
                ];
                break;
            case 'DMY':
                $date_part_order = [
                    'day',
                    'month',
                    'year',
                ];
                break;
        }
        switch ($time_type) {
            case '24':
                $date_part_order = array_merge($date_part_order, [
                    'hour',
                    'minute',
                ]);
                break;
            case '12':
                $date_part_order = array_merge($date_part_order, [
                    'hour',
                    'minute',
                    'ampm',
                ]);
                break;
            case 'none':
                break;
        }
        $element['value'] = [
            '#type' => 'datelist',
            '#date_increment' => $increment,
            '#date_part_order' => $date_part_order,
        ] + $element['value'];
        $element['end_value'] = [
            '#type' => 'datelist',
            '#date_increment' => $increment,
            '#date_part_order' => $date_part_order,
        ] + $element['end_value'];
        return $element;
    }
    
    /**
     * {@inheritdoc}
     */
    public function settingsForm(array $form, FormStateInterface $form_state) {
        $element = parent::settingsForm($form, $form_state);
        $element['date_order'] = [
            '#type' => 'select',
            '#title' => $this->t('Date part order'),
            '#default_value' => $this->getSetting('date_order'),
            '#options' => [
                'MDY' => $this->t('Month/Day/Year'),
                'DMY' => $this->t('Day/Month/Year'),
                'YMD' => $this->t('Year/Month/Day'),
            ],
        ];
        if ($this->getFieldSetting('datetime_type') == DateRangeItem::DATETIME_TYPE_DATETIME) {
            $element['time_type'] = [
                '#type' => 'select',
                '#title' => $this->t('Time type'),
                '#default_value' => $this->getSetting('time_type'),
                '#options' => [
                    '24' => $this->t('24 hour time'),
                    '12' => $this->t('12 hour time'),
                ],
            ];
            $element['increment'] = [
                '#type' => 'select',
                '#title' => $this->t('Time increments'),
                '#default_value' => $this->getSetting('increment'),
                '#options' => [
                    1 => $this->t('1 minute'),
                    5 => $this->t('@count minutes', [
                        '@count' => 5,
                    ]),
                    10 => $this->t('@count minutes', [
                        '@count' => 10,
                    ]),
                    15 => $this->t('@count minutes', [
                        '@count' => 15,
                    ]),
                    30 => $this->t('@count minutes', [
                        '@count' => 30,
                    ]),
                ],
            ];
        }
        else {
            $element['time_type'] = [
                '#type' => 'hidden',
                '#value' => 'none',
            ];
            $element['increment'] = [
                '#type' => 'hidden',
                '#value' => $this->getSetting('increment'),
            ];
        }
        return $element;
    }
    
    /**
     * {@inheritdoc}
     */
    public function settingsSummary() {
        $summary = [];
        $summary[] = $this->t('Date part order: @order', [
            '@order' => $this->getSetting('date_order'),
        ]);
        if ($this->getFieldSetting('datetime_type') == DateRangeItem::DATETIME_TYPE_DATETIME) {
            $summary[] = $this->t('Time type: @time_type', [
                '@time_type' => $this->getSetting('time_type'),
            ]);
            $summary[] = $this->t('Time increments: @increment', [
                '@increment' => $this->getSetting('increment'),
            ]);
        }
        return $summary;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
DateRangeDatelistWidget::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
DateRangeDatelistWidget::formElement public function Returns the form for a single field widget. Overrides DateRangeWidgetBase::formElement
DateRangeDatelistWidget::settingsForm public function Returns a form to configure settings for the widget. Overrides WidgetBase::settingsForm
DateRangeDatelistWidget::settingsSummary public function Returns a short summary for the current widget settings. Overrides WidgetBase::settingsSummary
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 <= 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::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::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.