Same name and namespace in other branches
- 8.9.x core/lib/Drupal/Core/Config/Entity/ConfigEntityListBuilder.php \Drupal\Core\Config\Entity\ConfigEntityListBuilder
- 9 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
- class \Drupal\Core\Entity\EntityHandlerBase uses DependencySerializationTrait, StringTranslationTrait
- class \Drupal\Core\Entity\EntityListBuilder implements EntityHandlerInterface, EntityListBuilderInterface uses MessengerTrait, RedirectDestinationTrait
- class \Drupal\Core\Config\Entity\ConfigEntityListBuilder
- class \Drupal\Core\Entity\EntityListBuilder implements EntityHandlerInterface, EntityListBuilderInterface uses MessengerTrait, RedirectDestinationTrait
Expanded class hierarchy of ConfigEntityListBuilder
Related topics
15 files declare their use of ConfigEntityListBuilder
- BlockContentTypeListBuilder.php in core/
modules/ block_content/ src/ BlockContentTypeListBuilder.php - BlockListBuilder.php in core/
modules/ block/ src/ BlockListBuilder.php - ConfigTestListBuilder.php in core/
modules/ config/ tests/ config_test/ src/ ConfigTestListBuilder.php - ConfigTranslationEntityListBuilder.php in core/
modules/ config_translation/ src/ Controller/ ConfigTranslationEntityListBuilder.php - ContactFormListBuilder.php in core/
modules/ contact/ src/ ContactFormListBuilder.php
File
- core/
lib/ Drupal/ Core/ Config/ Entity/ ConfigEntityListBuilder.php, line 13
Namespace
Drupal\Core\Config\EntityView 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
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ConfigEntityListBuilder:: |
protected | property |
The config entity storage class. Overrides EntityListBuilder:: |
|
ConfigEntityListBuilder:: |
public | function |
Gets this list's default operations. Overrides EntityListBuilder:: |
8 |
ConfigEntityListBuilder:: |
public | function |
Gets the config entity storage. Overrides EntityListBuilder:: |
|
ConfigEntityListBuilder:: |
public | function |
Loads entities of this type from storage for listing. Overrides EntityListBuilder:: |
3 |
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
public | function | 2 | |
DependencySerializationTrait:: |
public | function | 2 | |
EntityHandlerBase:: |
protected | property | The module handler to invoke hooks on. | 5 |
EntityHandlerBase:: |
protected | function | Gets the module handler. | 5 |
EntityHandlerBase:: |
public | function | Sets the module handler for this handler. | |
EntityListBuilder:: |
protected | property | Information about the entity type. | |
EntityListBuilder:: |
protected | property | The entity type ID. | |
EntityListBuilder:: |
protected | property | The number of entities to list per page, or FALSE to list all entities. | |
EntityListBuilder:: |
public | function | Builds the header row for the entity listing. | 20 |
EntityListBuilder:: |
public | function | Builds a renderable list of operation links for the entity. | 1 |
EntityListBuilder:: |
public | function | Builds a row for an entity in the entity listing. | 20 |
EntityListBuilder:: |
public static | function |
Instantiates a new instance of this entity handler. Overrides EntityHandlerInterface:: |
12 |
EntityListBuilder:: |
protected | function | Ensures that a destination is present on the given URL. | 1 |
EntityListBuilder:: |
protected | function | Loads entity IDs using a pager sorted by the entity id. | 5 |
EntityListBuilder:: |
protected | function | Returns a query object for loading entity IDs from the storage. | |
EntityListBuilder:: |
public | function |
Provides an array of information to build a list of operation links. Overrides EntityListBuilderInterface:: |
2 |
EntityListBuilder:: |
protected | function | Gets the title of the page. | 1 |
EntityListBuilder:: |
public | function |
Builds the entity listing as renderable array for table.html.twig. Overrides EntityListBuilderInterface:: |
14 |
EntityListBuilder:: |
public | function | Constructs a new EntityListBuilder object. | 12 |
MessengerTrait:: |
protected | property | The messenger. | 10 |
MessengerTrait:: |
public | function | Gets the messenger. | 10 |
MessengerTrait:: |
public | function | Sets the messenger. | |
RedirectDestinationTrait:: |
protected | property | The redirect destination service. | 1 |
RedirectDestinationTrait:: |
protected | function | Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url. | |
RedirectDestinationTrait:: |
protected | function | Returns the redirect destination service. | |
RedirectDestinationTrait:: |
public | function | Sets the redirect destination service. | |
StringTranslationTrait:: |
protected | property | The string translation service. | 3 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 1 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. |