public function ImageFormatter::settingsSummary in Drupal 9

Same name and namespace in other branches

8 core/modules/image/src/Plugin/Field/FieldFormatter/ImageFormatter.php \Drupal\image\Plugin\Field\FieldFormatter\ImageFormatter::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

2 calls to ImageFormatter::settingsSummary()

ImageUrlFormatter::settingsSummary in core/modules/image/src/Plugin/Field/FieldFormatter/ImageUrlFormatter.php: Returns a short summary for the current formatter settings.
MediaThumbnailFormatter::settingsSummary in core/modules/media/src/Plugin/Field/FieldFormatter/MediaThumbnailFormatter.php: Returns a short summary for the current formatter settings.

2 methods override ImageFormatter::settingsSummary()

ImageUrlFormatter::settingsSummary in core/modules/image/src/Plugin/Field/FieldFormatter/ImageUrlFormatter.php: Returns a short summary for the current formatter settings.
MediaThumbnailFormatter::settingsSummary in core/modules/media/src/Plugin/Field/FieldFormatter/MediaThumbnailFormatter.php: Returns a short summary for the current formatter settings.

File

core/modules/image/src/Plugin/Field/FieldFormatter/ImageFormatter.php, line 154

Class

ImageFormatter: Plugin implementation of the 'image' formatter.

Namespace

Drupal\image\Plugin\Field\FieldFormatter

Code

public function settingsSummary() {
  $summary = [];
  $image_styles = image_style_options(FALSE);

  // Unset possible 'No defined styles' option.
  unset($image_styles['']);

  // Styles could be lost because of enabled/disabled modules that defines
  // their styles in code.
  $image_style_setting = $this
    ->getSetting('image_style');
  if (isset($image_styles[$image_style_setting])) {
    $summary[] = t('Image style: @style', [
      '@style' => $image_styles[$image_style_setting],
    ]);
  }
  else {
    $summary[] = t('Original image');
  }
  $link_types = [
    'content' => t('Linked to content'),
    'file' => t('Linked to file'),
  ];

  // Display this setting only if image is linked.
  $image_link_setting = $this
    ->getSetting('image_link');
  if (isset($link_types[$image_link_setting])) {
    $summary[] = $link_types[$image_link_setting];
  }
  return $summary;
}

You are here