class ConfigEntityListBuilder

Same name in other branches
  1. 9 core/lib/Drupal/Core/Config/Entity/ConfigEntityListBuilder.php \Drupal\Core\Config\Entity\ConfigEntityListBuilder
  2. 8.9.x core/lib/Drupal/Core/Config/Entity/ConfigEntityListBuilder.php \Drupal\Core\Config\Entity\ConfigEntityListBuilder
  3. 11.x core/lib/Drupal/Core/Config/Entity/ConfigEntityListBuilder.php \Drupal\Core\Config\Entity\ConfigEntityListBuilder

Defines the default class to build a listing of configuration entities.

Hierarchy

Expanded class hierarchy of ConfigEntityListBuilder

Related topics

19 files declare their use of ConfigEntityListBuilder
ActionListBuilder.php in core/modules/action/src/ActionListBuilder.php
BlockContentTypeListBuilder.php in core/modules/block_content/src/BlockContentTypeListBuilder.php
BlockListBuilder.php in core/modules/block/src/BlockListBuilder.php
CommentTypeListBuilder.php in core/modules/comment/src/CommentTypeListBuilder.php
ConfigTestListBuilder.php in core/modules/config/tests/config_test/src/ConfigTestListBuilder.php

... See full list

File

core/lib/Drupal/Core/Config/Entity/ConfigEntityListBuilder.php, line 13

Namespace

Drupal\Core\Config\Entity
View source
class ConfigEntityListBuilder extends EntityListBuilder {
    
    /**
     * The config entity storage class.
     *
     * @var \Drupal\Core\Config\Entity\ConfigEntityStorageInterface
     */
    protected $storage;
    
    /**
     * {@inheritdoc}
     */
    public function load() {
        $entity_ids = $this->getEntityIds();
        $entities = $this->storage
            ->loadMultipleOverrideFree($entity_ids);
        // Sort the entities using the entity class's sort() method.
        // See \Drupal\Core\Config\Entity\ConfigEntityBase::sort().
        uasort($entities, [
            $this->entityType
                ->getClass(),
            'sort',
        ]);
        return $entities;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getDefaultOperations(EntityInterface $entity) {
        
        /** @var \Drupal\Core\Config\Entity\ConfigEntityInterface $entity */
        $operations = parent::getDefaultOperations($entity);
        if ($this->entityType
            ->hasKey('status')) {
            if (!$entity->status() && $entity->hasLinkTemplate('enable')) {
                $operations['enable'] = [
                    'title' => t('Enable'),
                    'weight' => -10,
                    'url' => $this->ensureDestination($entity->toUrl('enable')),
                ];
            }
            elseif ($entity->hasLinkTemplate('disable')) {
                $operations['disable'] = [
                    'title' => t('Disable'),
                    'weight' => 40,
                    'url' => $this->ensureDestination($entity->toUrl('disable')),
                ];
            }
        }
        return $operations;
    }
    
    /**
     * Gets the config entity storage.
     *
     * @return \Drupal\Core\Config\Entity\ConfigEntityStorageInterface
     *   The config storage used by this list builder.
     */
    public function getStorage() : ConfigEntityStorageInterface {
        return $this->storage;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
ConfigEntityListBuilder::$storage protected property The config entity storage class. Overrides EntityListBuilder::$storage
ConfigEntityListBuilder::getDefaultOperations public function Gets this list's default operations. Overrides EntityListBuilder::getDefaultOperations 15
ConfigEntityListBuilder::getStorage public function Gets the config entity storage. Overrides EntityListBuilder::getStorage
ConfigEntityListBuilder::load public function Loads entities of this type from storage for listing. Overrides EntityListBuilder::load 7
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
EntityHandlerBase::$moduleHandler protected property The module handler to invoke hooks on. 5
EntityHandlerBase::moduleHandler protected function Gets the module handler. 5
EntityHandlerBase::setModuleHandler public function Sets the module handler for this handler.
EntityListBuilder::$entityType protected property Information about the entity type.
EntityListBuilder::$entityTypeId protected property The entity type ID.
EntityListBuilder::$limit protected property The number of entities to list per page, or FALSE to list all entities.
EntityListBuilder::buildHeader public function Builds the header row for the entity listing. 25
EntityListBuilder::buildOperations public function Builds a renderable list of operation links for the entity. 2
EntityListBuilder::buildRow public function Builds a row for an entity in the entity listing. 25
EntityListBuilder::createInstance public static function Instantiates a new instance of this entity handler. Overrides EntityHandlerInterface::createInstance 22
EntityListBuilder::ensureDestination protected function Ensures that a destination is present on the given URL. 1
EntityListBuilder::getEntityIds protected function Loads entity IDs using a pager sorted by the entity id. 5
EntityListBuilder::getEntityListQuery protected function Returns a query object for loading entity IDs from the storage.
EntityListBuilder::getOperations public function Provides an array of information to build a list of operation links. Overrides EntityListBuilderInterface::getOperations 3
EntityListBuilder::getTitle protected function Gets the title of the page. 1
EntityListBuilder::render public function Builds the entity listing as renderable array for table.html.twig. Overrides EntityListBuilderInterface::render 17
EntityListBuilder::__construct public function Constructs a new EntityListBuilder object. 18
MessengerTrait::$messenger protected property The messenger. 16
MessengerTrait::messenger public function Gets the messenger. 16
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 2
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.