1. class
  2. Drupal
  3. \
  4. rest
  5. \
  6. Plugin
  7. \
  8. Deriver
  9. \
  10. EntityDeriver

EntityDeriver

class EntityDeriver implements ContainerDeriverInterface (View source)

Provides a resource plugin definition for every entity type.

Properties

protected array $derivatives

List of derivative definitions.
protected EntityTypeManagerInterface $entityTypeManager

The entity type manager.

Methods

__construct(EntityTypeManagerInterface $entity_type_manager)

Constructs an EntityDeriver object.

static ContainerDeriverInterface
create(ContainerInterface $container, string $base_plugin_id)

Creates a new class instance.

array
getDerivativeDefinition(string $derivative_id, array|PluginDefinitionInterface $base_plugin_definition)

Gets the definition of a derivative plugin.

array
getDerivativeDefinitions(array $base_plugin_definition)

Gets the definition of all derivatives of a base plugin.

Details

at line 36
__construct(EntityTypeManagerInterface $entity_type_manager)

Constructs an EntityDeriver object.

Parameters

EntityTypeManagerInterface $entity_type_manager

The entity type manager.

at line 43
static ContainerDeriverInterface create(ContainerInterface $container, string $base_plugin_id)

Creates a new class instance.

Parameters

ContainerInterface $container

The container to pull out services used in the fetcher.
string $base_plugin_id

The base plugin ID for the plugin ID.

Return Value

ContainerDeriverInterface

Returns an instance of this fetcher.

at line 52
array getDerivativeDefinition(string $derivative_id, array|PluginDefinitionInterface $base_plugin_definition)

Gets the definition of a derivative plugin.

Parameters

string $derivative_id

The derivative id. The id must uniquely identify the derivative within a given base plugin, but derivative ids can be reused across base plugins.
array|PluginDefinitionInterface $base_plugin_definition

The definition of the base plugin from which the derivative plugin is derived. It is maybe an entire object or just some array, depending on the discovery mechanism.

Return Value

array

The full definition array of the derivative plugin, typically a merge of $base_plugin_definition with extra derivative-specific information. NULL if the derivative doesn't exist.

at line 64
array getDerivativeDefinitions(array $base_plugin_definition)

Gets the definition of all derivatives of a base plugin.

Parameters

array $base_plugin_definition

The definition array of the base plugin.

Return Value

array

An array of full derivative definitions keyed on derivative id.