FieldViewBuilder.php in Twig Tweak 3.1.x

Namespace

Drupal\twig_tweak\View

File

src/View/FieldViewBuilder.php

<?php

namespace Drupal\twig_tweak\View;

use Drupal\Core\Access\AccessResult;
use Drupal\Core\Cache\CacheableMetadata;
use Drupal\Core\Entity\EntityInterface;
use Drupal\Core\Entity\EntityRepositoryInterface;

/**
 * Field view builder.
 */
class FieldViewBuilder {

  /**
   * The entity repository.
   *
   * @var \Drupal\Core\Entity\EntityRepositoryInterface
   */
  protected $entityRepository;

  /**
   * Constructs a FieldViewBuilder object.
   */
  public function __construct(EntityRepositoryInterface $entity_repository) {
    $this->entityRepository = $entity_repository;
  }

  /**
   * Returns the render array for a single entity field.
   *
   * @param \Drupal\Core\Entity\EntityInterface $entity
   *   The entity.
   * @param string $field_name
   *   The field name.
   * @param string|array $view_mode
   *   (optional) The view mode that should be used to render the field.
   * @param string $langcode
   *   (optional) Language code to load translation.
   * @param bool $check_access
   *   (optional) Indicates that access check is required.
   *
   * @return array
   *   A render array for the field.
   */
  public function build(EntityInterface $entity, string $field_name, $view_mode = 'full', string $langcode = NULL, bool $check_access = TRUE) : array {
    $build = [];
    $entity = $this->entityRepository
      ->getTranslationFromContext($entity, $langcode);
    $access = $check_access ? $entity
      ->access('view', NULL, TRUE) : AccessResult::allowed();
    if ($access
      ->isAllowed()) {
      if (!isset($entity->{$field_name})) {

        // @todo Trigger error here.
        return [];
      }
      $build = $entity->{$field_name}
        ->view($view_mode);
    }
    CacheableMetadata::createFromRenderArray($build)
      ->merge(CacheableMetadata::createFromObject($access))
      ->merge(CacheableMetadata::createFromObject($entity))
      ->applyTo($build);
    return $build;
  }

}

Classes

Name	Description
FieldViewBuilder	Field view builder.