You are here

Home » API reference » Single DateTimePicker 8 » SingleDateTimeBase.php

abstract class SingleDateTimeBase in Single DateTimePicker 8

Base class for SingleDateTime widget types.

Hierarchy

Expanded class hierarchy of SingleDateTimeBase

1 file declares its use of SingleDateTimeBase
SingleDateTimeRangeWidget.php in modules/single_datetime_range/src/Plugin/Field/FieldWidget/SingleDateTimeRangeWidget.php

File

src/Plugin/Field/FieldWidget/SingleDateTimeBase.php, line 17

Namespace

Drupal\single_datetime\Plugin\Field\FieldWidget
View source 
abstract class SingleDateTimeBase extends DateTimeWidgetBase {

  /**
   * 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 static function defaultSettings() {
    return [
      'hour_format' => '24h',
      'allow_seconds' => FALSE,
      'allow_times' => '15',
      'allowed_hours' => '',
      'disable_days' => [],
      'exclude_date' => '',
      'inline' => FALSE,
      'mask' => FALSE,
      'datetimepicker_theme' => 'default',
      'start_date' => '',
      'min_date' => '',
      'max_date' => '',
      'year_start' => '',
      'year_end' => '',
      'allow_blank' => FALSE,
    ];
  }

  /**
   * {@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_seconds'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Seconds default 00'),
      '#description' => $this
        ->t('Select if you want to set the seconds default 00.'),
      '#default_value' => $this
        ->getSetting('allow_seconds'),
      '#required' => FALSE,
    ];
    $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['allowed_hours'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Allowed hours'),
      '#description' => $this
        ->t('Specify allowed hours on time picker. Leave empty for no restrictions. Enter hours in following format of number, etc: 8,9,10,11,12,13,14,15,16,17. Separate by comma. This is used in combination with minutes granularity.'),
      '#default_value' => $this
        ->getSetting('allowed_hours'),
      '#required' => FALSE,
    ];
    $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 d.m.Y etc. 31.12.2018. Each date in new line. 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,
    ];
    $elements['inline'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Render inline'),
      '#description' => $this
        ->t('Select if you want to render the widget inline.'),
      '#default_value' => $this
        ->getSetting('inline'),
      '#required' => FALSE,
    ];
    $elements['mask'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Use mask'),
      '#description' => $this
        ->t('Use mask for input. Example __.__.____'),
      '#default_value' => $this
        ->getSetting('mask'),
      '#required' => FALSE,
    ];
    $elements['datetimepicker_theme'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Theme'),
      '#description' => $this
        ->t('Setting a color scheme. Now only supported default and dark theme'),
      '#options' => [
        'default' => $this
          ->t('Default'),
        'dark' => $this
          ->t('Dark'),
      ],
      '#default_value' => $this
        ->getSetting('datetimepicker_theme'),
      '#required' => FALSE,
    ];
    $elements['start_date'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Start date'),
      '#description' => $this
        ->t('Initial date to display when the input has no value and the picker is opened', [
        ':external' => 'https://xdsoft.net/jqplugins/datetimepicker/',
      ]),
      '#default_value' => $this
        ->getSetting('start_date'),
      '#required' => FALSE,
    ];
    $elements['min_date'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Set a limit to the minimum date/time allowed to pick.'),
      '#description' => $this
        ->t('Examples: \'0\' for now, \'+1970/01/02\' for tomorrow, \'12:00\' for time, \'13:45:34\',formatTime:\'H:i:s\'. <a href=":external">More info</a>', [
        ':external' => 'https://xdsoft.net/jqplugins/datetimepicker/',
      ]),
      '#default_value' => $this
        ->getSetting('min_date'),
      '#required' => FALSE,
    ];
    $elements['max_date'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Set a limit to the maximum date/time allowed to pick.'),
      '#description' => $this
        ->t('Examples: \'0\' for now, \'+1970/01/02\' for tomorrow, \'12:00\' for time, \'13:45:34\',formatTime:\'H:i:s\'. <a href=":external">More info</a>.', [
        ':external' => 'https://xdsoft.net/jqplugins/datetimepicker/',
      ]),
      '#default_value' => $this
        ->getSetting('max_date'),
      '#required' => FALSE,
    ];
    $elements['year_start'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Start year'),
      '#description' => $this
        ->t('Start value for fast Year selector - used only for selector'),
      '#default_value' => $this
        ->getSetting('year_start'),
      '#required' => FALSE,
    ];
    $elements['year_end'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('End year'),
      '#description' => $this
        ->t('End value for fast Year selector - used only for selector'),
      '#default_value' => $this
        ->getSetting('year_end'),
      '#required' => FALSE,
    ];
    $elements['allow_blank'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Allow blank'),
      '#description' => $this
        ->t('Allow deleting the value to unset a date.'),
      '#default_value' => $this
        ->getSetting('allow_blank'),
      '#required' => FALSE,
    ];
    return $elements;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = [];
    $summary[] = $this
      ->t('Hours Format: @hour_format', [
      '@hour_format' => $this
        ->getSetting('hour_format'),
    ]);
    $summary[] = $this
      ->t('Set Seconds default 00: @allow_seconds', [
      '@allow_seconds' => !empty($this
        ->getSetting('allow_seconds')) ? $this
        ->t('Yes') : $this
        ->t('No'),
    ]);
    $summary[] = $this
      ->t('Minutes Granularity: @allow_times', [
      '@allow_times' => $this
        ->getSetting('allow_times'),
    ]);
    $summary[] = $this
      ->t('Allowed hours: @allowed_hours', [
      '@allowed_hours' => !empty($this
        ->getSetting('allowed_hours')) ? $this
        ->getSetting('allowed_hours') : $this
        ->t('All hours are allowed'),
    ]);
    $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 $value) {
      if (!empty($value)) {
        $disabled_days[] = $options[$value];
      }
    }
    $disabled_days = implode(',', $disabled_days);
    $start_date = $this
      ->getSetting('start_date');
    $min_date = $this
      ->getSetting('min_date');
    $max_date = $this
      ->getSetting('max_date');
    $year_start = $this
      ->getSetting('year_start');
    $year_end = $this
      ->getSetting('year_end');
    $summary[] = $this
      ->t('Disabled days: @disabled_days', [
      '@disabled_days' => !empty($disabled_days) ? $disabled_days : $this
        ->t('None'),
    ]);
    $summary[] = $this
      ->t('Disabled dates: @disabled_dates', [
      '@disabled_dates' => !empty($this
        ->getSetting('exclude_date')) ? $this
        ->getSetting('exclude_date') : $this
        ->t('None'),
    ]);
    $summary[] = $this
      ->t('Display inline widget: @render_widget', [
      '@render_widget' => !empty($this
        ->getSetting('inline')) ? $this
        ->t('Yes') : $this
        ->t('No'),
    ]);
    $summary[] = $this
      ->t('Use mask: @mask', [
      '@mask' => !empty($this
        ->getSetting('mask')) ? $this
        ->t('Yes') : $this
        ->t('No'),
    ]);
    $summary[] = $this
      ->t('Theme: @theme', [
      '@theme' => ucfirst($this
        ->getSetting('datetimepicker_theme')),
    ]);
    $summary[] = $this
      ->t('Start date: @start_date', [
      '@start_date' => !empty($start_date) ? $start_date : $this
        ->t('Today'),
    ]);
    $summary[] = $this
      ->t('Minimum date/time: @min_date', [
      '@min_date' => !empty($min_date) ? $min_date : $this
        ->t('None'),
    ]);
    $summary[] = $this
      ->t('Maximum date/time: @max_date', [
      '@max_date' => !empty($max_date) ? $max_date : $this
        ->t('None'),
    ]);
    $summary[] = $this
      ->t('Start year: @year_start', [
      '@year_start' => !empty($year_start) ? $year_start : $this
        ->t('None'),
    ]);
    $summary[] = $this
      ->t('End year: @year_end', [
      '@year_end' => !empty($year_end) ? $year_end : $this
        ->t('None'),
    ]);
    $summary[] = $this
      ->t('Allow blank: @allow_blank', [
      '@allow_blank' => !empty($this
        ->getSetting('allow_blank')) ? $this
        ->t('Yes') : $this
        ->t('No'),
    ]);
    return $summary;
  }

  /**
   * {@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.
    foreach ($values as &$item) {
      if (!empty($item['value']) && !preg_match('/____|__-__/m', $item['value'])) {

        // Date value is now string not instance of DrupalDateTime (without T).
        // String needs to be converted to DrupalDateTime.
        $start_date = new DrupalDateTime($item['value']);
        $datetime_type = $this
          ->getFieldSetting('datetime_type');
        if ($datetime_type === DateTimeItem::DATETIME_TYPE_DATE) {

          // If this is a date-only field, set it to the default time so the
          // timezone conversion can be reversed.
          $start_date
            ->setDefaultDateTime();
          $format = DateTimeItemInterface::DATE_STORAGE_FORMAT;
        }
        else {
          $format = DateTimeItemInterface::DATETIME_STORAGE_FORMAT;
        }

        // Adjust the date for storage.
        $start_date
          ->setTimezone(new \DateTimezone(DateTimeItemInterface::STORAGE_TIMEZONE));
        $item['value'] = $start_date
          ->format($format);
      }
    }
    return $values;
  }

  /**
   * Creates a date string 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 object $date
   *   The UTC default date.
   * @param string $timezone
   *   The timezone to apply.
   * @param string $format
   *   Date format to apply.
   *
   * @return string
   *   String for use as a default value in a field widget.
   */
  public function formatDefaultValue($date, $timezone, $format) {

    // 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.
      $date
        ->setDefaultDateTime();
    }
    $date
      ->setTimezone(new \DateTimeZone($timezone));

    // Format date.
    return $date
      ->format($format);
  }

  /**
   * Return array of field settings.
   *
   * @return array
   *   Formatted array of all available settings.
   */
  public function getCommonElementSettings() {
    return [
      '#hour_format' => $this
        ->getSetting('hour_format'),
      '#allow_seconds' => $this
        ->getSetting('allow_seconds'),
      '#allow_times' => $this
        ->getSetting('allow_times'),
      '#allowed_hours' => $this
        ->getSetting('allowed_hours'),
      '#disable_days' => $this
        ->getSetting('disable_days'),
      '#exclude_date' => $this
        ->getSetting('exclude_date'),
      '#inline' => $this
        ->getSetting('inline'),
      '#mask' => $this
        ->getSetting('mask'),
      '#datetimepicker_theme' => $this
        ->getSetting('datetimepicker_theme'),
      '#start_date' => $this
        ->getSetting('start_date'),
      '#min_date' => $this
        ->getSetting('min_date'),
      '#max_date' => $this
        ->getSetting('max_date'),
      '#year_start' => $this
        ->getSetting('year_start'),
      '#year_end' => $this
        ->getSetting('year_end'),
      '#allow_blank' => $this
        ->getSetting('allow_blank'),
    ];
  }

}

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.
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
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
SingleDateTimeBase::$dateStorage protected property The date format storage.
SingleDateTimeBase::create public static function Creates an instance of the plugin. Overrides WidgetBase::create
SingleDateTimeBase::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
SingleDateTimeBase::formatDefaultValue public function Creates a date string for use as a default value.
SingleDateTimeBase::getCommonElementSettings public function Return array of field settings.
SingleDateTimeBase::massageFormValues public function Massages the form values into the format expected for field values. Overrides DateTimeWidgetBase::massageFormValues 2
SingleDateTimeBase::settingsForm public function Returns a form to configure settings for the widget. Overrides WidgetBase::settingsForm
SingleDateTimeBase::settingsSummary public function Returns a short summary for the current widget settings. Overrides WidgetBase::settingsSummary
SingleDateTimeBase::__construct public function Constructs a WidgetBase object. Overrides WidgetBase::__construct
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