class DateRangeDefaultFormatter

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

This formatter renders the data range using <time> elements, with configurable date formats (from the list of configured formats) and a separator.

Plugin annotation

@FieldFormatter(
  id = "daterange_default",
  label = @Translation("Default"),
  field_types = {
    "daterange"
  }
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
    • class \Drupal\Core\Field\PluginSettingsBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Field\PluginSettingsInterface, \Drupal\Component\Plugin\DependentPluginInterface
      • class \Drupal\Core\Field\FormatterBase extends \Drupal\Core\Field\PluginSettingsBase implements \Drupal\Core\Field\FormatterInterface, \Drupal\Core\Plugin\ContainerFactoryPluginInterface
        • class \Drupal\datetime\Plugin\Field\FieldFormatter\DateTimeFormatterBase extends \Drupal\Core\Field\FormatterBase implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface
          • class \Drupal\datetime\Plugin\Field\FieldFormatter\DateTimeDefaultFormatter extends \Drupal\datetime\Plugin\Field\FieldFormatter\DateTimeFormatterBase
            • class \Drupal\datetime_range\Plugin\Field\FieldFormatter\DateRangeDefaultFormatter extends \Drupal\datetime\Plugin\Field\FieldFormatter\DateTimeDefaultFormatter uses \Drupal\datetime_range\DateTimeRangeTrait

Expanded class hierarchy of DateRangeDefaultFormatter

File

core/modules/datetime_range/src/Plugin/Field/FieldFormatter/DateRangeDefaultFormatter.php, line 24

Namespace

class DateRangeDefaultFormatter extends DateTimeDefaultFormatter {
    use DateTimeRangeTrait;
    
    /**
     * {@inheritdoc}
     */
    public static function defaultSettings() {
        return [
            'separator' => '-',
        ] + parent::defaultSettings();
    }
    
    /**
     * {@inheritdoc}
     */
    public function settingsForm(array $form, FormStateInterface $form_state) {
        $form = parent::settingsForm($form, $form_state);
        $form['separator'] = [
            '#type' => 'textfield',
            '#title' => $this->t('Date separator'),
            '#description' => $this->t('The string to separate the start and end dates'),
            '#default_value' => $this->getSetting('separator'),
        ];
        return $form;
    }
    
    /**
     * {@inheritdoc}
     */
    public function settingsSummary() {
        $summary = parent::settingsSummary();
        if ($separator = $this->getSetting('separator')) {
            $summary[] = $this->t('Separator: %separator', [
                '%separator' => $separator,
            ]);
        }
        return $summary;
    }

}

Members