class DateTimeTimeAgoFormatter

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

Plugin implementation of the 'Time ago' formatter for 'datetime' fields.

Plugin annotation


@FieldFormatter(
  id = "datetime_time_ago",
  label = @Translation("Time ago"),
  field_types = {
    "datetime"
  }
)

Hierarchy

Expanded class hierarchy of DateTimeTimeAgoFormatter

File

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

Namespace

Drupal\datetime\Plugin\Field\FieldFormatter
View source
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());
  }

}

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