DateRangeCustomFormatter.php

Same filename in other branches
  1. 8.9.x core/modules/datetime_range/src/Plugin/Field/FieldFormatter/DateRangeCustomFormatter.php
  2. 10 core/modules/datetime_range/src/Plugin/Field/FieldFormatter/DateRangeCustomFormatter.php
  3. 11.x core/modules/datetime_range/src/Plugin/Field/FieldFormatter/DateRangeCustomFormatter.php

Namespace

Drupal\datetime_range\Plugin\Field\FieldFormatter

File

core/modules/datetime_range/src/Plugin/Field/FieldFormatter/DateRangeCustomFormatter.php

View source
<?php

namespace Drupal\datetime_range\Plugin\Field\FieldFormatter;

use Drupal\Core\Field\FieldItemListInterface;
use Drupal\Core\Form\FormStateInterface;
use Drupal\datetime\Plugin\Field\FieldFormatter\DateTimeCustomFormatter;
use Drupal\datetime_range\DateTimeRangeTrait;

/**
 * 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.
 *
 * @FieldFormatter(
 *   id = "daterange_custom",
 *   label = @Translation("Custom"),
 *   field_types = {
 *     "daterange"
 *   }
 * )
 */
class DateRangeCustomFormatter extends DateTimeCustomFormatter {
    use DateTimeRangeTrait;
    
    /**
     * {@inheritdoc}
     */
    public static function defaultSettings() {
        return [
            'separator' => '-',
        ] + parent::defaultSettings();
    }
    
    /**
     * {@inheritdoc}
     */
    public function viewElements(FieldItemListInterface $items, $langcode) {
        // @todo Evaluate removing this method in
        // https://www.drupal.org/node/2793143 to determine if the behavior and
        // markup in the base class implementation can be used instead.
        $elements = [];
        $separator = $this->getSetting('separator');
        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;
                if ($start_date->getTimestamp() !== $end_date->getTimestamp()) {
                    $elements[$delta] = [
                        'start_date' => $this->buildDate($start_date),
                        'separator' => [
                            '#plain_text' => ' ' . $separator . ' ',
                        ],
                        'end_date' => $this->buildDate($end_date),
                    ];
                }
                else {
                    $elements[$delta] = $this->buildDate($start_date);
                }
            }
        }
        return $elements;
    }
    
    /**
     * {@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;
    }

}

Classes

Title Deprecated Summary
DateRangeCustomFormatter Plugin implementation of the 'Custom' formatter for 'daterange' fields.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.