class 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

• class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
    • class \Drupal\Core\Field\PluginSettingsBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Field\PluginSettingsInterface, \Drupal\Component\Plugin\DependentPluginInterface
      • class \Drupal\Core\Field\FormatterBase extends \Drupal\Core\Field\PluginSettingsBase implements \Drupal\Core\Field\FormatterInterface, \Drupal\Core\Plugin\ContainerFactoryPluginInterface
        • class \Drupal\Core\Field\Plugin\Field\FieldFormatter\TimestampAgoFormatter extends \Drupal\Core\Field\FormatterBase
          • class \Drupal\datetime\Plugin\Field\FieldFormatter\DateTimeTimeAgoFormatter extends \Drupal\Core\Field\Plugin\Field\FieldFormatter\TimestampAgoFormatter

Expanded class hierarchy of DateTimeTimeAgoFormatter

File

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

Namespace

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());
    }

}

Members