1. 8.5.x core/lib/Drupal/Core/Config/Entity/ConfigEntityListBuilder.php ConfigEntityListBuilder
  2. 8.0.x core/lib/Drupal/Core/Config/Entity/ConfigEntityListBuilder.php ConfigEntityListBuilder
  3. 8.1.x core/lib/Drupal/Core/Config/Entity/ConfigEntityListBuilder.php ConfigEntityListBuilder
  4. 8.2.x core/lib/Drupal/Core/Config/Entity/ConfigEntityListBuilder.php ConfigEntityListBuilder
  5. 8.3.x core/lib/Drupal/Core/Config/Entity/ConfigEntityListBuilder.php ConfigEntityListBuilder
  6. 8.4.x core/lib/Drupal/Core/Config/Entity/ConfigEntityListBuilder.php ConfigEntityListBuilder
  7. 8.6.x core/lib/Drupal/Core/Config/Entity/ConfigEntityListBuilder.php 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

File

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

Namespace

Drupal\Core\Config\Entity
View source
class ConfigEntityListBuilder extends EntityListBuilder {

  /**
   * {@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' => $entity
            ->urlInfo('enable'),
        ];
      }
      elseif ($entity
        ->hasLinkTemplate('disable')) {
        $operations['disable'] = [
          'title' => t('Disable'),
          'weight' => 40,
          'url' => $entity
            ->urlInfo('disable'),
        ];
      }
    }
    return $operations;
  }

}

Members

Contains filters are case sensitive
Namesort descending Modifiers Type Description Overrides
ConfigEntityListBuilder::getDefaultOperations public function Gets this list's default operations. Overrides EntityListBuilder::getDefaultOperations
ConfigEntityListBuilder::load public function Loads entities of this type from storage for listing. Overrides EntityListBuilder::load
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function Prevents serializing any properties.
DependencySerializationTrait::__wakeup public function
EntityHandlerBase::$moduleHandler protected property The module handler to invoke hooks on.
EntityHandlerBase::moduleHandler protected function Gets the module handler.
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::$storage protected property The entity storage class.
EntityListBuilder::buildHeader public function Builds the header row for the entity listing.
EntityListBuilder::buildOperations public function Builds a renderable list of operation links for the entity.
EntityListBuilder::buildRow public function Builds a row for an entity in the entity listing.
EntityListBuilder::createInstance public static function Instantiates a new instance of this entity handler. Overrides EntityHandlerInterface::createInstance
EntityListBuilder::getEntityIds protected function Loads entity IDs using a pager sorted by the entity id.
EntityListBuilder::getLabel Deprecated protected function Gets the label of an entity.
EntityListBuilder::getOperations public function Provides an array of information to build a list of operation links. Overrides EntityListBuilderInterface::getOperations
EntityListBuilder::getStorage public function Gets the entity storage. Overrides EntityListBuilderInterface::getStorage
EntityListBuilder::getTitle protected function Gets the title of the page.
EntityListBuilder::render public function Builds the entity listing as renderable array for table.html.twig. Overrides EntityListBuilderInterface::render
EntityListBuilder::__construct public function Constructs a new EntityListBuilder object.
StringTranslationTrait::$stringTranslation protected property The string translation service.
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.
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.