class DateTimePlainFormatter

Same name and namespace in other branches
  1. 11.x core/modules/datetime/src/Plugin/Field/FieldFormatter/DateTimePlainFormatter.php \Drupal\datetime\Plugin\Field\FieldFormatter\DateTimePlainFormatter

Plugin implementation of the 'Plain' formatter for 'datetime' fields.

Plugin annotation


@FieldFormatter(
  id = "datetime_plain",
  label = @Translation("Plain"),
  field_types = {
    "datetime"
  }
)

Hierarchy

Expanded class hierarchy of DateTimePlainFormatter

1 file declares its use of DateTimePlainFormatter
DateRangePlainFormatter.php in core/modules/datetime_range/src/Plugin/Field/FieldFormatter/DateRangePlainFormatter.php

File

core/modules/datetime/src/Plugin/Field/FieldFormatter/DateTimePlainFormatter.php, line 20

Namespace

Drupal\datetime\Plugin\Field\FieldFormatter
View source
class DateTimePlainFormatter extends DateTimeFormatterBase {
  
  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $elements = [];
    foreach ($items as $delta => $item) {
      if (!empty($item->date)) {
        /** @var \Drupal\Core\Datetime\DrupalDateTime $date */
        $date = $item->date;
        $elements[$delta] = $this->buildDate($date);
      }
    }
    return $elements;
  }
  
  /**
   * {@inheritdoc}
   */
  protected function formatDate($date) {
    $format = $this->getFieldSetting('datetime_type') == DateTimeItem::DATETIME_TYPE_DATE ? DateTimeItemInterface::DATE_STORAGE_FORMAT : DateTimeItemInterface::DATETIME_STORAGE_FORMAT;
    $timezone = $this->getSetting('timezone_override') ?: $date->getTimezone()
      ->getName();
    return $this->dateFormatter
      ->format($date->getTimestamp(), 'custom', $format, $timezone != '' ? $timezone : NULL);
  }

}

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