Plugin interface for derivative plugin handling.
Expanded class hierarchy of DerivativeInterface
All classes that implement DerivativeInterface
interface DerivativeInterface {
/**
* Returns the definition of a derivative plugin.
*
* @param 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.
* @param array $base_plugin_definition
* The definition array of the base plugin from which the derivative plugin
* is derived.
*
* @return 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.
*/
public function getDerivativeDefinition($derivative_id, array $base_plugin_definition);
/**
* Returns the definition of all derivatives of a base plugin.
*
* @param array $base_plugin_definition
* The definition array of the base plugin.
* @return array
* An array of full derivative definitions keyed on derivative id.
*
* @see getDerivativeDefinition()
*/
public function getDerivativeDefinitions(array $base_plugin_definition);
}
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DerivativeInterface:: |
public | function | Returns the definition of a derivative plugin. | 15 |
DerivativeInterface:: |
public | function | Returns the definition of all derivatives of a base plugin. | 15 |