1. interface
  2. Drupal
  3. \
  4. config_translation
  5. \
  6. Controller
  7. \
  8. ConfigTranslationEntityListBuilderInterface

ConfigTranslationEntityListBuilderInterface

interface ConfigTranslationEntityListBuilderInterface implements EntityListBuilderInterface (View source)

Defines an interface for configuration translation entity list builders.

Methods

EntityStorageInterface
getStorage()

Gets the entity storage.

from  EntityListBuilderInterface
EntityInterface[]
load()

Loads entities of this type from storage for listing.

from  EntityListBuilderInterface
array
getOperations(EntityInterface $entity)

Provides an array of information to build a list of operation links.

from  EntityListBuilderInterface
array
render()

Builds a listing of entities for the given entity type.

from  EntityListBuilderInterface
int
sortRows(array $a, array $b)

Sorts an array by value.

$this
setMapperDefinition(mixed $mapper_definition)

Sets the config translation mapper definition.

Details

in EntityListBuilderInterface at line 16
EntityStorageInterface getStorage()

Gets the entity storage.

Return Value

EntityStorageInterface

The storage used by this list builder.

in EntityListBuilderInterface at line 29
EntityInterface[] 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.

Return Value

EntityInterface[]

An array of entities implementing \Drupal\Core\Entity\EntityInterface indexed by their IDs. Returns an empty array if no matching entities are found.

in EntityListBuilderInterface at line 44
array getOperations(EntityInterface $entity)

Provides an array of information to build a list of operation links.

Parameters

EntityInterface $entity

The entity the operations are for.

Return Value

array

An associative array of operation link data for this list, keyed by operation name, containing the following key-value pairs:

  • title: The localized title of the operation.
  • url: An instance of \Drupal\Core\Url for the operation URL.
  • weight: The weight of this operation.

in EntityListBuilderInterface at line 53
array render()

Builds a listing of entities for the given entity type.

Return Value

array

A render array as expected by \Drupal\Core\Render\RendererInterface::render().

at line 23
int sortRows(array $a, array $b)

Sorts an array by value.

Parameters

array $a

First item for comparison.
array $b

Second item for comparison.

Return Value

int

The comparison result for uasort().

at line 33
$this setMapperDefinition(mixed $mapper_definition)

Sets the config translation mapper definition.

Parameters

mixed $mapper_definition

The plugin definition of the config translation mapper.

Return Value

$this