public function EntityReferenceLabelFormatter::viewElements in Drupal 9

Same name and namespace in other branches

1. 8 core/lib/Drupal/Core/Field/Plugin/Field/FieldFormatter/EntityReferenceLabelFormatter.php \Drupal\Core\Field\Plugin\Field\FieldFormatter\EntityReferenceLabelFormatter::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 FormatterInterface::viewElements

File

core/lib/Drupal/Core/Field/Plugin/Field/FieldFormatter/EntityReferenceLabelFormatter.php, line 58

Class

EntityReferenceLabelFormatter

Plugin implementation of the 'entity reference label' formatter.

Namespace

Drupal\Core\Field\Plugin\Field\FieldFormatter

Code

public function viewElements(FieldItemListInterface $items, $langcode) {
  $elements = [];
  $output_as_link = $this
    ->getSetting('link');
  foreach ($this
    ->getEntitiesToView($items, $langcode) as $delta => $entity) {
    $label = $entity
      ->label();

    // If the link is to be displayed and the entity has a uri, display a
    // link.
    if ($output_as_link && !$entity
      ->isNew()) {
      try {
        $uri = $entity
          ->toUrl();
      } catch (UndefinedLinkTemplateException $e) {

        // This exception is thrown by \Drupal\Core\Entity\Entity::urlInfo()
        // and it means that the entity type doesn't have a link template nor
        // a valid "uri_callback", so don't bother trying to output a link for
        // the rest of the referenced entities.
        $output_as_link = FALSE;
      }
    }
    if ($output_as_link && isset($uri) && !$entity
      ->isNew()) {
      $elements[$delta] = [
        '#type' => 'link',
        '#title' => $label,
        '#url' => $uri,
        '#options' => $uri
          ->getOptions(),
      ];
      if (!empty($items[$delta]->_attributes)) {
        $elements[$delta]['#options'] += [
          'attributes' => [],
        ];
        $elements[$delta]['#options']['attributes'] += $items[$delta]->_attributes;

        // Unset field item attributes since they have been included in the
        // formatter output and shouldn't be rendered in the field template.
        unset($items[$delta]->_attributes);
      }
    }
    else {
      $elements[$delta] = [
        '#plain_text' => $label,
      ];
    }
    $elements[$delta]['#cache']['tags'] = $entity
      ->getCacheTags();
  }
  return $elements;
}