class SingleDateTime in Single DateTimePicker 8

Provides a SingleDateTime form element.

Plugin annotation

@FormElement("single_date_time");

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\Core\Render\Element\RenderElement implements ElementInterface
    class \Drupal\Core\Render\Element\FormElement implements FormElementInterface
    class \Drupal\single_datetime\Element\SingleDateTime

Expanded class hierarchy of SingleDateTime

3 #type uses of SingleDateTime

SingleDateTimeRangeWidget::formElement in modules/single_datetime_range/src/Plugin/Field/FieldWidget/SingleDateTimeRangeWidget.php: Returns the form for a single field widget.
SingleDateTimeTimestampWidget::formElement in src/Plugin/Field/FieldWidget/SingleDateTimeTimestampWidget.php: Returns the form for a single field widget.
SingleDateTimeWidget::formElement in src/Plugin/Field/FieldWidget/SingleDateTimeWidget.php: Returns the form for a single field widget.

File

src/Element/SingleDateTime.php, line 15

Namespace

Drupal\single_datetime\Element

View source

class SingleDateTime extends FormElement {

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    $class = get_class($this);
    return [
      '#input' => TRUE,
      '#multiple' => FALSE,
      '#maxlength' => 512,
      '#process' => [
        [
          $class,
          'processSingleDateTime',
        ],
      ],
      '#pre_render' => [
        [
          $class,
          'preRenderSingleDateTime',
        ],
      ],
      '#size' => 25,
      '#theme_wrappers' => [
        'form_element',
      ],
      '#theme' => 'input__textfield',
    ];
  }

  /**
   * Render element for input.html.twig.
   *
   * @param array $element
   *   An associative array containing the properties of the element.
   *   Properties used: #title, #value, #description, #size, #maxlength,
   *   #placeholder, #required, #attributes.
   *
   * @return array
   *   The $element with prepared variables ready for input.html.twig.
   */
  public static function preRenderSingleDateTime(array $element) {
    $element['#attributes']['type'] = 'text';
    Element::setAttributes($element, [
      'id',
      'name',
      'value',
      'size',
    ]);
    static::setAttributes($element, [
      'form-date',
    ]);
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public static function processSingleDateTime(&$element, FormStateInterface $form_state, &$complete_form) {

    // Get system regional settings.
    $first_day = \Drupal::config('system.date')
      ->get('first_day');

    // Get disabled days.
    $disabled_days = [];

    // Get active days.
    foreach ($element['#disable_days'] as $value) {
      if (!empty($value)) {

        // Exception for Sunday - should be 0 (on widget options need to be 7).
        $disabled_days[] = (int) $value < 7 ? (int) $value : 0;
      }
    }

    // Get excluded dates.
    $exclude_date = [];
    if (!empty($element['#exclude_date'])) {
      $exclude_date = explode("\n", $element['#exclude_date']);
    }

    // Default, build array for all hours.
    $allowed_hours = range(0, 23);

    // If we have specifics, use that list.
    if (!empty($element['#allowed_hours'])) {
      $allowed_hours = explode(',', $element['#allowed_hours']);
    }

    // Default settings.
    $settings = [
      'data-hour-format' => $element['#hour_format'],
      'data-allow-seconds' => !empty($element['#allow_seconds']) ? 1 : 0,
      'data-allow-times' => (int) $element['#allow_times'],
      'data-allowed-hours' => Json::encode($allowed_hours),
      'data-first-day' => $first_day,
      'data-disable-days' => Json::encode($disabled_days),
      'data-exclude-date' => $exclude_date,
      'data-inline' => !empty($element['#inline']) ? 1 : 0,
      'data-mask' => !empty($element['#mask']) ? 1 : 0,
      'data-datetimepicker-theme' => $element['#datetimepicker_theme'],
      'data-custom-format' => $element['#custom_format'] ?? NULL,
    ];

    // Year start.
    if (!empty($element['#year_start'])) {
      $settings['data-year-start'] = $element['#year_start'];
    }

    // Year end.
    if (!empty($element['#year_end'])) {
      $settings['data-year-end'] = $element['#year_end'];
    }

    // Start date.
    if (strlen($element['#start_date'])) {
      $settings['data-start-date'] = $element['#start_date'];
    }

    // Min/Max date settings.
    if (strlen($element['#min_date'])) {
      $settings['data-min-date'] = $element['#min_date'];
    }
    if (strlen($element['#max_date'])) {
      $settings['data-max-date'] = $element['#max_date'];
    }

    // Allow blank.
    if (!empty($element['#allow_blank'])) {
      $settings['data-allow-blank'] = $element['#allow_blank'];
    }

    // Push field type to JS for changing between date only and time fields.
    // Difference between date and date range fields.
    if (isset($element['#date_type'])) {
      $settings['data-single-date-time'] = $element['#date_type'];
    }
    else {

      // Combine date range formats.
      $range_date_type = $element['#date_date_element'] . $element['#date_time_element'];
      $settings['data-single-date-time'] = $range_date_type;
    }

    // Append our attributes to element.
    $element['#attributes'] += $settings;

    // Disable Chrome autofill on widget.
    $element['#attributes']['autocomplete'] = 'off';

    // Prevent keyboard on mobile devices, but only if allowBlank is false
    // otherwise a user won't be able to delete a date.
    if (!$element['#allow_blank']) {
      $element['#attributes']['onfocus'] = 'blur();';
    }

    // Attach library.
    $element['#attached']['library'][] = 'single_datetime/datetimepicker';
    return $element;
  }

  /**
   * Return default settings. Pass in values to override defaults.
   *
   * @param array $values
   *   Some Desc.
   *
   * @return array
   *   Some Desc.
   */
  public static function settings(array $values = []) {
    $settings = [
      'lang' => 'en',
    ];
    return array_merge($settings, $values);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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
FormElement::processAutocomplete	public static	function	Adds autocomplete functionality to elements.
FormElement::processPattern	public static	function	#process callback for #pattern form element property.
FormElement::validatePattern	public static	function	#element_validate callback for #pattern form element property.
FormElement::valueCallback	public static	function	Determines how user input is mapped to an element's #value property. Overrides FormElementInterface::valueCallback	15
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.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	92
RenderElement::preRenderAjaxForm	public static	function	Adds Ajax information about an element to communicate with JavaScript.
RenderElement::preRenderGroup	public static	function	Adds members of this group as actual elements for rendering.
RenderElement::processAjaxForm	public static	function	Form element processing handler for the #ajax form property.	1
RenderElement::processGroup	public static	function	Arranges elements into groups.
RenderElement::setAttributes	public static	function	Sets a form element's class attribute. Overrides ElementInterface::setAttributes
SingleDateTime::getInfo	public	function	Returns the element properties for this element. Overrides ElementInterface::getInfo
SingleDateTime::preRenderSingleDateTime	public static	function	Render element for input.html.twig.
SingleDateTime::processSingleDateTime	public static	function
SingleDateTime::settings	public static	function	Return default settings. Pass in values to override defaults.
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.

You are here

class SingleDateTime in Single DateTimePicker 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation