class EntityListBuilder

Defines a generic implementation to build a listing of entities.

Hierarchy

• class \Drupal\Core\Entity\EntityHandlerBase uses DependencySerializationTrait, StringTranslationTrait
  • class \Drupal\Core\Entity\EntityListBuilder implements EntityHandlerInterface, EntityListBuilderInterface

Related topics

Entity API

Describes how to define and manipulate content and configuration entities.

File

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

Namespace

Drupal\Core\Entity

Members

Name	Modifiers	Type	Description
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function
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::getDefaultOperations	protected	function	Gets this list's default operations.
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::load	public	function	Loads entities of this type from storage for listing. Overrides EntityListBuilderInterface::load
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.