public function ImageFieldTokensFormatter::viewElements in ImageField Tokens 8.2

Same name and namespace in other branches

1. 8 src/Plugin/Field/FieldFormatter/ImageFieldTokensFormatter.php \Drupal\imagefield_tokens\Plugin\Field\FieldFormatter\ImageFieldTokensFormatter::viewElements()

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 ImageFormatter::viewElements

File

src/Plugin/Field/FieldFormatter/ImageFieldTokensFormatter.php, line 117

Class

ImageFieldTokensFormatter

Plugin implementation of the 'image' formatter.

Namespace

Drupal\imagefield_tokens\Plugin\Field\FieldFormatter

Code

public function viewElements(FieldItemListInterface $items, $langcode) {
  $elements = [];
  $entity = NULL;
  $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);

    // Get item values.
    $item_values = $item
      ->getValue();

    // Get entity from request.
    $request_params = $this->routeMatch
      ->getParameters()
      ->all();
    if (count($request_params) > 0) {
      foreach ($request_params as $param) {
        if (is_object($param)) {
          $entity = $param;
        }
      }
    }
    $data = [];
    if ($entity) {
      try {
        $entity_type = method_exists($entity, 'getEntityTypeId') ? $entity
          ->getEntityTypeId() : $entity
          ->getContext('entity')
          ->getContextData()
          ->getValue('entity')
          ->getEntityTypeId();
        $data[$entity_type] = $entity;
      } catch (ContextException $e) {

        // No entity context. Not necessarily an error. Just keep going.
      }
    }

    // Replace entity tokens.
    $alt_bubbles = new BubbleableMetadata();
    $alt_token = $this->tokenService
      ->replace($item_values['alt'], $data, [], $alt_bubbles);
    $title_bubbles = new BubbleableMetadata();
    $title_token = $this->tokenService
      ->replace($item_values['title'], $data, [], $title_bubbles);

    // Set converted values to the item.
    $item_values['alt'] = $alt_token;
    $item_values['title'] = $title_token;
    $item
      ->setValue($item_values);
    $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,
      ],
    ];

    // Add cache info related to tokens.
    $existing_elements_cache = CacheableMetadata::createFromRenderArray($elements[$delta]);
    $token_bubbleable_metadata = $alt_bubbles
      ->merge($title_bubbles);
    $updated_elements_cache = $existing_elements_cache
      ->merge($token_bubbleable_metadata);
    $updated_elements_cache
      ->applyTo($elements[$delta]);
  }
  return $elements;
}