public function TwigFormatter::viewElements in Twig Field 8

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

src/Plugin/Field/FieldFormatter/TwigFormatter.php, line 26

Class

TwigFormatter

Plugin implementation of the Twig field formatter.

Namespace

Drupal\twig_field\Plugin\Field\FieldFormatter

Code

public function viewElements(FieldItemListInterface $items, $langcode) {
  $elements = [];
  $entity = $items
    ->getEntity();

  // Global context.
  $context = twig_field_default_context();

  // Field context.
  if ($display_mode_id = $this
    ->getFieldSetting('display_mode')) {
    $display_mode = EntityViewDisplay::load($display_mode_id);
    $twig_field_name = $this->fieldDefinition
      ->getName();

    // Remove current component to avoid recursion.
    $display_mode
      ->removeComponent($twig_field_name);
    $build = $display_mode
      ->build($entity);
    $entity_cache = [
      'tags' => $entity
        ->getCacheTags(),
      'contexts' => $entity
        ->getCacheContexts(),
      'max-age' => $entity
        ->getCacheMaxAge(),
    ];
    foreach ($build as $field_name => $field) {

      // Skip itself to avoid recursion.
      if ($twig_field_name != $field_name) {
        $context[$field_name] = $field;

        // As the fields are rendered individually the cache should be
        // configured for each one.
        if (isset($context[$field_name]['#cache'])) {
          $field_cache = $context[$field_name]['#cache'];
          $context[$field_name]['#cache'] = [
            'tags' => Cache::mergeTags($field_cache['tags'], $entity_cache['tags']),
            'contexts' => Cache::mergeContexts($field_cache['contexts'], $entity_cache['contexts']),
            'max-age' => Cache::mergeMaxAges($field_cache['max-age'], $entity_cache['max-age']),
          ];
        }
      }
    }
  }

  // Other context.
  $entity_type = $this->fieldDefinition
    ->getTargetEntityTypeId();
  $context[$entity_type] = $entity;
  foreach ($items as $delta => $item) {
    $elements[$delta] = [
      '#type' => 'inline_template',
      '#template' => $item->value,
      '#context' => $context,
    ];
  }
  return $elements;
}