class BootstrapDate in Bootstrap Datepicker 8

Provides a BootstrapDate form element.

Plugin annotation

@FormElement("bootstrap_datepicker");

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\bootstrap_datepicker\Element\BootstrapDate

Expanded class hierarchy of BootstrapDate

1 #type use of BootstrapDate

BootstrapDateWidget::formElement in src/Plugin/Field/FieldWidget/BootstrapDateWidget.php: Returns the form for a single field widget.

File

src/Element/BootstrapDate.php, line 17

Namespace

Drupal\bootstrap_datepicker\Element

View source

class BootstrapDate extends FormElement {

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    $class = get_class($this);
    return [
      '#input' => TRUE,
      '#multiple' => FALSE,
      '#maxlength' => 512,
      '#process' => [
        [
          $class,
          'processBootstrapDate',
        ],
      ],
      '#pre_render' => [
        [
          $class,
          'preRenderBootstrapDate',
        ],
      ],
      '#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 preRenderBootstrapDate(array $element) {
    Element::setAttributes($element, [
      'id',
      'placeholder',
      'name',
      'value',
      'size',
      'required',
    ]);
    static::setAttributes($element, [
      'form-date',
    ]);
    return $element;
  }

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

    // Default settings.
    $default_settings = BootstrapDatepickerBase::defaultSettings();

    // Load the Bootstrap datepicker via data-provide attribute.
    $settings = [
      'data-provide' => 'datepicker',
    ];

    // Load all bootstrap-datepicker settings in data-date attributes
    // only if they differ from default settings.
    foreach ($element as $key => $value) {
      $newKey = 'data-date-' . str_replace('_', '-', str_replace('#', '', $key));
      $dsKey = str_replace('#', '', $key);
      if (array_key_exists($dsKey, $default_settings)) {
        if ($default_settings[$dsKey] != $value) {

          // Javascript library needs 'true' or 'false in data- attribute.
          if ($element[$key] === '1') {
            $element[$key] = 'true';
          }
          if ($element[$key] === '0') {
            $element[$key] = 'false';
          }
          $settings[$newKey] = Html::escape($element[$key]);
        }
      }
    }

    // Load the Bootstrap datepicker title via data-provide attribute.
    $settings['data-date-title'] = $element['#datepicker_title'] ?? NULL;

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

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

    // Attach library.
    $element['#attached']['library'][] = 'bootstrap_datepicker/datepicker';

    // Attach language library.
    $element['#attached']['library'][] = 'bootstrap_datepicker/datepicker_' . $element['#language'];

    // If a field value is set, convert Drupal default date format
    // to format from field widget settings. This could be removed after
    // https://www.drupal.org/project/drupal/issues/2936268 is fixed.
    if (!empty($element['#value'])) {
      $new_date = new DrupalDateTime($element['#value']);

      // Convert javascript date format to PHP date format.
      $pattern = [
        '/(?<!m)m(?!m)/i',
        '/mm/i',
        '/(?<!d)d(?!d)/i',
        '/dd/i',
        '/yyyy/i',
        '/yy/i',
      ];
      $replacement = [
        'n',
        'm',
        'j',
        'd',
        'o',
        'y',
      ];
      $date_format = preg_replace($pattern, $replacement, $element['#format']);
      $element['#value'] = $new_date
        ->format($date_format);
    }
    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
BootstrapDate::getInfo	public	function	Returns the element properties for this element. Overrides ElementInterface::getInfo
BootstrapDate::preRenderBootstrapDate	public static	function	Render element for input.html.twig.
BootstrapDate::processBootstrapDate	public static	function
BootstrapDate::settings	public static	function	Return default settings. Pass in values to override defaults.
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
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 BootstrapDate in Bootstrap Datepicker 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation