Drupal 8  8.0.2
ViewListBuilder Class Reference
Inheritance diagram for ViewListBuilder:

Public Member Functions

 __construct (EntityTypeInterface $entity_type, EntityStorageInterface $storage, PluginManagerInterface $display_manager)
 
 load ()
 
 buildRow (EntityInterface $view)
 
 buildHeader ()
 
 getDefaultOperations (EntityInterface $entity)
 
 render ()
 
- Public Member Functions inherited from ConfigEntityListBuilder
 load ()
 
- Public Member Functions inherited from EntityListBuilder
 __construct (EntityTypeInterface $entity_type, EntityStorageInterface $storage)
 
 getStorage ()
 
 load ()
 
 getOperations (EntityInterface $entity)
 
 buildHeader ()
 
 buildRow (EntityInterface $entity)
 
 buildOperations (EntityInterface $entity)
 
 render ()
 
- Public Member Functions inherited from EntityHandlerBase
 setModuleHandler (ModuleHandlerInterface $module_handler)
 

Static Public Member Functions

static createInstance (ContainerInterface $container, EntityTypeInterface $entity_type)
 
- Static Public Member Functions inherited from EntityListBuilder
static createInstance (ContainerInterface $container, EntityTypeInterface $entity_type)
 

Protected Member Functions

 getDisplaysList (EntityInterface $view)
 
 getDisplayPaths (EntityInterface $view)
 
- Protected Member Functions inherited from EntityListBuilder
 getEntityIds ()
 
 getLabel (EntityInterface $entity)
 
 getDefaultOperations (EntityInterface $entity)
 
 getTitle ()
 
- Protected Member Functions inherited from EntityHandlerBase
 moduleHandler ()
 

Protected Attributes

 $displayManager
 
 $limit
 
- Protected Attributes inherited from EntityListBuilder
 $storage
 
 $entityTypeId
 
 $entityType
 
 $limit = 50
 
- Protected Attributes inherited from EntityHandlerBase
 $moduleHandler
 

Detailed Description

Defines a class to build a listing of view entities.

See Also

Constructor & Destructor Documentation

__construct ( EntityTypeInterface  $entity_type,
EntityStorageInterface  $storage,
PluginManagerInterface  $display_manager 
)

Constructs a new ViewListBuilder object.

Parameters
\Drupal\Core\Entity\EntityTypeInterface$entity_typeThe entity type definition.
\Drupal\Core\Entity\EntityStorageInterface$storage,.The entity storage class.
\Drupal\Component\Plugin\PluginManagerInterface$display_managerThe views display plugin manager to use.

Member Function Documentation

buildHeader ( )

{}

References t().

Referenced by ViewListBuilder\render().

Here is the call graph for this function:

Here is the caller graph for this function:

buildRow ( EntityInterface  $view)

{}

References ViewListBuilder\getDisplayPaths(), ViewListBuilder\getDisplaysList(), EntityInterface\id(), and t().

Referenced by ViewListBuilder\render().

Here is the call graph for this function:

Here is the caller graph for this function:

static createInstance ( ContainerInterface  $container,
EntityTypeInterface  $entity_type 
)
static

{Instantiates a new instance of this entity handler.This is a factory method that returns a new instance of this object. The factory should pass any needed dependencies into the constructor of this object, but not the container itself. Every call to this method must return a new instance of this object; that is, it may not implement a singleton.

Parameters
\Symfony\Component\DependencyInjection\ContainerInterface$containerThe service container this object should use.
\Drupal\Core\Entity\EntityTypeInterface$entity_typeThe entity type definition.
Returns
static A new instance of the entity handler.
}

Implements EntityHandlerInterface.

References EntityTypeInterface\get(), and EntityTypeInterface\id().

Here is the call graph for this function:

getDefaultOperations ( EntityInterface  $entity)

{}

References EntityInterface\hasLinkTemplate(), t(), and EntityInterface\urlInfo().

Here is the call graph for this function:

getDisplayPaths ( EntityInterface  $view)
protected

Gets a list of paths assigned to the view.

Parameters
\Drupal\Core\Entity\EntityInterface$viewThe view entity.
Returns
array An array of paths for this view.

References Url\fromUserInput(), and Drupal\l().

Referenced by ViewListBuilder\buildRow().

Here is the call graph for this function:

Here is the caller graph for this function:

getDisplaysList ( EntityInterface  $view)
protected

Gets a list of displays included in the view.

Parameters
\Drupal\Core\Entity\EntityInterface$viewThe view entity instance to get a list of displays for.
Returns
array An array of display types that this view includes.

Referenced by ViewListBuilder\buildRow().

Here is the caller graph for this function:

load ( )

{Loads entities of this type from storage for listing.This allows the implementation to manipulate the listing, like filtering or sorting the loaded entities.

Returns
[] An array of entities implementing .
}

Implements EntityListBuilderInterface.

Referenced by ViewListBuilder\render().

Here is the caller graph for this function:

render ( )

{Builds a listing of entities for the given entity type.

Returns
array A render array as expected by drupal_render().
}

Implements EntityListBuilderInterface.

References ViewListBuilder\buildHeader(), ViewListBuilder\buildRow(), ViewListBuilder\load(), and t().

Here is the call graph for this function:

Field Documentation

$limit
protected

{}


The documentation for this class was generated from the following file: