Rename EntityListController to EntityListBuilder

1. +++ b/core/lib/Drupal/Core/Config/Entity/ConfigEntityList.php
   @@ -2,21 +2,21 @@
   - * Definition of Drupal\Core\Config\Entity\ConfigEntityListController.
   + * Definition of Drupal\Core\Config\Entity\ConfigEntityList.
   

   Any reason we don't convert it to "Contains ... directly"

2. +++ b/core/lib/Drupal/Core/Config/Entity/DraggableList.php
   @@ -2,7 +2,7 @@
   + * Contains Drupal\Core\Config\Entity\DraggableList.
   

   We could add the "\" prefix right now.

3. +++ b/core/lib/Drupal/Core/Config/Entity/DraggableList.php
   @@ -13,9 +13,9 @@
   -abstract class DraggableListController extends ConfigEntityListController implements FormInterface {
   +abstract class DraggableList extends ConfigEntityList implements FormInterface {
   

   I wonder whether we should name it DraggableListBase given that it is a abstract class.

4. +++ b/core/modules/block/custom_block/lib/Drupal/custom_block/CustomBlockTypeList.php
   @@ -29,7 +29,7 @@ public function getOperations(EntityInterface $entity) {
   -   * Overrides \Drupal\Core\Entity\EntityListController::buildHeader().
   
   @@ -38,7 +38,7 @@ public function buildHeader() {
   -   * Overrides \Drupal\Core\Entity\EntityListController::buildRow().
   +   * Overrides \Drupal\Core\Entity\EntityList::buildRow().
   

   {@inheritdoc}

5. +++ b/core/modules/block/lib/Drupal/block/BlockList.php
   @@ -86,7 +85,7 @@ public static function createInstance(ContainerInterface $container, $entity_typ
   -   * Overrides \Drupal\Core\Config\Entity\ConfigEntityListController::load().
   +   * Overrides \Drupal\Core\Config\Entity\ConfigEntityList::load().
   
   @@ -107,7 +106,7 @@ public function load() {
   -   * Overrides \Drupal\Core\Entity\EntityListController::render().
   +   * Overrides \Drupal\Core\Entity\EntityList::render().
   

   {@inheritdoc}

6. +++ b/core/tests/Drupal/Tests/Core/Entity/Enhancer/EntityRouteEnhancerTest.php
   @@ -55,12 +55,12 @@ public function testEnhancer() {
   -    // Set _entity_list and ensure that the entity list controller is set.
   +    // Set _entity_list and ensure that the entity list is set.
   ...
   -    $this->assertEquals('\Drupal\Core\Entity\Controller\EntityListController::listing', $defaults['_content'], 'The entity list controller was not set.');
   +    $this->assertEquals('\Drupal\Core\Entity\Controller\EntityListController::listing', $defaults['_content'], 'The entity list was not set.');
   

   This change is wrong, given that we do talk about the entity list controller (in the routing sense).

Re-roll and updated according to #9

16: entity-list-controller-2120871-16.patch queued for re-testing.

16: entity-list-controller-2120871-16.patch queued for re-testing.

1. +++ b/core/modules/contact/lib/Drupal/contact/CategoryList.php
   @@ -1,21 +1,21 @@
   + * Definition of Drupal\contact\CategoryList.
   
   +++ b/core/lib/Drupal/Core/Config/Entity/ConfigEntityList.php
   @@ -2,21 +2,21 @@
   + * Contains Drupal\Core\Config\Entity\ConfigEntityList.
   

   :)

2. +++ b/core/modules/menu/menu.module
   @@ -100,12 +100,11 @@ function menu_menu() {
      return $items;
    }
   -
    /**
     * Implements hook_entity_info().
   

   I suppose this wasn't intended.

It's not worth keeping up this patch any longer for those minor issues, I think it's RTBC.

I meant this.

The config translation controllers actually replaces list controllers so should be renamed as well

Block module controller should not be affected

Also patch cleans up some remains

Fixed UserList namespace

Do we need to approve this API change?

1. +++ b/core/lib/Drupal/Core/Entity/EntityControllerInterface.php
   @@ -7,7 +7,6 @@
    /**
   
   +++ b/core/lib/Drupal/Core/Entity/Controller/EntityViewController.php
   @@ -25,7 +25,7 @@ class EntityViewController implements ContainerInjectionInterface {
   diff --git a/core/lib/Drupal/Core/Entity/EntityControllerInterface.php b/core/lib/Drupal/Core/Entity/EntityControllerInterface.php
   
   diff --git a/core/lib/Drupal/Core/Entity/EntityControllerInterface.php b/core/lib/Drupal/Core/Entity/EntityControllerInterface.php
   index 79232c1..f78058a 100644
   
   index 79232c1..f78058a 100644
   --- a/core/lib/Drupal/Core/Entity/EntityControllerInterface.php
   
   --- a/core/lib/Drupal/Core/Entity/EntityControllerInterface.php
   +++ b/core/lib/Drupal/Core/Entity/EntityControllerInterface.php
   
   +++ b/core/lib/Drupal/Core/Entity/EntityControllerInterface.php
   +++ b/core/lib/Drupal/Core/Entity/EntityControllerInterface.php
   @@ -7,7 +7,6 @@
   
   @@ -7,7 +7,6 @@
    
    namespace Drupal\Core\Entity;
    
   -use Drupal\Core\Entity\EntityStorageControllerInterface;
    use Symfony\Component\DependencyInjection\ContainerInterface;
    
   

   This change is kind of out of scope ...

2. +++ b/core/lib/Drupal/Core/Entity/EntityList.php
   @@ -161,7 +161,7 @@ public function buildHeader() {
   +   * @see \Drupal\Core\Entity\EntityList::render()
   
   @@ -145,7 +145,7 @@ public function getOperations(EntityInterface $entity) {
   +   * @see \Drupal\Core\Entity\EntityList::render()
   
   @@ -177,7 +177,7 @@ public function buildRow(EntityInterface $entity) {
   +   * @see \Drupal\Core\Entity\EntityList::render()
   

   I wonder whether we should just point to the interface?

The parent meta (#1976158: Rename entity storage/list/form/render "controllers" to handlers) is already an approved API change.

1) my bad, fixed
2) suppose no, api.d.o will show this links on implementation pages so it easy to navigate

30: 2120871-entity-list-30.patch queued for re-testing.

re-roll

re-roll

and new places

fix broken test

And search page entity

What about ListBuilder, matches well with ViewBuilder?

Without knowing I suggested pretty much the same thing on IRC, so +1 from me.

This listing builder is highly coupled to entity so prefix removal will confuse but maybe it makes sense to file new issue to decouple ListBuilderInterface and inherit EntitlyListBuilder from

I think better name for interface is EntityListBuilderInterface but implementations should have shorter names

Better doc-blocks

1. +++ b/core/lib/Drupal/Core/Entity/Controller/EntityViewController.php
   @@ -25,7 +25,7 @@ class EntityViewController implements ContainerInjectionInterface {
   +   * Creates an EntityViewController object.
   

   This is still wrong.

2. +++ b/core/lib/Drupal/Core/Entity/EntityList.php
   @@ -2,7 +2,7 @@
   + * Contains \Drupal\Core\Entity\EntityList.
   
   +++ b/core/includes/entity.inc
   @@ -468,19 +468,19 @@ function entity_get_form(EntityInterface $entity, $operation = 'default', array
   +    ->getList($entity_type);
   ...
   + * @deprecated Use \Drupal\Core\Entity\EntityManagerInterface::getList().
   ...
   + * Returns an entity list for a given entity type.
   

   This is a ListBuilder, not a list.

Re-roll patch to use Builder to replace Controller, just a questionable thing a config_translation controllers but they inherits from builder so changed too.

#50.1 This fixes wrong reference, so change is right.

A bit of clean-up for docs

Fix broken tests and unify doc-blocks

re-roll

Looks good to me!

2120871-entity-list-builder-57.patch no longer applies.

error: patch failed: core/modules/config_translation/config_translation.module:91
error: core/modules/config_translation/config_translation.module: patch does not apply
error: patch failed: core/modules/filter/lib/Drupal/filter/FilterFormatListController.php:2
error: core/modules/filter/lib/Drupal/filter/FilterFormatListController.php: patch does not apply
error: patch failed: core/modules/search/lib/Drupal/search/SearchPageListController.php:2
error: core/modules/search/lib/Drupal/search/SearchPageListController.php: patch does not apply

Re-roll.

One more place to fix now

Back to RTBC then.

Draft change records are now required before commit. We don't do change records for every 8.x to 8.x BC break, but I think this change is big enough to require its own (very brief) change record for modules already using EntityListController.

The following two change records will also need very minor updates:
https://drupal.org/node/2089283
https://drupal.org/node/1799642

Once the change records are ready to go this can be set back to RTBC.

@berdir, can you link the issues and change records you're referring to? And maybe we can continue the discussion in the relevant other issue so we're not blocking this?

I think this issue only needs a very brief change record, like "EntiyListController renamed to EntityListBuilder" and two lines of text, just so there's a notification to the RSS feed and etc. 8.x to 8.x change records should probably usually follow that pattern.

re-roll after #2119905: Provide @ConfigEntityType and @ContentEntityType to have better defaults

Added stub change record https://drupal.org/node/2200867 - the changes of that issue already there
https://drupal.org/node/2089283 & https://drupal.org/node/1799642 - should be updated after commit

re-roll after #2095303: Rename 'field_entity' to 'field_config' and 'field_instance' to 'field_instance_config'

Fix for last broken test

Just a nitpick

Added sandbox link

I like the added docs. Everything else is a 1:1 change.

yep, beck to rtbc

Committed 5abaa5f and pushed to 8.x. Thanks!