You are here

public function OfficeHoursFormatterBase::settingsSummary in Office Hours 8

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

2 calls to OfficeHoursFormatterBase::settingsSummary()
OfficeHoursFormatterDefault::settingsSummary in src/Plugin/Field/FieldFormatter/OfficeHoursFormatterDefault.php
Returns a short summary for the current formatter settings.
OfficeHoursFormatterTable::settingsSummary in src/Plugin/Field/FieldFormatter/OfficeHoursFormatterTable.php
Returns a short summary for the current formatter settings.
3 methods override OfficeHoursFormatterBase::settingsSummary()
OfficeHoursFormatterDefault::settingsSummary in src/Plugin/Field/FieldFormatter/OfficeHoursFormatterDefault.php
Returns a short summary for the current formatter settings.
OfficeHoursFormatterStatus::settingsSummary in src/Plugin/Field/FieldFormatter/OfficeHoursFormatterStatus.php
Returns a short summary for the current formatter settings.
OfficeHoursFormatterTable::settingsSummary in src/Plugin/Field/FieldFormatter/OfficeHoursFormatterTable.php
Returns a short summary for the current formatter settings.

File

src/Plugin/Field/FieldFormatter/OfficeHoursFormatterBase.php, line 268

Class

OfficeHoursFormatterBase
Abstract plugin implementation of the formatter.

Namespace

Drupal\office_hours\Plugin\Field\FieldFormatter

Code

public function settingsSummary() {
  $summary = parent::settingsSummary();

  // @todo Return more info, like Date module does.
  $summary[] = $this
    ->t('Display Office hours in different formats.');
  return $summary;
}