Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x

DateTimeTimeAgoFormatter.php

Namespace

Drupal\datetime\Plugin\Field\FieldFormatter

File

core/modules/datetime/src/Plugin/Field/FieldFormatter/DateTimeTimeAgoFormatter.php

View source
<?php

namespace Drupal\datetime\Plugin\Field\FieldFormatter;

use Drupal\Core\Datetime\DrupalDateTime;
use Drupal\Core\Field\Attribute\FieldFormatter;
use Drupal\Core\Field\FieldItemListInterface;
use Drupal\Core\Field\Plugin\Field\FieldFormatter\TimestampAgoFormatter;
use Drupal\Core\StringTranslation\TranslatableMarkup;

/**
 * Plugin implementation of the 'Time ago' formatter for 'datetime' fields.
 */
class DateTimeTimeAgoFormatter extends TimestampAgoFormatter {
    
    /**
     * {@inheritdoc}
     */
    public function viewElements(FieldItemListInterface $items, $langcode) {
        $elements = [];
        foreach ($items as $delta => $item) {
            $date = $item->date;
            $output = [];
            if (!empty($item->date)) {
                $output = $this->formatDate($date);
            }
            $elements[$delta] = $output;
        }
        return $elements;
    }
    
    /**
     * Formats a date/time as a time interval.
     *
     * @param \Drupal\Core\Datetime\DrupalDateTime|object $date
     *   A date/time object.
     *
     * @return array
     *   The formatted date/time string using the past or future format setting.
     */
    protected function formatDate(DrupalDateTime $date) {
        return parent::formatTimestamp($date->getTimestamp());
    }

}

Classes

Title Deprecated Summary
DateTimeTimeAgoFormatter Plugin implementation of the 'Time ago' formatter for 'datetime' fields.

API Navigation

  • Drupal Core 11.1.x
  • Topics
  • Classes
  • Functions
  • Constants
  • Globals
  • Files
  • Namespaces
  • Deprecated
  • Services
RSS feed
Powered by Drupal