Drupal 8  8.0.2
DraggableListBuilder Class Reference
Inheritance diagram for DraggableListBuilder:

Public Member Functions

 __construct (EntityTypeInterface $entity_type, EntityStorageInterface $storage)
 
 buildHeader ()
 
 buildRow (EntityInterface $entity)
 
 render ()
 
 buildForm (array $form, FormStateInterface $form_state)
 
 validateForm (array &$form, FormStateInterface $form_state)
 
 submitForm (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
 getFormId ()
 

Protected Member Functions

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

Protected Attributes

 $entitiesKey = 'entities'
 
 $entities = array()
 
 $weightKey = FALSE
 
 $formBuilder
 
- Protected Attributes inherited from EntityListBuilder
 $storage
 
 $entityTypeId
 
 $entityType
 
 $limit = 50
 
- Protected Attributes inherited from EntityHandlerBase
 $moduleHandler
 

Additional Inherited Members

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

Detailed Description

Defines a class to build a draggable listing of configuration entities.

Constructor & Destructor Documentation

__construct ( EntityTypeInterface  $entity_type,
EntityStorageInterface  $storage 
)

{}

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 DraggableListBuilder\buildHeader(), DraggableListBuilder\buildRow(), ConfigEntityListBuilder\load(), and t().

Here is the call graph for this function:

buildHeader ( )

{}

References t().

Referenced by DraggableListBuilder\buildForm().

Here is the call graph for this function:

Here is the caller graph for this function:

buildRow ( EntityInterface  $entity)

{}

References EntityInterface\label(), and t().

Referenced by DraggableListBuilder\buildForm().

Here is the call graph for this function:

Here is the caller graph for this function:

formBuilder ( )
protected

Returns the form builder.

Returns
The form builder.

References Drupal\formBuilder().

Referenced by DraggableListBuilder\render().

Here is the call graph for this function:

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 DraggableListBuilder\formBuilder().

Here is the call graph for this function:

submitForm ( array &  $form,
FormStateInterface  $form_state 
)

{Form submission 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.

References FormStateInterface\getValue().

Here is the call graph for this function:

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.


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