You are here

Home » API reference » Opigno calendar 8 » OpignoDateRangeWidget.php

class OpignoDateRangeWidget in Opigno calendar 8

Same name and namespace in other branches
  1. 3.x src/Plugin/Field/FieldWidget/OpignoDateRangeWidget.php \Drupal\opigno_calendar\Plugin\Field\FieldWidget\OpignoDateRangeWidget

Plugin implementation of the 'opigno_daterange' widget.

Plugin annotation


@FieldWidget(
  id = "opigno_daterange",
  label = @Translation("Opigno date and time range"),
  field_types = {
    "daterange"
  }
)

Hierarchy

Expanded class hierarchy of OpignoDateRangeWidget

File

src/Plugin/Field/FieldWidget/OpignoDateRangeWidget.php, line 23

Namespace

Drupal\opigno_calendar\Plugin\Field\FieldWidget
View source 
class OpignoDateRangeWidget extends WidgetBase {

  /**
   * {@inheritdoc}
   */
  public function getDatePattern() {
    return \Drupal::config('core.date_format.datepicker')
      ->get('pattern');
  }

  /**
   * Matches each symbol of PHP date format standard
   * with jQuery equivalent codeword
   */
  private function dateformatPhpToJqueryUi($php_format) {
    $symbols_matching = [
      // Day
      'd' => 'dd',
      'D' => 'D',
      'j' => 'd',
      'l' => 'DD',
      'N' => '',
      'S' => '',
      'w' => '',
      'z' => 'o',
      // Week
      'W' => '',
      // Month
      'F' => 'MM',
      'm' => 'mm',
      'M' => 'M',
      'n' => 'm',
      't' => '',
      // Year
      'L' => '',
      'o' => '',
      'Y' => 'yy',
      'y' => 'y',
      // Time
      'a' => '',
      'A' => '',
      'B' => '',
      'g' => '',
      'G' => '',
      'h' => '',
      'H' => '',
      'i' => '',
      's' => '',
      'u' => '',
    ];
    $jqueryui_format = "";
    $escaping = FALSE;
    for ($i = 0; $i < strlen($php_format); $i++) {
      $char = $php_format[$i];
      if ($char === '\\') {

        // PHP date format escaping character
        $i++;
        if ($escaping) {
          $jqueryui_format .= $php_format[$i];
        }
        else {
          $jqueryui_format .= '\'' . $php_format[$i];
        }
        $escaping = TRUE;
      }
      else {
        if ($escaping) {
          $jqueryui_format .= "'";
          $escaping = FALSE;
        }
        if (isset($symbols_matching[$char])) {
          $jqueryui_format .= $symbols_matching[$char];
        }
        else {
          $jqueryui_format .= $char;
        }
      }
    }
    return $jqueryui_format;
  }

  /**
   * {@inheritdoc}
   */
  public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {
    $raw_value = $items
      ->getValue();
    if (!empty($raw_value) && isset($raw_value[0]['value']) && isset($raw_value[0]['end_value'])) {
      $value_str = $raw_value[0]['value'];
      $end_value_str = $raw_value[0]['end_value'];
      $storage_format = $this
        ->getSetting('value_format');
      if (!isset($storage_format)) {
        $storage_format = 'Y-m-d\\TH:i:s';
      }
      $storage_timezone_str = $this
        ->getSetting('value_timezone');
      if (!isset($storage_timezone_str)) {
        $storage_timezone_str = 'UTC';
      }
      $storage_timezone = new \DateTimeZone($storage_timezone_str);
      $value = DrupalDateTime::createFromFormat($storage_format, $value_str, $storage_timezone);
      $end_value = DrupalDateTime::createFromFormat($storage_format, $end_value_str, $storage_timezone);
      $local_timezone = new \DateTimeZone(date_default_timezone_get());
      $value
        ->setTimezone($local_timezone);
      $end_value
        ->setTimezone($local_timezone);
      $value_date = $value
        ->format('m/d/Y');
      $value_hours = (int) $value
        ->format('H');
      $value_minutes = (int) $value
        ->format('i');
      $end_value_date = $end_value
        ->format('m/d/Y');
      $end_value_hours = (int) $end_value
        ->format('H');
      $end_value_minutes = (int) $end_value
        ->format('i');
    }
    else {
      $value_date = '';
      $value_hours = 0;
      $value_minutes = 0;
      $end_value_date = '';
      $end_value_hours = 0;
      $end_value_minutes = 0;
    }
    $element['value_wrapper'] = [
      '#type' => 'container',
      '#attributes' => [
        'class' => [
          'daterange-value-wrapper',
        ],
      ],
    ];
    $element['value_wrapper']['date'] = [
      '#type' => 'textfield',
      '#wrapper_attributes' => [
        'class' => [
          'daterange-date',
        ],
      ],
      '#attributes' => [
        'data-pattern' => $this
          ->dateformatPhpToJqueryUi($this
          ->getDatePattern()),
      ],
      '#size' => 11,
      '#title' => $this
        ->t('Start date'),
      '#default_value' => $value_date,
      '#required' => $element['#required'],
      '#element_validate' => [
        [
          static::class,
          'validateDate',
        ],
      ],
    ];
    $hours_options = [];
    for ($i = 0; $i < 24; ++$i) {
      $hours_options[$i] = str_pad($i, 2, '0', STR_PAD_LEFT);
    }
    $element['value_wrapper']['hours'] = [
      '#type' => 'select',
      '#wrapper_attributes' => [
        'class' => [
          'daterange-hours',
        ],
      ],
      '#options' => $hours_options,
      '#default_value' => $value_hours,
      '#required' => $element['#required'],
      '#suffix' => '<div class = "daterange-separator">:</div>',
    ];
    $minutes_options = [];
    for ($i = 0; $i < 60; ++$i) {
      $minutes_options[$i] = str_pad($i, 2, '0', STR_PAD_LEFT);
    }
    $element['value_wrapper']['minutes'] = [
      '#type' => 'select',
      '#wrapper_attributes' => [
        'class' => [
          'daterange-minutes',
        ],
      ],
      '#options' => $minutes_options,
      '#default_value' => $value_minutes,
      '#required' => $element['#required'],
      '#suffix' => '<div class = "daterange-separator">hh:mm</div>',
    ];
    $element['end_value_wrapper'] = [
      '#type' => 'container',
      '#attributes' => [
        'class' => [
          'daterange-end_value-wrapper',
        ],
      ],
    ];
    $element['end_value_wrapper']['date'] = $element['value_wrapper']['date'];
    $element['end_value_wrapper']['date']['#title'] = $this
      ->t('End date');
    $element['end_value_wrapper']['date']['#default_value'] = $end_value_date;
    $element['end_value_wrapper']['hours'] = $element['value_wrapper']['hours'];
    $element['end_value_wrapper']['hours']['#default_value'] = $end_value_hours;
    $element['end_value_wrapper']['minutes'] = $element['value_wrapper']['minutes'];
    $element['end_value_wrapper']['minutes']['#default_value'] = $end_value_minutes;
    if (isset($this->settings['value_placeholder'])) {
      $element['value_wrapper']['date']['#attributes']['placeholder'] = $this->settings['value_placeholder'];
      $element['end_value_wrapper']['date']['#attributes']['placeholder'] = $this->settings['value_placeholder'];
    }
    $element['#attached']['library'] = [
      'opigno_calendar/datetime',
    ];
    return $element;
  }

  /**
   * Creates datetime from components.
   *
   * @param array $wrapper
   *   Datetime field wrapper.
   * @param string $pattern
   *   Date pattern.
   *
   * @return \Drupal\Core\Datetime\DrupalDateTime
   *   Datetime object.
   *
   * @throws \Exception
   */
  public static function createDateTimeFromWrapper(array $wrapper, $pattern = NULL) {
    $display_format = !empty($pattern) ? "{$pattern} H:i:s" : 'm/d/Y H:i:s';
    $raw_date = $wrapper['date'];
    $raw_hours = $wrapper['hours'];
    $raw_minutes = $wrapper['minutes'];
    $date_str = "{$raw_date} 00:00:00";
    $time_str = "PT{$raw_hours}H{$raw_minutes}M";
    $date = DrupalDateTime::createFromFormat($display_format, $date_str);
    $date
      ->add(new \DateInterval($time_str));
    return $date;
  }

  /**
   * {@inheritdoc}
   */
  public function massageFormValues(array $values, array $form, FormStateInterface $form_state) {
    if (!empty($form_state
      ->getErrors())) {
      return $values;
    }
    $storage_timezone = new \DateTimeZone('UTC');
    $storage_format = 'Y-m-d\\TH:i:s';
    $pattern = $this
      ->getDatePattern();
    foreach ($values as &$item) {
      if (!empty($item['value_wrapper']['date'])) {
        $date = static::createDateTimeFromWrapper($item['value_wrapper'], $pattern);
        $item['value'] = $date
          ->setTimezone($storage_timezone)
          ->format($storage_format);
        unset($item['value_wrapper']);
      }
      if (!empty($item['end_value_wrapper']['date'])) {
        $end_date = static::createDateTimeFromWrapper($item['end_value_wrapper'], $pattern);
        $item['end_value'] = $end_date
          ->setTimezone($storage_timezone)
          ->format($storage_format);
        unset($item['end_value_wrapper']);
      }
    }
    return $values;
  }

  /**
   * Creates a date object 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 \Drupal\Core\Datetime\DrupalDateTime $date
   *   The UTC default date.
   * @param string $timezone
   *   The timezone to apply.
   *
   * @return \Drupal\Core\Datetime\DrupalDateTime
   *   A date object for use as a default value in a field widget.
   */
  protected function createDefaultValue(DrupalDateTime $date, $timezone) {

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

  /**
   * Validate the color text field.
   */
  public static function validateDate($element, FormStateInterface $form_state) {
    $value = $element['#value'];
    if (!preg_match('/^\\d{2}\\/\\d{2}\\/\\d{4}$/i', $value)) {
      $form_state
        ->setError($element, t('The date should be in the mm/dd/yyyy format.'));
    }
  }

}

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.
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.
OpignoDateRangeWidget::createDateTimeFromWrapper public static function Creates datetime from components.
OpignoDateRangeWidget::createDefaultValue protected function Creates a date object for use as a default value.
OpignoDateRangeWidget::dateformatPhpToJqueryUi private function Matches each symbol of PHP date format standard with jQuery equivalent codeword
OpignoDateRangeWidget::formElement public function Returns the form for a single field widget. Overrides WidgetInterface::formElement
OpignoDateRangeWidget::getDatePattern public function
OpignoDateRangeWidget::massageFormValues public function Massages the form values into the format expected for field values. Overrides WidgetBase::massageFormValues
OpignoDateRangeWidget::validateDate public static function Validate the color text field.
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::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsInterface::defaultSettings 42
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::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 5
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::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
WidgetBase::__construct public function Constructs a WidgetBase object. Overrides PluginBase::__construct 5