public function DateTimeTimeAgoFormatter::settingsSummary in Zircon Profile 8

Same name and namespace in other branches

1. 8.0 core/modules/datetime/src/Plugin/Field/FieldFormatter/DateTimeTimeAgoFormatter.php \Drupal\datetime\Plugin\Field\FieldFormatter\DateTimeTimeAgoFormatter::settingsSummary()

Returns a short summary for the current formatter settings.

If an empty result is returned, a UI can still be provided to display a settings form in case the formatter has configurable settings.

Return value

string[] A short summary of the formatter settings.

Overrides FormatterBase::settingsSummary

File

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

Contains \Drupal\datetime\Plugin\Field\FieldFormatter\DateTimeTimeAgoFormatter.

Class

DateTimeTimeAgoFormatter

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

Namespace

Drupal\datetime\Plugin\Field\FieldFormatter

Code

public function settingsSummary() {
  $summary = parent::settingsSummary();
  $future_date = new DrupalDateTime('1 year 1 month 1 week 1 day 1 hour 1 minute');
  $past_date = new DrupalDateTime('-1 year -1 month -1 week -1 day -1 hour -1 minute');
  $summary[] = t('Future date: %display', array(
    '%display' => $this
      ->formatDate($future_date),
  ));
  $summary[] = t('Past date: %display', array(
    '%display' => $this
      ->formatDate($past_date),
  ));
  return $summary;
}