You are here

Home » API reference » Bootstrap DateTime Picker 8 » BootstrapDateRangeWidget.php

class BootstrapDateRangeWidget in Bootstrap DateTime Picker 8

Plugin implementation of the BootstrapDateTimeWidget widget.

Plugin annotation


@FieldWidget(
  id = "bootstrap_date_range_widget",
  label = @Translation("Bootstrap DateRange Picker"),
  field_types = {
    "daterange"
  }
)

Hierarchy

Expanded class hierarchy of BootstrapDateRangeWidget

File

src/Plugin/Field/FieldWidget/BootstrapDateRangeWidget.php, line 27

Namespace

Drupal\bootstrap_datetime\Plugin\Field\FieldWidget
View source 
class BootstrapDateRangeWidget extends DateRangeWidgetBase implements ContainerFactoryPluginInterface {

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'hour_format' => '24h',
      'allow_times' => '15',
      'disable_days' => [],
      'exclude_date' => '',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $elements = [];
    $elements['hour_format'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Hours Format'),
      '#description' => $this
        ->t('Select the hours format'),
      '#options' => [
        '12h' => $this
          ->t('12 Hours'),
        '24h' => $this
          ->t('24 Hours'),
      ],
      '#default_value' => $this
        ->getSetting('hour_format'),
      '#required' => TRUE,
    ];
    $elements['allow_times'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Minutes granularity'),
      '#description' => $this
        ->t('Select granularity for minutes in calendar'),
      '#options' => [
        '5' => $this
          ->t('5 minutes'),
        '10' => $this
          ->t('10 minutes'),
        '15' => $this
          ->t('15 minutes'),
        '30' => $this
          ->t('30 minutes'),
        '60' => $this
          ->t('60 minutes'),
      ],
      '#default_value' => $this
        ->getSetting('allow_times'),
      '#required' => TRUE,
    ];
    $elements['disable_days'] = [
      '#type' => 'checkboxes',
      '#title' => $this
        ->t('Disable specific days in week'),
      '#description' => $this
        ->t('Select days which are disabled in calendar, etc. weekends or just Friday'),
      '#options' => [
        '1' => $this
          ->t('Monday'),
        '2' => $this
          ->t('Tuesday'),
        '3' => $this
          ->t('Wednesday'),
        '4' => $this
          ->t('Thursday'),
        '5' => $this
          ->t('Friday'),
        '6' => $this
          ->t('Saturday'),
        '7' => $this
          ->t('Sunday'),
      ],
      '#default_value' => $this
        ->getSetting('disable_days'),
      '#required' => FALSE,
    ];
    $elements['exclude_date'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('Disable specific dates from calendar'),
      '#description' => $this
        ->t('Enter days in following format MM/DD/YY e.g. 03/07/2018. Separate multiple dates with comma. This is used for specific dates, if you want to disable all weekends use settings above, not this field.'),
      '#default_value' => $this
        ->getSetting('exclude_date'),
      '#required' => FALSE,
    ];
    return $elements;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = [];
    $summary[] = t('Hours Format: @hour_format', [
      '@hour_format' => $this
        ->getSetting('hour_format'),
    ]);
    $summary[] = t('Minutes Granularity: @allow_times', [
      '@allow_times' => $this
        ->getSetting('allow_times'),
    ]);
    $options = [
      '1' => $this
        ->t('Monday'),
      '2' => $this
        ->t('Tuesday'),
      '3' => $this
        ->t('Wednesday'),
      '4' => $this
        ->t('Thursday'),
      '5' => $this
        ->t('Friday'),
      '6' => $this
        ->t('Saturday'),
      '7' => $this
        ->t('Sunday'),
    ];
    $disabled_days = [];
    foreach ($this
      ->getSetting('disable_days') as $key => $value) {
      if (!empty($value)) {
        $disabled_days[] = $options[$value];
      }
    }
    $disabled_days = implode(',', $disabled_days);
    $summary[] = t('Disabled days: @disabled_days', [
      '@disabled_days' => !empty($disabled_days) ? $disabled_days : t('None'),
    ]);
    $summary[] = t('Disabled dates: @disabled_dates', [
      '@disabled_dates' => !empty($this
        ->getSetting('exclude_date')) ? $this
        ->getSetting('exclude_date') : t('None'),
    ]);
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function massageFormValues(array $values, array $form, FormStateInterface $form_state) {
    foreach ($values as &$item) {
      if (!empty($item['value'])) {

        // Date value is now string not instance of DrupalDateTime (without T).
        $start_date = new DrupalDateTime($item['value']);
        switch ($this
          ->getFieldSetting('datetime_type')) {
          case DateRangeItem::DATETIME_TYPE_DATE:

            // If this is a date-only field, set it to the default time so the
            // timezone conversion can be reversed.
            datetime_date_default_time($start_date);
            $format = DATETIME_DATE_STORAGE_FORMAT;
            break;
          default:
            $format = DATETIME_DATETIME_STORAGE_FORMAT;
            break;
        }

        // Adjust the date for storage.
        $start_date
          ->setTimezone(new \DateTimezone(DATETIME_STORAGE_TIMEZONE));
        $item['value'] = $start_date
          ->format($format);
      }
      if (!empty($item['end_value'])) {

        // Date value is now string not instance of DrupalDateTime (without T).
        $end_date = new DrupalDateTime($item['end_value']);
        switch ($this
          ->getFieldSetting('datetime_type')) {
          case DateRangeItem::DATETIME_TYPE_DATE:

            // If this is a date-only field, set it to the default time so the
            // timezone conversion can be reversed.
            datetime_date_default_time($end_date);
            $format = DATETIME_DATE_STORAGE_FORMAT;
            break;
          default:
            $format = DATETIME_DATETIME_STORAGE_FORMAT;
            break;
        }

        // Adjust the date for storage.
        $end_date
          ->setTimezone(new \DateTimezone(DATETIME_STORAGE_TIMEZONE));
        $item['end_value'] = $end_date
          ->format($format);
      }
    }
    return $values;
  }

  /**
   * 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.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);

    // Field type.
    $element['value'] = [
      '#title' => $this
        ->t('Start date'),
      '#type' => 'bootstrap_date_time',
      '#date_timezone' => drupal_get_user_timezone(),
      '#default_value' => NULL,
      '#date_type' => NULL,
      '#required' => $element['#required'],
    ];
    $element['end_value'] = [
      '#title' => $this
        ->t('End date'),
      '#type' => 'bootstrap_date_time',
      '#date_timezone' => drupal_get_user_timezone(),
      '#default_value' => NULL,
      '#date_type' => NULL,
      '#required' => $element['#required'],
    ] + $element['value'];

    // Identify the type of date and time elements to use.
    switch ($this
      ->getFieldSetting('datetime_type')) {
      case DateRangeItem::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'] = DATETIME_STORAGE_TIMEZONE;
        $element['end_value']['#date_timezone'] = DATETIME_STORAGE_TIMEZONE;

        // If field is date only, use default time format.
        $format = DATETIME_DATE_STORAGE_FORMAT;

        // Type of the field.
        $element['value']['#date_type'] = $this
          ->getFieldSetting('datetime_type');
        $element['end_value']['#date_type'] = $this
          ->getFieldSetting('datetime_type');
        break;
      default:

        // Type of the field.
        $element['value']['#date_type'] = $this
          ->getFieldSetting('datetime_type');
        $element['end_value']['#date_type'] = $this
          ->getFieldSetting('datetime_type');

        // Assign the time format, because time will be saved in 24hrs format
        // in database.
        $format = $this
          ->getSetting('hour_format') == '12h' ? 'Y-m-d h:i:s A' : 'Y-m-d H:i:s';
        break;
    }
    if ($items[$delta]->start_date) {
      $start_date = $items[$delta]->start_date;

      // The date was created and verified during field_load(), so it is safe to
      // use without further inspection.
      if ($this
        ->getFieldSetting('datetime_type') == DateTimeItem::DATETIME_TYPE_DATE) {

        // A date without time will pick up the current time, use the default
        // time.
        datetime_date_default_time($start_date);
      }
      $start_date
        ->setTimezone(new \DateTimeZone($element['value']['#date_timezone']));

      // Manual define form for input field.
      $element['value']['#default_value'] = $start_date
        ->format($format);
    }
    if ($items[$delta]->end_date) {
      $end_date = $items[$delta]->end_date;

      // The date was created and verified during field_load(), so it is safe to
      // use without further inspection.
      if ($this
        ->getFieldSetting('datetime_type') == DateTimeItem::DATETIME_TYPE_DATE) {

        // A date without time will pick up the current time, use the default
        // time.
        datetime_date_default_time($end_date);
      }
      $end_date
        ->setTimezone(new \DateTimeZone($element['end_value']['#date_timezone']));

      // Manual define form for input field.
      $element['end_value']['#default_value'] = $end_date
        ->format($format);
    }
    $element['value']['#hour_format'] = $this
      ->getSetting('hour_format');
    $element['value']['#allow_times'] = $this
      ->getSetting('allow_times');
    $element['value']['#disable_days'] = $this
      ->getSetting('disable_days');
    $element['value']['#exclude_date'] = $this
      ->getSetting('exclude_date');
    $element['end_value']['#hour_format'] = $this
      ->getSetting('hour_format');
    $element['end_value']['#allow_times'] = $this
      ->getSetting('allow_times');
    $element['end_value']['#disable_days'] = $this
      ->getSetting('disable_days');
    $element['end_value']['#exclude_date'] = $this
      ->getSetting('exclude_date');
    return $element;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AllowedTagsXssTrait::allowedTags public function Returns a list of tags allowed by AllowedTagsXssTrait::fieldFilterXss().
AllowedTagsXssTrait::displayAllowedTags public function Returns a human-readable list of allowed tags for display in help texts.
AllowedTagsXssTrait::fieldFilterXss public function Filters an HTML string to prevent XSS vulnerabilities.
BootstrapDateRangeWidget::$dateStorage protected property The date format storage.
BootstrapDateRangeWidget::create public static function Creates an instance of the plugin. Overrides WidgetBase::create
BootstrapDateRangeWidget::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
BootstrapDateRangeWidget::formElement public function Returns the form for a single field widget. Overrides DateRangeWidgetBase::formElement
BootstrapDateRangeWidget::massageFormValues public function Massages the form values into the format expected for field values. Overrides DateRangeWidgetBase::massageFormValues
BootstrapDateRangeWidget::settingsForm public function Returns a form to configure settings for the widget. Overrides WidgetBase::settingsForm
BootstrapDateRangeWidget::settingsSummary public function Returns a short summary for the current widget settings. Overrides WidgetBase::settingsSummary
BootstrapDateRangeWidget::__construct public function Constructs a WidgetBase object. Overrides WidgetBase::__construct
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.
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 1
DependencySerializationTrait::__wakeup public function 2
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
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 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable 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 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
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
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.
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 2
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