function ImageFormatter::viewElements
Same name in other branches
- 9 core/modules/image/src/Plugin/Field/FieldFormatter/ImageFormatter.php \Drupal\image\Plugin\Field\FieldFormatter\ImageFormatter::viewElements()
- 10 core/modules/image/src/Plugin/Field/FieldFormatter/ImageFormatter.php \Drupal\image\Plugin\Field\FieldFormatter\ImageFormatter::viewElements()
- 11.x core/modules/image/src/Plugin/Field/FieldFormatter/ImageFormatter.php \Drupal\image\Plugin\Field\FieldFormatter\ImageFormatter::viewElements()
Overrides FormatterInterface::viewElements
2 methods override ImageFormatter::viewElements()
- ImageUrlFormatter::viewElements in core/
modules/ image/ src/ Plugin/ Field/ FieldFormatter/ ImageUrlFormatter.php - Builds a renderable array for a field value.
- 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 171
Class
- ImageFormatter
- Plugin implementation of the 'image' formatter.
Namespace
Drupal\image\Plugin\Field\FieldFormatterCode
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) {
$cache_contexts = [];
if (isset($link_file)) {
$image_uri = $file->getFileUri();
// @todo Wrap in file_url_transform_relative(). This is currently
// impossible. As a work-around, we currently add the 'url.site' cache
// context to ensure different file URLs are generated for different
// sites in a multisite setup, including HTTP and HTTPS versions of the
// same site. Fix in https://www.drupal.org/node/2646744.
$url = Url::fromUri(file_create_url($image_uri));
$cache_contexts[] = 'url.site';
}
$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);
$elements[$delta] = [
'#theme' => 'image_formatter',
'#item' => $item,
'#item_attributes' => $item_attributes,
'#image_style' => $image_style_setting,
'#url' => $url,
'#cache' => [
'tags' => $cache_tags,
'contexts' => $cache_contexts,
],
];
}
return $elements;
}
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.