EntityListBuilderInterface.php

Same filename in other branches
  1. 9 core/lib/Drupal/Core/Entity/EntityListBuilderInterface.php
  2. 8.9.x core/lib/Drupal/Core/Entity/EntityListBuilderInterface.php
  3. 10 core/lib/Drupal/Core/Entity/EntityListBuilderInterface.php

Namespace

Drupal\Core\Entity

File

core/lib/Drupal/Core/Entity/EntityListBuilderInterface.php

View source
<?php

namespace Drupal\Core\Entity;


/**
 * Defines an interface to build entity listings.
 */
interface EntityListBuilderInterface {
    
    /**
     * Gets the entity storage.
     *
     * @return \Drupal\Core\Entity\EntityStorageInterface
     *   The storage used by this list builder.
     */
    public function getStorage();
    
    /**
     * Loads entities of this type from storage for listing.
     *
     * This allows the implementation to manipulate the listing, like filtering or
     * sorting the loaded entities.
     *
     * @return \Drupal\Core\Entity\EntityInterface[]
     *   An array of entities implementing \Drupal\Core\Entity\EntityInterface
     *   indexed by their IDs. Returns an empty array if no matching entities are
     *   found.
     */
    public function load();
    
    /**
     * Provides an array of information to build a list of operation links.
     *
     * @param \Drupal\Core\Entity\EntityInterface $entity
     *   The entity the operations are for.
     *
     * @return array
     *   An associative array of operation link data for this list, keyed by
     *   operation name, containing the following key-value pairs:
     *   - title: The localized title of the operation.
     *   - url: An instance of \Drupal\Core\Url for the operation URL.
     *   - weight: The weight of this operation.
     */
    public function getOperations(EntityInterface $entity);
    
    /**
     * Builds a listing of entities for the given entity type.
     *
     * @return array
     *   A render array as expected by
     *   \Drupal\Core\Render\RendererInterface::render().
     */
    public function render();

}

Interfaces

Title Deprecated Summary
EntityListBuilderInterface Defines an interface to build entity listings.

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