class OpignoDateRangeWidget in Opigno calendar 3.x

Same name and namespace in other branches

8 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

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\Core\Field\PluginSettingsBase implements DependentPluginInterface, PluginSettingsInterface
    class \Drupal\Core\Field\WidgetBase implements WidgetInterface, ContainerFactoryPluginInterface
    class \Drupal\datetime\Plugin\Field\FieldWidget\DateTimeWidgetBase
    class \Drupal\datetime_range\Plugin\Field\FieldWidget\DateRangeWidgetBase
    class \Drupal\datetime_range\Plugin\Field\FieldWidget\DateRangeDefaultWidget
    class \Drupal\opigno_calendar\Plugin\Field\FieldWidget\OpignoDateRangeWidget

Expanded class hierarchy of OpignoDateRangeWidget

File

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

Namespace

Drupal\opigno_calendar\Plugin\Field\FieldWidget

View source

class OpignoDateRangeWidget extends DateRangeDefaultWidget {

  /**
   * {@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) {
    $element = parent::formElement($items, $delta, $element, $form, $form_state);
    $element['end_value'] = [
      '#title' => $this
        ->t('End date'),
    ] + $element['value'];
    if ($items[$delta]->value) {

      /** @var \Drupal\Core\Datetime\DrupalDateTime $start_date */
      $start_date = $items[$delta]->value;
      $start_date = new DrupalDateTime($start_date);
      $element['value']['#default_value'] = $this
        ->createDefaultValue($start_date, $element['value']['#date_timezone']);
    }
    if ($items[$delta]->end_value) {

      /** @var \Drupal\Core\Datetime\DrupalDateTime $end_date */
      $end_date = $items[$delta]->end_value;
      $end_date = new DrupalDateTime($end_date);
      $element['end_value']['#default_value'] = $this
        ->createDefaultValue($end_date, $element['end_value']['#date_timezone']);
    }
    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

Name	Modifiers	Type	Description	Overrides
DateRangeDefaultWidget::$dateStorage	protected	property	The date format storage.
DateRangeDefaultWidget::create	public static	function	Creates an instance of the plugin. Overrides WidgetBase::create
DateRangeDefaultWidget::__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
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
MessengerTrait::$messenger	protected	property	The messenger.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
MessengerTrait::setMessenger	public	function	Sets the messenger.
OpignoDateRangeWidget::createDateTimeFromWrapper	public static	function	Creates datetime from components.
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 DateRangeDefaultWidget::formElement
OpignoDateRangeWidget::getDatePattern	public	function
OpignoDateRangeWidget::massageFormValues	public	function	Massages the form values into the format expected for field values. Overrides DateRangeWidgetBase::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	2
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.	4
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::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

You are here

class OpignoDateRangeWidget in Opigno calendar 3.x

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation