You are here

Home » API reference » Date range formatter 9.0.x » DateRangeFormatterRangeFormatter.php

class DateRangeFormatterRangeFormatter in Date range formatter 9.0.x

Same name and namespace in other branches
  1. 8.3 src/Plugin/Field/FieldFormatter/DateRangeFormatterRangeFormatter.php \Drupal\date_range_formatter\Plugin\Field\FieldFormatter\DateRangeFormatterRangeFormatter

Plugin implementation of the 'Custom' formatter for 'daterange' fields.

This formatter renders the data range as plain text, with a fully configurable date format using the PHP date syntax and separator.

Plugin annotation


@FieldFormatter(
  id = "date_range_without_time",
  label = @Translation("Date range (without time)"),
  field_types = {
    "daterange"
  }
)

Hierarchy

Expanded class hierarchy of DateRangeFormatterRangeFormatter

File

src/Plugin/Field/FieldFormatter/DateRangeFormatterRangeFormatter.php, line 24

Namespace

Drupal\date_range_formatter\Plugin\Field\FieldFormatter
View source 
class DateRangeFormatterRangeFormatter extends DateTimeCustomFormatter {
  use DateTimeRangeTrait;

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'separator' => '-',
      'single' => 'd F Y',
      'single_all_day' => 'd F Y',
      'one_day' => 'd F Y',
      'one_month' => 'd - {d} F Y',
      'several_months' => 'd F - {d} {F} Y',
      'several_years' => 'd F Y - {d} {F} {Y}',
    ] + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $elements = [];
    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
          ->getTimestamp();

        /** @var \Drupal\Core\Datetime\DrupalDateTime $end_date */
        $end_date = $item->end_date
          ->getTimestamp();
        if ($start_date !== $end_date) {
          $format = $this
            ->getSetting('several_years');
          if (date('Y', $start_date) === date('Y', $end_date)) {
            $format = $this
              ->getSetting('several_months');
          }
          if (date('m.Y', $start_date) === date('m.Y', $end_date)) {
            $format = $this
              ->getSetting('one_month');
          }
          if (date('d.m.Y', $start_date) === date('d.m.Y', $end_date)) {
            $format = $this
              ->getSetting('one_day');
          }
          $date_str = \Drupal::service('date.formatter')
            ->format($start_date, 'custom', preg_replace('/\\{([a-zA-Z])\\}/', '{\\\\$1}', t($format)));
          $matches = array();
          if (preg_match_all('/\\{([a-zA-Z])\\}/', $date_str, $matches)) {
            foreach ($matches[1] as $match) {
              $date_str = preg_replace('/\\{' . $match . '\\}/', \Drupal::service('date.formatter')
                ->format($end_date, 'custom', $match), $date_str);
            }
          }
          $elements[$delta] = [
            '#markup' => '<span class="date-display-range">' . $date_str . '</span>',
          ];
        }
        else {
          $elements[$delta] = [
            '#markup' => \Drupal::service('date.formatter')
              ->format($start_date, 'custom', t($this
              ->getSetting('one_day'))),
          ];
        }
      }
    }
    return $elements;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $form = parent::settingsForm($form, $form_state);
    unset($form['date_format']);
    $form['single'] = [
      '#type' => 'textfield',
      '#title' => t('Date format for single date'),
      '#default_value' => $this
        ->getSetting('single') ?: 'd F Y',
    ];
    $form['single_all_day'] = [
      '#type' => 'textfield',
      '#title' => t('Date format for the single date if the date is "all day"'),
      '#default_value' => $this
        ->getSetting('single_all_day') ?: 'd F Y',
    ];
    $form['one_day'] = [
      '#type' => 'textfield',
      '#title' => t('Date format for the single day date range'),
      '#default_value' => $this
        ->getSetting('one_day') ?: 'd F Y',
    ];
    $form['one_month'] = [
      '#type' => 'textfield',
      '#title' => t('Date format for the single month date range'),
      '#default_value' => $this
        ->getSetting('one_month') ?: 'd - {d} F Y',
    ];
    $form['several_months'] = [
      '#type' => 'textfield',
      '#title' => t('Date format for the single year date range'),
      '#default_value' => $this
        ->getSetting('several_months') ?: 'd F - {d} {F} Y',
    ];
    $form['several_years'] = [
      '#type' => 'textfield',
      '#title' => t('Date format for multiple years date range'),
      '#default_value' => $this
        ->getSetting('several_years') ?: 'd F Y - {d} {F} {Y}',
    ];
    $form['help'] = [
      '#type' => 'markup',
      '#markup' => t('A user-defined date format. See the <a href="@url">PHP manual</a> for available options.', [
        '@url' => 'http://php.net/manual/function.date.php',
      ]) . '<br />' . t('Use letters in braces for end date elements, for example, {d} means the day of the end date.') . '<br />' . t('These format values are translated, for example, t("d F Y") instead of "d F Y" will be used as the actual date format.'),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = parent::settingsSummary();
    $summary[] = $this
      ->t('Display date range using formats: @single, @single_all_day, @one_day, @one_month, @several_months, @several_years', array(
      '@single' => $this
        ->getSetting('single') ?: 'd F Y',
      '@single_all_day' => $this
        ->getSetting('single_all_day') ?: 'd F Y',
      '@one_day' => $this
        ->getSetting('one_day') ?: 'd F Y',
      '@one_month' => $this
        ->getSetting('one_month') ?: 'd - {d} F Y',
      '@several_months' => $this
        ->getSetting('several_months') ?: 'd F - {d} {F} Y',
      '@several_years' => $this
        ->getSetting('several_years') ?: 'd F Y - {d} {F} {Y}',
    ));
    return $summary;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DateRangeFormatterRangeFormatter::defaultSettings public static function Defines the default settings for this plugin. Overrides DateTimeCustomFormatter::defaultSettings
DateRangeFormatterRangeFormatter::settingsForm public function Returns a form to configure settings for the formatter. Overrides DateTimeCustomFormatter::settingsForm
DateRangeFormatterRangeFormatter::settingsSummary public function Returns a short summary for the current formatter settings. Overrides DateTimeCustomFormatter::settingsSummary
DateRangeFormatterRangeFormatter::viewElements public function Builds a renderable array for a field value. Overrides DateTimeRangeTrait::viewElements
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.