class DateRangeDefaultWidget

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

Plugin implementation of the 'daterange_default' widget.

Plugin annotation


@FieldWidget(
  id = "daterange_default",
  label = @Translation("Date and time range"),
  field_types = {
    "daterange"
  }
)

Hierarchy

Expanded class hierarchy of DateRangeDefaultWidget

File

core/modules/datetime_range/src/Plugin/Field/FieldWidget/DateRangeDefaultWidget.php, line 23

Namespace

Drupal\datetime_range\Plugin\Field\FieldWidget
View source
class DateRangeDefaultWidget extends DateRangeWidgetBase {
    
    /**
     * The date format storage.
     *
     * @var \Drupal\Core\Entity\EntityStorageInterface
     */
    protected $dateStorage;
    
    /**
     * {@inheritdoc}
     */
    public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, array $third_party_settings, EntityStorageInterface $date_storage) {
        parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $third_party_settings);
        $this->dateStorage = $date_storage;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
        return new static($plugin_id, $plugin_definition, $configuration['field_definition'], $configuration['settings'], $configuration['third_party_settings'], $container->get('entity_type.manager')
            ->getStorage('date_format'));
    }
    
    /**
     * {@inheritdoc}
     */
    public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {
        $element = parent::formElement($items, $delta, $element, $form, $form_state);
        // Identify the type of date and time elements to use.
        switch ($this->getFieldSetting('datetime_type')) {
            case DateRangeItem::DATETIME_TYPE_DATE:
            case DateRangeItem::DATETIME_TYPE_ALLDAY:
                $date_type = 'date';
                $time_type = 'none';
                $date_format = $this->dateStorage
                    ->load('html_date')
                    ->getPattern();
                $time_format = '';
                break;
            default:
                $date_type = 'date';
                $time_type = 'time';
                $date_format = $this->dateStorage
                    ->load('html_date')
                    ->getPattern();
                $time_format = $this->dateStorage
                    ->load('html_time')
                    ->getPattern();
                break;
        }
        $element['value'] += [
            '#date_date_format' => $date_format,
            '#date_date_element' => $date_type,
            '#date_date_callbacks' => [],
            '#date_time_format' => $time_format,
            '#date_time_element' => $time_type,
            '#date_time_callbacks' => [],
        ];
        $element['end_value'] += [
            '#date_date_format' => $date_format,
            '#date_date_element' => $date_type,
            '#date_date_callbacks' => [],
            '#date_time_format' => $time_format,
            '#date_time_element' => $time_type,
            '#date_time_callbacks' => [],
        ];
        return $element;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
DateRangeDefaultWidget::$dateStorage protected property The date format storage.
DateRangeDefaultWidget::create public static function Creates an instance of the plugin. Overrides WidgetBase::create
DateRangeDefaultWidget::formElement public function Returns the form for a single field widget. Overrides DateRangeWidgetBase::formElement
DateRangeDefaultWidget::__construct public function Constructs a WidgetBase object. Overrides WidgetBase::__construct
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::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 "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::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

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