Drupal 8  8.0.2
BlockListBuilder Class Reference
Inheritance diagram for BlockListBuilder:

Public Member Functions

 __construct (EntityTypeInterface $entity_type, EntityStorageInterface $storage, ThemeManagerInterface $theme_manager, FormBuilderInterface $form_builder)
 
 render ($theme=NULL, Request $request=NULL)
 
 getFormId ()
 
 buildForm (array $form, FormStateInterface $form_state)
 
 getDefaultOperations (EntityInterface $entity)
 
 validateForm (array &$form, FormStateInterface $form_state)
 
- 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)
 
- Public Member Functions inherited from FormInterface
 submitForm (array &$form, FormStateInterface $form_state)
 

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

 getThemeName ()
 
 getEntityIds ()
 
 systemRegionList ($theme, $show=REGIONS_ALL)
 
- Protected Member Functions inherited from EntityListBuilder
 getEntityIds ()
 
 getLabel (EntityInterface $entity)
 
 getDefaultOperations (EntityInterface $entity)
 
 getTitle ()
 
- Protected Member Functions inherited from EntityHandlerBase
 moduleHandler ()
 

Protected Attributes

 $theme
 
 $request
 
 $themeManager
 
 $formBuilder
 
 $limit = FALSE
 
- 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 block entities.

See Also

Constructor & Destructor Documentation

__construct ( EntityTypeInterface  $entity_type,
EntityStorageInterface  $storage,
ThemeManagerInterface  $theme_manager,
FormBuilderInterface  $form_builder 
)

Constructs a new BlockListBuilder object.

Parameters
\Drupal\Core\Entity\EntityTypeInterface$entity_typeThe entity type definition.
\Drupal\Core\Entity\EntityStorageInterface$storageThe entity storage class.
\Drupal\Core\Theme\ThemeManagerInterface$theme_managerThe theme manager.
\Drupal\Core\Form\FormBuilderInterface$form_builderThe form builder.

References Drupal\formBuilder().

Here is the call graph for this function:

Member Function Documentation

buildForm ( array  $form,
FormStateInterface  $form_state 
)

{Form constructor.

Parameters
array$formAn associative array containing the structure of the form.
\Drupal\Core\Form\FormStateInterface$form_stateThe current state of the form.
Returns
array The form structure.
}

Implements FormInterface.

References t().

Here is the call 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 t().

Here is the call graph for this function:

getEntityIds ( )
protected

{}

References EntityListBuilder\getStorage(), and BlockListBuilder\getThemeName().

Here is the call graph for this function:

getFormId ( )

{Returns a unique string identifying the form.

Returns
string The unique string identifying the form.
}

Implements FormInterface.

getThemeName ( )
protected

Gets the name of the theme used for this block listing.

Returns
string The name of the theme.

References Drupal\theme().

Referenced by BlockListBuilder\getEntityIds().

Here is the call graph for this function:

Here is the caller graph for this function:

render (   $theme = NULL,
Request  $request = NULL 
)

{}

Parameters
string | null$theme(optional) The theme to display the blocks for. If NULL, the current theme will be used.
\Symfony\Component\HttpFoundation\Request$requestThe current request.
Returns
array The block list as a renderable array.

References Drupal\formBuilder(), Drupal\request(), and Drupal\theme().

Here is the call graph for this function:

systemRegionList (   $theme,
  $show = REGIONS_ALL 
)
protected

Wraps system_region_list().

validateForm ( array &  $form,
FormStateInterface  $form_state 
)

{Form validation handler.

Parameters
array$formAn associative array containing the structure of the form.
\Drupal\Core\Form\FormStateInterface$form_stateThe current state of the form.
}

Implements FormInterface.

Field Documentation

$limit = FALSE
protected

{}


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