Chris@0: <?php
Chris@0: 
Chris@0: namespace Drupal\Tests;
Chris@0: 
Chris@0: use Drupal\Core\Entity\EntityInterface;
Chris@0: use Drupal\Core\Render\Element;
Chris@0: 
Chris@0: /**
Chris@0:  * Provides helper methods to deal with building entity views in tests.
Chris@0:  */
Chris@0: trait EntityViewTrait {
Chris@0: 
Chris@0:   /**
Chris@0:    * Builds the renderable view of an entity.
Chris@0:    *
Chris@0:    * Entities postpone the composition of their renderable arrays to #pre_render
Chris@0:    * functions in order to maximize cache efficacy. This means that the full
Chris@0:    * renderable array for an entity is constructed in drupal_render(). Some
Chris@0:    * tests require the complete renderable array for an entity outside of the
Chris@0:    * drupal_render process in order to verify the presence of specific values.
Chris@0:    * This method isolates the steps in the render process that produce an
Chris@0:    * entity's renderable array.
Chris@0:    *
Chris@0:    * @param \Drupal\Core\Entity\EntityInterface $entity
Chris@0:    *   The entity to prepare a renderable array for.
Chris@0:    * @param string $view_mode
Chris@0:    *   (optional) The view mode that should be used to build the entity.
Chris@0:    * @param null $langcode
Chris@0:    *   (optional) For which language the entity should be prepared, defaults to
Chris@0:    *   the current content language.
Chris@0:    * @param bool $reset
Chris@0:    *   (optional) Whether to clear the cache for this entity.
Chris@0:    * @return array
Chris@0:    *
Chris@16:    * @see \Drupal\Core\Render\RendererInterface::render()
Chris@0:    */
Chris@0:   protected function buildEntityView(EntityInterface $entity, $view_mode = 'full', $langcode = NULL, $reset = FALSE) {
Chris@0:     $ensure_fully_built = function (&$elements) use (&$ensure_fully_built) {
Chris@0:       // If the default values for this element have not been loaded yet, populate
Chris@0:       // them.
Chris@0:       if (isset($elements['#type']) && empty($elements['#defaults_loaded'])) {
Chris@0:         $elements += \Drupal::service('element_info')->getInfo($elements['#type']);
Chris@0:       }
Chris@0: 
Chris@0:       // Make any final changes to the element before it is rendered. This means
Chris@0:       // that the $element or the children can be altered or corrected before the
Chris@0:       // element is rendered into the final text.
Chris@0:       if (isset($elements['#pre_render'])) {
Chris@0:         foreach ($elements['#pre_render'] as $callable) {
Chris@0:           $elements = call_user_func($callable, $elements);
Chris@0:         }
Chris@0:       }
Chris@0: 
Chris@0:       // And recurse.
Chris@0:       $children = Element::children($elements, TRUE);
Chris@0:       foreach ($children as $key) {
Chris@0:         $ensure_fully_built($elements[$key]);
Chris@0:       }
Chris@0:     };
Chris@0: 
Chris@0:     $render_controller = $this->container->get('entity.manager')->getViewBuilder($entity->getEntityTypeId());
Chris@0:     if ($reset) {
Chris@0:       $render_controller->resetCache([$entity->id()]);
Chris@0:     }
Chris@0:     $build = $render_controller->view($entity, $view_mode, $langcode);
Chris@0:     $ensure_fully_built($build);
Chris@0: 
Chris@0:     return $build;
Chris@0:   }
Chris@0: 
Chris@0: }