Issue #2097903 by Berdir, amateescu: Rename EntityRenderController to EntityViewBuilder.

core/includes/entity.inc

@@ -52,8 +52,8 @@ function entity_info_cache_clear() {
 function entity_render_cache_clear() {
   $entity_manager = Drupal::entityManager();
   foreach ($entity_manager->getDefinitions() as $entity_type => $info) {
-    if ($entity_manager->hasController($entity_type, 'render')) {
-      $entity_manager->getRenderController($entity_type)->resetCache();
+    if ($entity_manager->hasController($entity_type, 'view_builder')) {
+      $entity_manager->getViewBuilder($entity_type)->resetCache();
     }
   }
 }
@@ -435,7 +435,7 @@ function entity_page_label(EntityInterface $entity, $langcode = NULL) {
  * @return \Drupal\Core\Entity\EntityAccessControllerInterface
  *   An entity access controller instance.
  *
- * @deprecated Use \Drupal\Core\Entity\EntityManager::getRenderController().
+ * @deprecated Use \Drupal\Core\Entity\EntityManager::getAccessController().
  */
 function entity_access_controller($entity_type) {
   return \Drupal::entityManager()
@@ -551,22 +551,6 @@ function entity_list_controller($entity_type) {
     ->getListController($entity_type);
 }
 
-/**
- * Returns an entity render controller for a given entity type.
- *
- * @param string $entity_type
- *   The type of the entity.
- *
- * @return \Drupal\Core\Entity\EntityRenderControllerInterface
- *   An entity render controller.
- *
- * @deprecated Use \Drupal\Core\Entity\EntityManager::getFormController().
- */
-function entity_render_controller($entity_type) {
-  return \Drupal::entityManager()
-    ->getRenderController($entity_type);
-}
-
 /**
  * Returns the render array for an entity.
  *
@@ -585,7 +569,7 @@ function entity_render_controller($entity_type) {
  *   A render array for the entity.
  */
 function entity_view(EntityInterface $entity, $view_mode, $langcode = NULL, $reset = FALSE) {
-  $render_controller = \Drupal::entityManager()->getRenderController($entity->entityType());
+  $render_controller = \Drupal::entityManager()->getViewBuilder($entity->entityType());
   if ($reset) {
     $render_controller->resetCache(array($entity->id()));
   }
@@ -611,7 +595,7 @@ function entity_view(EntityInterface $entity, $view_mode, $langcode = NULL, $res
  *   entities array passed in $entities.
  */
 function entity_view_multiple(array $entities, $view_mode, $langcode = NULL, $reset = FALSE) {
-  $render_controller = \Drupal::entityManager()->getRenderController(reset($entities)->entityType());
+  $render_controller = \Drupal::entityManager()->getViewBuilder(reset($entities)->entityType());
   if ($reset) {
     $render_controller->resetCache(array_keys($entities));
   }

core/lib/Drupal/Core/Entity/Annotation/EntityType.php

@@ -57,7 +57,7 @@ class EntityType extends Plugin {
    * - list: The name of the class that provides listings of the entities. The
    *   class must implement \Drupal\Core\Entity\EntityListControllerInterface.
    * - render: The name of the class that is used to render the entities. The
-   *   class must implement \Drupal\Core\Entity\EntityRenderControllerInterface.
+   *   class must implement \Drupal\Core\Entity\EntityViewBuilderInterface.
    * - access: The name of the class that is used for access checks. The class
    *   must implement \Drupal\Core\Entity\EntityAccessControllerInterface.
    *   Defaults to \Drupal\Core\Entity\EntityAccessController.

core/lib/Drupal/Core/Entity/Controller/EntityViewController.php

@@ -62,7 +62,7 @@ public static function create(ContainerInterface $container) {
    */
   public function view(EntityInterface $_entity, $view_mode = 'full', $langcode = NULL) {
     return $this->entityManager
-      ->getRenderController($_entity->entityType())
+      ->getViewBuilder($_entity->entityType())
       ->view($_entity, $view_mode, $langcode);
   }
 

core/lib/Drupal/Core/Entity/Entity.php

@@ -364,8 +364,8 @@ public function changed() {
     }
 
     foreach ($referenced_entity_ids as $entity_type => $entity_ids) {
-      if (\Drupal::entityManager()->hasController($entity_type, 'render')) {
-        \Drupal::entityManager()->getRenderController($entity_type)->resetCache(array_keys($entity_ids));
+      if (\Drupal::entityManager()->hasController($entity_type, 'view_builder')) {
+        \Drupal::entityManager()->getViewBuilder($entity_type)->resetCache(array_keys($entity_ids));
       }
     }
   }

core/lib/Drupal/Core/Entity/EntityManager.php

@@ -307,16 +307,16 @@ public function getFormController($entity_type, $operation) {
   }
 
   /**
-   * Creates a new render controller instance.
+   * Creates a new view builder instance.
    *
    * @param string $entity_type
-   *   The entity type for this render controller.
+   *   The entity type for this view builder.
    *
-   * @return \Drupal\Core\Entity\EntityRenderControllerInterface.
-   *   A render controller instance.
+   * @return \Drupal\Core\Entity\EntityViewBuilderInterface.
+   *   A view builder instance.
    */
-  public function getRenderController($entity_type) {
-    return $this->getController($entity_type, 'render');
+  public function getViewBuilder($entity_type) {
+    return $this->getController($entity_type, 'view_builder');
   }
 
   /**

core/lib/Drupal/Core/Entity/EntityRenderController.php → core/lib/Drupal/Core/Entity/EntityViewBuilder.php

@@ -2,7 +2,7 @@
 
 /**
  * @file
- * Contains \Drupal\Core\Entity\EntityRenderController.
+ * Contains \Drupal\Core\Entity\EntityViewBuilder.
  */
 
 namespace Drupal\Core\Entity;
@@ -13,7 +13,7 @@
 /**
  * Base class for entity view controllers.
  */
-class EntityRenderController implements EntityRenderControllerInterface {
+class EntityViewBuilder implements EntityViewBuilderInterface {
 
   /**
    * The type of entities for which this controller is instantiated.
@@ -56,7 +56,7 @@ public function __construct($entity_type) {
   }
 
   /**
-   * Implements \Drupal\Core\Entity\EntityRenderControllerInterface::buildContent().
+   * {@inheritdoc}
    */
   public function buildContent(array $entities, array $displays, $view_mode, $langcode = NULL) {
     field_attach_prepare_view($this->entityType, $entities, $displays, $langcode);
@@ -148,7 +148,7 @@ protected function getBuildDefaults(EntityInterface $entity, $view_mode, $langco
   protected function alterBuild(array &$build, EntityInterface $entity, EntityDisplay $display, $view_mode, $langcode = NULL) { }
 
   /**
-   * Implements \Drupal\Core\Entity\EntityRenderControllerInterface::view().
+   * {@inheritdoc}
    */
   public function view(EntityInterface $entity, $view_mode = 'full', $langcode = NULL) {
     $buildList = $this->viewMultiple(array($entity), $view_mode, $langcode);
@@ -156,7 +156,7 @@ public function view(EntityInterface $entity, $view_mode = 'full', $langcode = N
   }
 
   /**
-   * Implements \Drupal\Core\Entity\EntityRenderControllerInterface::viewMultiple().
+   * {@inheritdoc}
    */
   public function viewMultiple(array $entities = array(), $view_mode = 'full', $langcode = NULL) {
     if (!isset($langcode)) {

core/lib/Drupal/Core/Entity/EntityRenderControllerInterface.php → core/lib/Drupal/Core/Entity/EntityViewBuilderInterface.php

@@ -2,7 +2,7 @@
 
 /**
  * @file
- * Contains \Drupal\Core\Entity\EntityRenderControllerInterface.
+ * Contains \Drupal\Core\Entity\EntityViewBuilderInterface.
  */
 
 namespace Drupal\Core\Entity;
@@ -10,7 +10,7 @@
 /**
  * Defines a common interface for entity view controller classes.
  */
-interface EntityRenderControllerInterface {
+interface EntityViewBuilderInterface {
 
   /**
    * Build the structured $content property on the entity.

core/modules/aggregator/lib/Drupal/aggregator/Controller/AggregatorController.php

@@ -85,7 +85,7 @@ public function feedAdd() {
    */
   public function viewFeed(FeedInterface $aggregator_feed) {
     $entity_manager = $this->entityManager();
-    $feed_source = $entity_manager->getRenderController('aggregator_feed')
+    $feed_source = $entity_manager->getViewBuilder('aggregator_feed')
       ->view($aggregator_feed, 'default');
     // Load aggregator feed item for the particular feed id.
     $items = $entity_manager->getStorageController('aggregator_item')->loadByFeed($aggregator_feed->id());
@@ -131,7 +131,7 @@ protected function buildPageList(array $items, $feed_source = '') {
     );
     $build['feed_source'] = is_array($feed_source) ? $feed_source : array('#markup' => $feed_source);
     if ($items) {
-      $build['items'] = $this->entityManager()->getRenderController('aggregator_item')
+      $build['items'] = $this->entityManager()->getViewBuilder('aggregator_item')
         ->viewMultiple($items, 'default');
       $build['pager'] = array('#theme' => 'pager');
     }
@@ -274,7 +274,7 @@ public function categories() {
       if ($aggregator_summary_items) {
         $items = $entity_manager->getStorageController('aggregator_item')->loadByCategory($category->cid);
         if ($items) {
-          $summary_items = $entity_manager->getRenderController('aggregator_item')->viewMultiple($items, 'summary');
+          $summary_items = $entity_manager->getViewBuilder('aggregator_item')->viewMultiple($items, 'summary');
         }
       }
       $category->url = $this->urlGenerator()->generateFromPath('aggregator/categories/' . $category->cid);
@@ -326,7 +326,7 @@ public function sources() {
         $items = $entity_manager->getStorageController('aggregator_item')
           ->loadByFeed($feed->id());
         if ($items) {
-          $summary_items = $entity_manager->getRenderController('aggregator_item')
+          $summary_items = $entity_manager->getViewBuilder('aggregator_item')
             ->viewMultiple($items, 'summary');
         }
       }

core/modules/aggregator/lib/Drupal/aggregator/Entity/Feed.php

@@ -23,7 +23,7 @@
  *   module = "aggregator",
  *   controllers = {
  *     "storage" = "Drupal\aggregator\FeedStorageController",
- *     "render" = "Drupal\aggregator\FeedRenderController",
+ *     "view_builder" = "Drupal\aggregator\FeedViewBuilder",
  *     "form" = {
  *       "default" = "Drupal\aggregator\FeedFormController",
  *       "delete" = "Drupal\aggregator\Form\FeedDeleteForm",

core/modules/aggregator/lib/Drupal/aggregator/Entity/Item.php

@@ -22,7 +22,7 @@
  *   module = "aggregator",
  *   controllers = {
  *     "storage" = "Drupal\aggregator\ItemStorageController",
- *     "render" = "Drupal\aggregator\ItemRenderController"
+ *     "view_builder" = "Drupal\aggregator\ItemViewBuilder"
  *   },
  *   base_table = "aggregator_item",
  *   fieldable = TRUE,

core/modules/aggregator/lib/Drupal/aggregator/FeedRenderController.php → core/modules/aggregator/lib/Drupal/aggregator/FeedViewBuilder.php

@@ -2,21 +2,21 @@
 
 /**
  * @file
- * Contains \Drupal\aggregator\FeedRenderController.
+ * Contains \Drupal\aggregator\FeedViewBuilder.
  */
 
 namespace Drupal\aggregator;
 
 use Drupal\Core\Entity\EntityInterface;
-use Drupal\Core\Entity\EntityRenderController;
+use Drupal\Core\Entity\EntityViewBuilder;
 
 /**
  * Render controller for aggregator feed items.
  */
-class FeedRenderController extends EntityRenderController {
+class FeedViewBuilder extends EntityViewBuilder {
 
   /**
-   * Overrides Drupal\Core\Entity\EntityRenderController::getBuildDefaults().
+   * {@inheritdoc}
    */
   protected function getBuildDefaults(EntityInterface $entity, $view_mode, $langcode) {
     $defaults = parent::getBuildDefaults($entity, $view_mode, $langcode);

core/modules/aggregator/lib/Drupal/aggregator/Form/AggregatorCategorizeFormBase.php

@@ -11,7 +11,7 @@
 use Drupal\aggregator\FeedInterface;
 use Drupal\aggregator\ItemStorageControllerInterface;
 use Drupal\Component\Utility\String;
-use Drupal\Core\Entity\EntityRenderControllerInterface;
+use Drupal\Core\Entity\EntityViewBuilderInterface;
 use Drupal\Core\Form\FormBase;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 
@@ -21,9 +21,9 @@
 abstract class AggregatorCategorizeFormBase extends FormBase {
 
   /**
-   * The aggregator item render controller.
+   * The aggregator item view builder.
    *
-   * @var \Drupal\Core\Entity\EntityRenderControllerInterface
+   * @var \Drupal\Core\Entity\EntityViewBuilderInterface
    */
   protected $aggregatorItemRenderer;
 
@@ -58,26 +58,23 @@ abstract class AggregatorCategorizeFormBase extends FormBase {
   /**
    * Constructs a \Drupal\aggregator\Controller\AggregatorController object.
    *
-   * @param \Drupal\Core\Entity\EntityRenderControllerInterface $aggregator_item_renderer
-   *   The item render controller.
+   * @param \Drupal\Core\Entity\EntityViewBuilderInterface $aggregator_item_renderer
+   *   The item view builder.
    * @param \Drupal\aggregator\ItemStorageControllerInterface $aggregator_item_storage
    *   The aggregator item storage controller.
    * @param \Drupal\aggregator\CategoryStorageControllerInterface $category_storage
    *   The category storage controller.
    */
-  public function __construct(EntityRenderControllerInterface $aggregator_item_renderer, ItemStorageControllerInterface $aggregator_item_storage, CategoryStorageControllerInterface $category_storage) {
+  public function __construct(EntityViewBuilderInterface $aggregator_item_renderer, ItemStorageControllerInterface $aggregator_item_storage, CategoryStorageControllerInterface $category_storage) {
     $this->aggregatorItemRenderer = $aggregator_item_renderer;
     $this->config = $this->config('aggregator.settings');
     $this->aggregatorItemStorage = $aggregator_item_storage;
     $this->categoryStorage = $category_storage;
   }
 
-  /**
-   * {@inheritdoc}
-   */
   public static function create(ContainerInterface $container) {
     return new static(
-      $container->get('plugin.manager.entity')->getRenderController('aggregator_item'),
+      $container->get('plugin.manager.entity')->getViewBuilder('aggregator_item'),
       $container->get('plugin.manager.entity')->getStorageController('aggregator_item'),
       $container->get('aggregator.category.storage')
     );

core/modules/aggregator/lib/Drupal/aggregator/ItemRenderController.php → core/modules/aggregator/lib/Drupal/aggregator/ItemViewBuilder.php

@@ -2,21 +2,21 @@
 
 /**
  * @file
- * Contains \Drupal\aggregator\ItemRenderController.
+ * Contains \Drupal\aggregator\ItemViewBuilder.
  */
 
 namespace Drupal\aggregator;
 
 use Drupal\Core\Entity\EntityInterface;
-use Drupal\Core\Entity\EntityRenderController;
+use Drupal\Core\Entity\EntityViewBuilder;
 
 /**
  * Render controller for aggregator feed items.
  */
-class ItemRenderController extends EntityRenderController {
+class ItemViewBuilder extends EntityViewBuilder {
 
   /**
-   * Overrides Drupal\Core\Entity\EntityRenderController::getBuildDefaults().
+   * {@inheritdoc}
    */
   protected function getBuildDefaults(EntityInterface $entity, $view_mode, $langcode) {
     $defaults = parent::getBuildDefaults($entity, $view_mode, $langcode);

core/modules/aggregator/lib/Drupal/aggregator/Plugin/aggregator/processor/DefaultProcessor.php

@@ -143,7 +143,7 @@ public function process(Feed $feed) {
       return;
     }
     foreach ($feed->items as $item) {
-      // @todo: The default entity render controller always returns an empty
+      // @todo: The default entity view builder always returns an empty
       //   array, which is ignored in aggregator_save_item() currently. Should
       //   probably be fixed.
       if (empty($item['title'])) {

core/modules/block/custom_block/lib/Drupal/custom_block/CustomBlockRenderController.php → core/modules/block/custom_block/lib/Drupal/custom_block/CustomBlockViewBuilder.php

@@ -2,22 +2,22 @@
 
 /**
  * @file
- * Contains \Drupal\custom_block\CustomBlockRenderController.
+ * Contains \Drupal\custom_block\CustomBlockViewBuilder.
  */
 
 namespace Drupal\custom_block;
 
 use Drupal\Core\Entity\EntityInterface;
-use Drupal\Core\Entity\EntityRenderController;
+use Drupal\Core\Entity\EntityViewBuilder;
 use Drupal\entity\Entity\EntityDisplay;
 
 /**
  * Render controller for custom blocks.
  */
-class CustomBlockRenderController extends EntityRenderController {
+class CustomBlockViewBuilder extends EntityViewBuilder {
 
   /**
-   * Overrides \Drupal\Core\Entity\EntityRenderController::alterBuild().
+   * {@inheritdoc}
    */
   protected function alterBuild(array &$build, EntityInterface $entity, EntityDisplay $display, $view_mode, $langcode = NULL) {
     parent::alterBuild($build, $entity, $display, $view_mode, $langcode);

core/modules/block/custom_block/lib/Drupal/custom_block/Entity/CustomBlock.php

@@ -25,7 +25,7 @@
  *     "storage" = "Drupal\custom_block\CustomBlockStorageController",
  *     "access" = "Drupal\custom_block\CustomBlockAccessController",
  *     "list" = "Drupal\custom_block\CustomBlockListController",
- *     "render" = "Drupal\custom_block\CustomBlockRenderController",
+ *     "view_builder" = "Drupal\custom_block\CustomBlockViewBuilder",
  *     "form" = {
  *       "add" = "Drupal\custom_block\CustomBlockFormController",
  *       "edit" = "Drupal\custom_block\CustomBlockFormController",

core/modules/block/lib/Drupal/block/BlockPluginInterface.php

@@ -44,7 +44,7 @@ public function access(AccountInterface $account);
    * @return array
    *   A renderable array representing the content of the block.
    *
-   * @see \Drupal\block\BlockRenderController
+   * @see \Drupal\block\BlockViewBuilder
    */
   public function build();
 

core/modules/block/lib/Drupal/block/BlockRenderController.php → core/modules/block/lib/Drupal/block/BlockViewBuilder.php

@@ -2,28 +2,28 @@
 
 /**
  * @file
- * Contains \Drupal\block\BlockRenderController.
+ * Contains \Drupal\block\BlockViewBuilder.
  */
 
 namespace Drupal\block;
 
-use Drupal\Core\Entity\EntityRenderControllerInterface;
+use Drupal\Core\Entity\EntityViewBuilderInterface;
 use Drupal\Core\Entity\EntityInterface;
 
 /**
- * Provides a Block render controller.
+ * Provides a Block view builder.
  */
-class BlockRenderController implements EntityRenderControllerInterface {
+class BlockViewBuilder implements EntityViewBuilderInterface {
 
   /**
-   * Implements \Drupal\Core\Entity\EntityRenderControllerInterface::buildContent().
+   * {@inheritdoc}
    */
   public function buildContent(array $entities, array $displays, $view_mode, $langcode = NULL) {
     return array();
   }
 
   /**
-   * Implements Drupal\Core\Entity\EntityRenderControllerInterface::view().
+   * {@inheritdoc}
    */
   public function view(EntityInterface $entity, $view_mode = 'full', $langcode = NULL) {
     $build = $this->viewMultiple(array($entity), $view_mode, $langcode);
@@ -31,7 +31,7 @@ public function view(EntityInterface $entity, $view_mode = 'full', $langcode = N
   }
 
   /**
-   * Implements Drupal\Core\Entity\EntityRenderControllerInterface::viewMultiple().
+   * {@inheritdoc}
    */
   public function viewMultiple(array $entities = array(), $view_mode = 'full', $langcode = NULL) {
     $build = array();

core/modules/block/lib/Drupal/block/Entity/Block.php

@@ -24,7 +24,7 @@
  *   controllers = {
  *     "storage" = "Drupal\Core\Config\Entity\ConfigStorageController",
  *     "access" = "Drupal\block\BlockAccessController",
- *     "render" = "Drupal\block\BlockRenderController",
+ *     "view_builder" = "Drupal\block\BlockViewBuilder",
  *     "list" = "Drupal\block\BlockListController",
  *     "form" = {
  *       "default" = "Drupal\block\BlockFormController",

core/modules/book/lib/Drupal/book/BookExport.php

@@ -26,11 +26,11 @@ class BookExport {
   protected $nodeStorage;
 
   /**
-   * The node render controller.
+   * The node view builder.
    *
-   * @var \Drupal\Core\Entity\EntityRenderControllerInterface
+   * @var \Drupal\Core\Entity\EntityViewBuilderInterface
    */
-  protected $nodeRender;
+  protected $viewBuilder;
 
   /**
    * Constructs a BookExport object.
@@ -40,7 +40,7 @@ class BookExport {
    */
   public function __construct(EntityManager $entityManager) {
     $this->nodeStorage = $entityManager->getStorageController('node');
-    $this->nodeRender = $entityManager->getRenderController('node');
+    $this->viewBuilder = $entityManager->getViewBuilder('node');
   }
 
   /**
@@ -125,7 +125,7 @@ protected function exportTraverse(array $tree, $callable) {
    * @see \Drupal\book\BookExport::exportTraverse()
    */
   protected function bookNodeExport(NodeInterface $node, $children = '') {
-    $build = $this->nodeRender->view($node, 'print', NULL);
+    $build = $this->viewBuilder->view($node, 'print', NULL);
     unset($build['#theme']);
 
     // @todo Rendering should happen in the template using render().