class EntityListController

Same name and namespace in other branches
  1. 8.9.x core/lib/Drupal/Core/Entity/Controller/EntityListController.php \Drupal\Core\Entity\Controller\EntityListController
  2. 10 core/lib/Drupal/Core/Entity/Controller/EntityListController.php \Drupal\Core\Entity\Controller\EntityListController
  3. 11.x core/lib/Drupal/Core/Entity/Controller/EntityListController.php \Drupal\Core\Entity\Controller\EntityListController

Defines a generic controller to list entities.

Hierarchy

Expanded class hierarchy of EntityListController

2 files declare their use of EntityListController
BlockListController.php in core/modules/block/src/Controller/BlockListController.php
FieldConfigListController.php in core/modules/field_ui/src/Controller/FieldConfigListController.php

File

core/lib/Drupal/Core/Entity/Controller/EntityListController.php, line 10

Namespace

Drupal\Core\Entity\Controller
View on git.drupalcode.org
View source 
class EntityListController extends ControllerBase {
    
    /**
     * Provides the listing page for any entity type.
     *
     * @param string $entity_type
     *   The entity type to render.
     *
     * @return array
     *   A render array as expected by
     *   \Drupal\Core\Render\RendererInterface::render().
     */
    public function listing($entity_type) {
        return $this->entityTypeManager()
            ->getListBuilder($entity_type)
            ->render();
    }

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
ControllerBase::$configFactory protected property The configuration factory.
ControllerBase::$currentUser protected property The current user service. 3
ControllerBase::$entityFormBuilder protected property The entity form builder.
ControllerBase::$entityTypeManager protected property The entity type manager.
ControllerBase::$formBuilder protected property The form builder. 1
ControllerBase::$keyValue protected property The key-value storage. 1
ControllerBase::$languageManager protected property The language manager. 1
ControllerBase::$moduleHandler protected property The module handler. 1
ControllerBase::$stateService protected property The state service.
ControllerBase::cache protected function Returns the requested cache bin.
ControllerBase::config protected function Retrieves a configuration object.
ControllerBase::container private function Returns the service container.
ControllerBase::create public static function Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create 49
ControllerBase::currentUser protected function Returns the current user. 3
ControllerBase::entityFormBuilder protected function Retrieves the entity form builder.
ControllerBase::entityTypeManager protected function Retrieves the entity type manager.
ControllerBase::formBuilder protected function Returns the form builder service. 1
ControllerBase::keyValue protected function Returns a key/value storage collection. 1
ControllerBase::languageManager protected function Returns the language manager service. 1
ControllerBase::moduleHandler protected function Returns the module handler. 1
ControllerBase::redirect protected function Returns a redirect response object for the specified route.
ControllerBase::state protected function Returns the state storage service.
EntityListController::listing public function Provides the listing page for any entity type. 2
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MessengerTrait::$messenger protected property The messenger. 17
MessengerTrait::messenger public function Gets the messenger. 17
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
StringTranslationTrait::$stringTranslation protected property The string translation service. 3
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.