Builds a renderable array for a field value.

Parameters

\Drupal\Core\Field\FieldItemListInterface $items: The field values to be rendered.

string $langcode: The language that should be used to render the field.

Return value

array A renderable array for $items, as an array of child elements keyed by consecutive numeric indexes starting from 0.

Overrides FormatterInterface::viewElements

1 method overrides ImageFormatter::viewElements()

MediaThumbnailFormatter::viewElements in core/modules/media/src/Plugin/Field/FieldFormatter/MediaThumbnailFormatter.php

Builds a renderable array for a field value.

File

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

Class

ImageFormatter

Plugin implementation of the 'image' formatter.

Namespace

Drupal\image\Plugin\Field\FieldFormatter

Code

public function viewElements(FieldItemListInterface $items, $langcode) {
  $elements = [];
  $files = $this->getEntitiesToView($items, $langcode);
  // Early opt-out if the field is empty.
  if (empty($files)) {
    return $elements;
  }
  $url = NULL;
  $image_link_setting = $this->getSetting('image_link');
  // Check if the formatter involves a link.
  if ($image_link_setting == 'content') {
    $entity = $items->getEntity();
    if (!$entity->isNew()) {
      $url = $entity->toUrl();
    }
  }
  elseif ($image_link_setting == 'file') {
    $link_file = TRUE;
  }
  $image_style_setting = $this->getSetting('image_style');
  // Collect cache tags to be added for each item in the field.
  $base_cache_tags = [];
  if (!empty($image_style_setting)) {
    $image_style = $this->imageStyleStorage
      ->load($image_style_setting);
    $base_cache_tags = $image_style->getCacheTags();
  }
  foreach ($files as $delta => $file) {
    if (isset($link_file)) {
      $image_uri = $file->getFileUri();
      $url = $this->fileUrlGenerator
        ->generate($image_uri);
    }
    $cache_tags = Cache::mergeTags($base_cache_tags, $file->getCacheTags());
    // Extract field item attributes for the theme function, and unset them
    // from the $item so that the field template does not re-render them.
    $item = $file->_referringItem;
    $item_attributes = $item->_attributes;
    unset($item->_attributes);
    $image_loading_settings = $this->getSetting('image_loading');
    $item_attributes['loading'] = $image_loading_settings['attribute'];
    $elements[$delta] = [
      '#theme' => 'image_formatter',
      '#item' => $item,
      '#item_attributes' => $item_attributes,
      '#image_style' => $image_style_setting,
      '#url' => $url,
      '#cache' => [
        'tags' => $cache_tags,
      ],
    ];
  }
  return $elements;
}

---