3 namespace Drupal\datetime_range\Plugin\Field\FieldFormatter;
5 use Drupal\Core\Field\FieldItemListInterface;
6 use Drupal\Core\Form\FormStateInterface;
7 use Drupal\datetime\Plugin\Field\FieldFormatter\DateTimeCustomFormatter;
8 use Drupal\datetime_range\DateTimeRangeTrait;
11 * Plugin implementation of the 'Custom' formatter for 'daterange' fields.
13 * This formatter renders the data range as plain text, with a fully
14 * configurable date format using the PHP date syntax and separator.
17 * id = "daterange_custom",
18 * label = @Translation("Custom"),
24 class DateRangeCustomFormatter extends DateTimeCustomFormatter {
26 use DateTimeRangeTrait;
31 public static function defaultSettings() {
34 ] + parent::defaultSettings();
40 public function viewElements(FieldItemListInterface $items, $langcode) {
42 $separator = $this->getSetting('separator');
44 foreach ($items as $delta => $item) {
45 if (!empty($item->start_date) && !empty($item->end_date)) {
46 /** @var \Drupal\Core\Datetime\DrupalDateTime $start_date */
47 $start_date = $item->start_date;
48 /** @var \Drupal\Core\Datetime\DrupalDateTime $end_date */
49 $end_date = $item->end_date;
51 if ($start_date->getTimestamp() !== $end_date->getTimestamp()) {
53 'start_date' => $this->buildDate($start_date),
54 'separator' => ['#plain_text' => ' ' . $separator . ' '],
55 'end_date' => $this->buildDate($end_date),
59 $elements[$delta] = $this->buildDate($start_date);
70 public function settingsForm(array $form, FormStateInterface $form_state) {
71 $form = parent::settingsForm($form, $form_state);
73 $form['separator'] = [
74 '#type' => 'textfield',
75 '#title' => $this->t('Date separator'),
76 '#description' => $this->t('The string to separate the start and end dates'),
77 '#default_value' => $this->getSetting('separator'),
86 public function settingsSummary() {
87 $summary = parent::settingsSummary();
89 if ($separator = $this->getSetting('separator')) {
90 $summary[] = $this->t('Separator: %separator', ['%separator' => $separator]);