Drupal 8  8.0.2
DeriverInterface Interface Reference
Inheritance diagram for DeriverInterface:

Public Member Functions

 getDerivativeDefinition ($derivative_id, $base_plugin_definition)
 
 getDerivativeDefinitions ($base_plugin_definition)
 

Detailed Description

Provides additional plugin definitions based on an existing definition.

Member Function Documentation

getDerivativeDefinition (   $derivative_id,
  $base_plugin_definition 
)

Gets the definition of a derivative plugin.

Parameters
string$derivative_idThe derivative id. The id must uniquely identify the derivative within a given base plugin, but derivative ids can be reused across base plugins.
mixed$base_plugin_definitionThe 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.
Returns
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.

Implemented in ViewsEntityRow, ViewsBlock, ViewsExposedFilterBlock, EntityDeriver, FieldItemDeriver, EntityDeriver, MigrateEntity, MigrateEntityRevision, DeriverBase, TestDerivativeDiscoveryWithObject, MockLayoutBlockDeriver, MockMenuBlockDeriver, and TestDerivativeDiscovery.


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