You are here

protected function DateTimeTimeAgoListFormatter::getDescription in Formatter Suite 8

Returns a brief description of the formatter.

Return value

string Returns a brief translated description of the formatter.

Overrides EntityListTrait::getDescription

File

src/Plugin/Field/FieldFormatter/DateTimeTimeAgoListFormatter.php, line 37

Class

DateTimeTimeAgoListFormatter
Formats multiple time ago date strings as a list.

Namespace

Drupal\formatter_suite\Plugin\Field\FieldFormatter

Code

protected function getDescription() {
  return $this
    ->t("Format multi-value date & time fields as a list. Values are used to calculate a time period between the current date and the field's date. The time period is labeled as in the future or the past and presented with a selected granularity.");
}