You are here

Home » API reference » Opigno calendar 3.x » TimeRangeFormatter.php

class TimeRangeFormatter in Opigno calendar 3.x

Same name and namespace in other branches
  1. 8 src/Plugin/Field/FieldFormatter/TimeRangeFormatter.php \Drupal\opigno_calendar\Plugin\Field\FieldFormatter\TimeRangeFormatter

Time range with optional date formatter.

If the range spans multiple days the full datetime format, including the date part, is used otherwise only times are rendered.

Plugin annotation


@FieldFormatter(
  id = "opigno_calendar_time_range",
  label = @Translation("Time range with optional date"),
  field_types = {
    "daterange"
  }
)

Hierarchy

Expanded class hierarchy of TimeRangeFormatter

File

src/Plugin/Field/FieldFormatter/TimeRangeFormatter.php, line 23

Namespace

Drupal\opigno_calendar\Plugin\Field\FieldFormatter
View source 
class TimeRangeFormatter extends DateRangeCustomFormatter {

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'time_separator' => '\\T',
    ] + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $elements = [];
    $separator = $this
      ->getSetting('separator');
    $split_format = $this
      ->getSplitFormat();
    foreach ($items as $delta => $item) {
      if (!empty($item->start_date) && !empty($item->end_date)) {

        /** @var \Drupal\Core\Datetime\DrupalDateTime $start_date */
        $start_date = $item->start_date;

        /** @var \Drupal\Core\Datetime\DrupalDateTime $end_date */
        $end_date = $item->end_date;
        $formatted_start_date = $this->dateFormatter
          ->format($start_date
          ->getTimestamp(), 'custom', $split_format['date']);
        $formatted_end_date = $this->dateFormatter
          ->format($end_date
          ->getTimestamp(), 'custom', $split_format['date']);
        if ($formatted_start_date !== $formatted_end_date) {
          $elements[$delta] = [
            'start_date' => $this
              ->buildDate($start_date),
            'separator' => [
              '#plain_text' => ' ' . $separator . ' ',
            ],
            'end_date' => $this
              ->buildDate($end_date),
          ];
        }
        else {
          $date_format = $this
            ->getSetting('date_format');
          $this
            ->setSetting('date_format', $split_format['time']);
          $elements[$delta] = [
            'start_date' => $this
              ->buildDate($start_date),
            'separator' => [
              '#plain_text' => ' ' . $separator . ' ',
            ],
            'end_date' => $this
              ->buildDate($end_date),
          ];
          $this
            ->setSetting('date_format', $date_format);
        }
      }
    }
    return $elements;
  }

  /**
   * Splits the datetime format into the date and time components.
   *
   * @return array
   *   An associative array of date formats keyed by "date" or "time" keys.
   */
  protected function getSplitFormat() {
    $parts = explode($this
      ->getSetting('time_separator'), $this
      ->getSetting('date_format'), 2);
    return [
      'date' => $parts[0],
      'time' => $parts[1],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $form = parent::settingsForm($form, $form_state);
    $form['time_separator'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Time separator'),
      '#description' => $this
        ->t('The string separating the date and time parts of the provided format'),
      '#default_value' => $this
        ->getSetting('time_separator'),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = parent::settingsSummary();
    $separator = $this
      ->getSetting('time_separator');
    if ($separator) {
      $summary[] = $this
        ->t('Time separator: %separator', [
        '%separator' => $separator,
      ]);
    }
    return $summary;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DateTimeCustomFormatter::formatDate protected function Creates a formatted date value as a string. Overrides DateTimeFormatterBase::formatDate
DateTimeFormatterBase::$dateFormatStorage protected property The date format entity storage.
DateTimeFormatterBase::$dateFormatter protected property The date formatter service.
DateTimeFormatterBase::buildDate protected function Creates a render array from a date object.
DateTimeFormatterBase::buildDateWithIsoAttribute protected function Creates a render array from a date object with ISO date attribute.
DateTimeFormatterBase::create public static function Creates an instance of the plugin. Overrides FormatterBase::create
DateTimeFormatterBase::getFormatSettings protected function Gets a settings array suitable for DrupalDateTime::format().
DateTimeFormatterBase::setTimeZone protected function Sets the proper time zone on a DrupalDateTime object for the current user.
DateTimeFormatterBase::__construct public function Constructs a new DateTimeDefaultFormatter. Overrides FormatterBase::__construct
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
FormatterBase::$fieldDefinition protected property The field definition.
FormatterBase::$label protected property The label display setting.
FormatterBase::$settings protected property The formatter settings. Overrides PluginSettingsBase::$settings
FormatterBase::$viewMode protected property The view mode.
FormatterBase::getFieldSetting protected function Returns the value of a field setting.
FormatterBase::getFieldSettings protected function Returns the array of field settings.
FormatterBase::isApplicable public static function Returns if the formatter can be used for the provided field. Overrides FormatterInterface::isApplicable 14
FormatterBase::prepareView public function Allows formatters to load information for field values being displayed. Overrides FormatterInterface::prepareView 2
FormatterBase::view public function Builds a renderable array for a fully themed field. Overrides FormatterInterface::view 1
MessengerTrait::$messenger protected property The messenger. 27
MessengerTrait::messenger public function Gets the messenger. 27
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 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::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.
TimeRangeFormatter::defaultSettings public static function Defines the default settings for this plugin. Overrides DateRangeCustomFormatter::defaultSettings
TimeRangeFormatter::getSplitFormat protected function Splits the datetime format into the date and time components.
TimeRangeFormatter::settingsForm public function Returns a form to configure settings for the formatter. Overrides DateRangeCustomFormatter::settingsForm
TimeRangeFormatter::settingsSummary public function Returns a short summary for the current formatter settings. Overrides DateRangeCustomFormatter::settingsSummary
TimeRangeFormatter::viewElements public function Builds a renderable array for a field value. Overrides DateRangeCustomFormatter::viewElements