class EntityListBuilder

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

Defines a generic implementation to build a listing of entities.

Hierarchy

Expanded class hierarchy of EntityListBuilder

Related topics

9 files declare their use of EntityListBuilder
BlockContentListBuilder.php in core/modules/block_content/src/BlockContentListBuilder.php
ConfigEntityListBuilder.php in core/lib/Drupal/Core/Config/Entity/ConfigEntityListBuilder.php
EntityListBuilderTest.php in core/tests/Drupal/Tests/Core/Entity/EntityListBuilderTest.php
Contains \Drupal\Tests\Core\Entity\EntityListBuilderTest.
EntityTestListBuilder.php in core/modules/system/tests/modules/entity_test/src/EntityTestListBuilder.php
MediaListBuilder.php in core/modules/media/src/MediaListBuilder.php

... See full list

File

core/lib/Drupal/Core/Entity/EntityListBuilder.php, line 15

Namespace

Drupal\Core\Entity
View source
class EntityListBuilder extends EntityHandlerBase implements EntityListBuilderInterface, EntityHandlerInterface {
    use MessengerTrait;
    use RedirectDestinationTrait;
    
    /**
     * The entity storage class.
     *
     * @var \Drupal\Core\Entity\EntityStorageInterface
     */
    protected $storage;
    
    /**
     * The entity type ID.
     *
     * @var string
     */
    protected $entityTypeId;
    
    /**
     * Information about the entity type.
     *
     * @var \Drupal\Core\Entity\EntityTypeInterface
     */
    protected $entityType;
    
    /**
     * The number of entities to list per page, or FALSE to list all entities.
     *
     * For example, set this to FALSE if the list uses client-side filters that
     * require all entities to be listed (like the views overview).
     *
     * @var int|false
     */
    protected $limit = 50;
    
    /**
     * {@inheritdoc}
     */
    public static function createInstance(ContainerInterface $container, EntityTypeInterface $entity_type) {
        return new static($entity_type, $container->get('entity_type.manager')
            ->getStorage($entity_type->id()));
    }
    
    /**
     * Constructs a new EntityListBuilder object.
     *
     * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
     *   The entity type definition.
     * @param \Drupal\Core\Entity\EntityStorageInterface $storage
     *   The entity storage class.
     */
    public function __construct(EntityTypeInterface $entity_type, EntityStorageInterface $storage) {
        $this->entityTypeId = $entity_type->id();
        $this->storage = $storage;
        $this->entityType = $entity_type;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getStorage() {
        return $this->storage;
    }
    
    /**
     * {@inheritdoc}
     */
    public function load() {
        $entity_ids = $this->getEntityIds();
        return $this->storage
            ->loadMultiple($entity_ids);
    }
    
    /**
     * Loads entity IDs using a pager sorted by the entity id.
     *
     * @return array
     *   An array of entity IDs.
     */
    protected function getEntityIds() {
        $query = $this->getStorage()
            ->getQuery()
            ->sort($this->entityType
            ->getKey('id'));
        // Only add the pager if a limit is specified.
        if ($this->limit) {
            $query->pager($this->limit);
        }
        return $query->execute();
    }
    
    /**
     * Gets the label of an entity.
     *
     * @param \Drupal\Core\Entity\EntityInterface $entity
     *   The entity being listed.
     *
     * @return string
     *   The entity label.
     *
     * @deprecated in drupal:8.0.0 and is removed from drupal:9.0.0.
     *   Use $entity->label() instead. This method used to escape the entity
     *   label. The render system's autoescape is now relied upon.
     */
    protected function getLabel(EntityInterface $entity) {
        return $entity->label();
    }
    
    /**
     * {@inheritdoc}
     */
    public function getOperations(EntityInterface $entity) {
        $operations = $this->getDefaultOperations($entity);
        $operations += $this->moduleHandler()
            ->invokeAll('entity_operation', [
            $entity,
        ]);
        $this->moduleHandler
            ->alter('entity_operation', $operations, $entity);
        uasort($operations, '\\Drupal\\Component\\Utility\\SortArray::sortByWeightElement');
        return $operations;
    }
    
    /**
     * Gets this list's default operations.
     *
     * @param \Drupal\Core\Entity\EntityInterface $entity
     *   The entity the operations are for.
     *
     * @return array
     *   The array structure is identical to the return value of
     *   self::getOperations().
     */
    protected function getDefaultOperations(EntityInterface $entity) {
        $operations = [];
        if ($entity->access('update') && $entity->hasLinkTemplate('edit-form')) {
            $operations['edit'] = [
                'title' => $this->t('Edit'),
                'weight' => 10,
                'url' => $this->ensureDestination($entity->toUrl('edit-form')),
            ];
        }
        if ($entity->access('delete') && $entity->hasLinkTemplate('delete-form')) {
            $operations['delete'] = [
                'title' => $this->t('Delete'),
                'weight' => 100,
                'url' => $this->ensureDestination($entity->toUrl('delete-form')),
            ];
        }
        return $operations;
    }
    
    /**
     * Builds the header row for the entity listing.
     *
     * @return array
     *   A render array structure of header strings.
     *
     * @see \Drupal\Core\Entity\EntityListBuilder::render()
     */
    public function buildHeader() {
        $row['operations'] = $this->t('Operations');
        return $row;
    }
    
    /**
     * Builds a row for an entity in the entity listing.
     *
     * @param \Drupal\Core\Entity\EntityInterface $entity
     *   The entity for this row of the list.
     *
     * @return array
     *   A render array structure of fields for this entity.
     *
     * @see \Drupal\Core\Entity\EntityListBuilder::render()
     */
    public function buildRow(EntityInterface $entity) {
        $row['operations']['data'] = $this->buildOperations($entity);
        return $row;
    }
    
    /**
     * Builds a renderable list of operation links for the entity.
     *
     * @param \Drupal\Core\Entity\EntityInterface $entity
     *   The entity on which the linked operations will be performed.
     *
     * @return array
     *   A renderable array of operation links.
     *
     * @see \Drupal\Core\Entity\EntityListBuilder::buildRow()
     */
    public function buildOperations(EntityInterface $entity) {
        $build = [
            '#type' => 'operations',
            '#links' => $this->getOperations($entity),
        ];
        return $build;
    }
    
    /**
     * {@inheritdoc}
     *
     * Builds the entity listing as renderable array for table.html.twig.
     *
     * @todo Add a link to add a new item to the #empty text.
     */
    public function render() {
        $build['table'] = [
            '#type' => 'table',
            '#header' => $this->buildHeader(),
            '#title' => $this->getTitle(),
            '#rows' => [],
            '#empty' => $this->t('There are no @label yet.', [
                '@label' => $this->entityType
                    ->getPluralLabel(),
            ]),
            '#cache' => [
                'contexts' => $this->entityType
                    ->getListCacheContexts(),
                'tags' => $this->entityType
                    ->getListCacheTags(),
            ],
        ];
        foreach ($this->load() as $entity) {
            if ($row = $this->buildRow($entity)) {
                $build['table']['#rows'][$entity->id()] = $row;
            }
        }
        // Only add the pager if a limit is specified.
        if ($this->limit) {
            $build['pager'] = [
                '#type' => 'pager',
            ];
        }
        return $build;
    }
    
    /**
     * Gets the title of the page.
     */
    protected function getTitle() {
    }
    
    /**
     * Ensures that a destination is present on the given URL.
     *
     * @param \Drupal\Core\Url $url
     *   The URL object to which the destination should be added.
     *
     * @return \Drupal\Core\Url
     *   The updated URL object.
     */
    protected function ensureDestination(Url $url) {
        return $url->mergeOptions([
            'query' => $this->getRedirectDestination()
                ->getAsArray(),
        ]);
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title Overrides
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
EntityHandlerBase::$moduleHandler protected property The module handler to invoke hooks on. 2
EntityHandlerBase::moduleHandler protected function Gets the module handler. 2
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. 3
EntityListBuilder::$storage protected property The entity storage class. 1
EntityListBuilder::buildHeader public function Builds the header row for the entity listing. 26
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. 26
EntityListBuilder::createInstance public static function Instantiates a new instance of this entity handler. Overrides EntityHandlerInterface::createInstance 20
EntityListBuilder::ensureDestination protected function Ensures that a destination is present on the given URL.
EntityListBuilder::getDefaultOperations protected function Gets this list's default operations. 2
EntityListBuilder::getEntityIds protected function Loads entity IDs using a pager sorted by the entity id. 4
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 2
EntityListBuilder::getStorage public function Gets the entity storage. Overrides EntityListBuilderInterface::getStorage
EntityListBuilder::getTitle protected function Gets the title of the page. 1
EntityListBuilder::load public function Loads entities of this type from storage for listing. Overrides EntityListBuilderInterface::load 4
EntityListBuilder::render public function Builds the entity listing as renderable array for table.html.twig. Overrides EntityListBuilderInterface::render 16
EntityListBuilder::__construct public function Constructs a new EntityListBuilder object. 16
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.
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.