www.aleph1.co.uk Git - yaffs-website/blob - web/core/modules/datetime_range/src/Plugin/Field/FieldFormatter/DateRangePlainFormatter.php

   1 <?php
   2
   3 namespace Drupal\datetime_range\Plugin\Field\FieldFormatter;
   4
   5 use Drupal\Core\Field\FieldItemListInterface;
   6 use Drupal\Core\Form\FormStateInterface;
   7 use Drupal\datetime\Plugin\Field\FieldFormatter\DateTimePlainFormatter;
   8 use Drupal\datetime_range\DateTimeRangeTrait;
   9
  10 /**
  11  * Plugin implementation of the 'Plain' formatter for 'daterange' fields.
  12  *
  13  * This formatter renders the data range as a plain text string, with a
  14  * configurable separator using an ISO-like date format string.
  15  *
  16  * @FieldFormatter(
  17  *   id = "daterange_plain",
  18  *   label = @Translation("Plain"),
  19  *   field_types = {
  20  *     "daterange"
  21  *   }
  22  * )
  23  */
  24 class DateRangePlainFormatter extends DateTimePlainFormatter {
  25
  26   use DateTimeRangeTrait;
  27
  28   /**
  29    * {@inheritdoc}
  30    */
  31   public static function defaultSettings() {
  32     return [
  33       'separator' => '-',
  34     ] + parent::defaultSettings();
  35   }
  36
  37   /**
  38    * {@inheritdoc}
  39    */
  40   public function viewElements(FieldItemListInterface $items, $langcode) {
  41     $elements = [];
  42     $separator = $this->getSetting('separator');
  43
  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;
  50
  51         if ($start_date->getTimestamp() !== $end_date->getTimestamp()) {
  52           $elements[$delta] = [
  53             'start_date' => $this->buildDate($start_date),
  54             'separator' => ['#plain_text' => ' ' . $separator . ' '],
  55             'end_date' => $this->buildDate($end_date),
  56           ];
  57         }
  58         else {
  59           $elements[$delta] = $this->buildDate($start_date);
  60
  61           if (!empty($item->_attributes)) {
  62             $elements[$delta]['#attributes'] += $item->_attributes;
  63             // Unset field item attributes since they have been included in the
  64             // formatter output and should not be rendered in the field template.
  65             unset($item->_attributes);
  66           }
  67         }
  68       }
  69     }
  70
  71     return $elements;
  72   }
  73
  74   /**
  75    * {@inheritdoc}
  76    */
  77   public function settingsForm(array $form, FormStateInterface $form_state) {
  78     $form = parent::settingsForm($form, $form_state);
  79
  80     $form['separator'] = [
  81       '#type' => 'textfield',
  82       '#title' => $this->t('Date separator'),
  83       '#description' => $this->t('The string to separate the start and end dates'),
  84       '#default_value' => $this->getSetting('separator'),
  85     ];
  86
  87     return $form;
  88   }
  89
  90   /**
  91    * {@inheritdoc}
  92    */
  93   public function settingsSummary() {
  94     $summary = parent::settingsSummary();
  95
  96     if ($separator = $this->getSetting('separator')) {
  97       $summary[] = $this->t('Separator: %separator', ['%separator' => $separator]);
  98     }
  99
 100     return $summary;
 101   }
 102
 103 }