public function ColorapiDisplayFormatterBase::settingsSummary in Color API 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

4 calls to ColorapiDisplayFormatterBase::settingsSummary()

ColorapiColorDisplayFormatter::settingsSummary in src/Plugin/Field/FieldFormatter/ColorapiColorDisplayFormatter.php: Returns a short summary for the current formatter settings.
ColorapiRawHexDisplayFormatter::settingsSummary in src/Plugin/Field/FieldFormatter/ColorapiRawHexDisplayFormatter.php: Returns a short summary for the current formatter settings.
ColorapiRawRgbDisplayFormatter::settingsSummary in src/Plugin/Field/FieldFormatter/ColorapiRawRgbDisplayFormatter.php: Returns a short summary for the current formatter settings.
ColorapiTextDisplayFormatter::settingsSummary in src/Plugin/Field/FieldFormatter/ColorapiTextDisplayFormatter.php: Returns a short summary for the current formatter settings.

4 methods override ColorapiDisplayFormatterBase::settingsSummary()

ColorapiColorDisplayFormatter::settingsSummary in src/Plugin/Field/FieldFormatter/ColorapiColorDisplayFormatter.php: Returns a short summary for the current formatter settings.
ColorapiRawHexDisplayFormatter::settingsSummary in src/Plugin/Field/FieldFormatter/ColorapiRawHexDisplayFormatter.php: Returns a short summary for the current formatter settings.
ColorapiRawRgbDisplayFormatter::settingsSummary in src/Plugin/Field/FieldFormatter/ColorapiRawRgbDisplayFormatter.php: Returns a short summary for the current formatter settings.
ColorapiTextDisplayFormatter::settingsSummary in src/Plugin/Field/FieldFormatter/ColorapiTextDisplayFormatter.php: Returns a short summary for the current formatter settings.

File

src/Plugin/Field/FieldFormatter/ColorapiDisplayFormatterBase.php, line 42

Class

ColorapiDisplayFormatterBase: Base class for Color API Color Field Formatters.

Namespace

Drupal\colorapi\Plugin\Field\FieldFormatter

Code

public function settingsSummary() {
  $summary = parent::settingsSummary();
  $summary['overview'] = $this
    ->t('Displays the textual representation of the color');
  $summary['display_name'] = $this
    ->t('Display the human-readable color name: @display_name', [
    '@display_name' => $this
      ->getSetting('display_name') ? $this
      ->t('Yes') : $this
      ->t('No'),
  ]);
  return $summary;
}

You are here