Code Coverage for /Users/ericduran/Sites/drupal/drupal/core/lib/Drupal/Core/Entity/EntityListBuilderInterface.php

1	<?php
2
3	/**
4	* @file
5	* Contains \Drupal\Core\Entity\EntityListBuilderInterface.
6	*/
7
8	namespace Drupal\Core\Entity;
9
10	/**
11	* Defines an interface to build entity listings.
12	*/
13	interface EntityListBuilderInterface {
14
15	/**
16	* Gets the entity storage.
17	*
18	* @return \Drupal\Core\Entity\EntityStorageInterface
19	* The storage used by this list builder.
20	*/
21	public function getStorage();
22
23	/**
24	* Loads entities of this type from storage for listing.
25	*
26	* This allows the implementation to manipulate the listing, like filtering or
27	* sorting the loaded entities.
28	*
29	* @return \Drupal\Core\Entity\EntityInterface[]
30	* An array of entities implementing \Drupal\Core\Entity\EntityInterface.
31	*/
32	public function load();
33
34	/**
35	* Provides an array of information to build a list of operation links.
36	*
37	* @param \Drupal\Core\Entity\EntityInterface $entity
38	* The entity the operations are for.
39	*
40	* @return array
41	* An associative array of operation link data for this list, keyed by
42	* operation name, containing the following key-value pairs:
43	* - title: The localized title of the operation.
44	* - url: An instance of \Drupal\Core\Url for the operation URL.
45	* - weight: The weight of this operation.
46	*/
47	public function getOperations(EntityInterface $entity);
48
49	/**
50	* Builds a listing of entities for the given entity type.
51	*
52	* @return array
53	* A render array as expected by drupal_render().
54	*/
55	public function render();
56
57	}