public function StringFormatter::viewElements in Drupal 10

Same name and namespace in other branches

1. 8 core/lib/Drupal/Core/Field/Plugin/Field/FieldFormatter/StringFormatter.php \Drupal\Core\Field\Plugin\Field\FieldFormatter\StringFormatter::viewElements()
2. 9 core/lib/Drupal/Core/Field/Plugin/Field/FieldFormatter/StringFormatter.php \Drupal\Core\Field\Plugin\Field\FieldFormatter\StringFormatter::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/StringFormatter.php, line 125

Class

StringFormatter

Plugin implementation of the 'string' formatter.

Namespace

Drupal\Core\Field\Plugin\Field\FieldFormatter

Code

public function viewElements(FieldItemListInterface $items, $langcode) {
  $elements = [];
  $url = NULL;
  $entity = $items
    ->getEntity();
  $entity_type = $entity
    ->getEntityType();
  if ($this
    ->getSetting('link_to_entity') && !$entity
    ->isNew() && $entity_type
    ->hasLinkTemplate('canonical')) {
    $url = $this
      ->getEntityUrl($entity);
  }
  foreach ($items as $delta => $item) {
    $view_value = $this
      ->viewValue($item);
    if ($url) {
      $elements[$delta] = [
        '#type' => 'link',
        '#title' => $view_value,
        '#url' => $url,
      ];
    }
    else {
      $elements[$delta] = $view_value;
    }
  }
  return $elements;
}