Code Coverage for /Users/ericduran/Sites/drupal/drupal/core/lib/Drupal/Component/Plugin/Derivative/DeriverInterface.php

1	<?php
2
3	/**
4	* @file
5	* Contains \Drupal\Component\Plugin\Derivative\DeriverInterface.
6	*/
7
8	namespace Drupal\Component\Plugin\Derivative;
9
10	/**
11	* Provides additional plugin definitions based on an existing definition.
12	*
13	* @ingroup plugin_api
14	*/
15	interface DeriverInterface {
16
17	/**
18	* Gets the definition of a derivative plugin.
19	*
20	* @param string $derivative_id
21	* The derivative id. The id must uniquely identify the derivative within a
22	* given base plugin, but derivative ids can be reused across base plugins.
23	* @param mixed $base_plugin_definition
24	* The definition of the base plugin from which the derivative plugin
25	* is derived. It is maybe an entire object or just some array, depending
26	* on the discovery mechanism.
27	*
28	* @return array
29	* The full definition array of the derivative plugin, typically a merge of
30	* $base_plugin_definition with extra derivative-specific information. NULL
31	* if the derivative doesn't exist.
32	*/
33	public function getDerivativeDefinition($derivative_id, $base_plugin_definition);
34
35	/**
36	* Gets the definition of all derivatives of a base plugin.
37	*
38	* @param array $base_plugin_definition
39	* The definition array of the base plugin.
40	* @return array
41	* An array of full derivative definitions keyed on derivative id.
42	*
43	* @see getDerivativeDefinition()
44	*/
45	public function getDerivativeDefinitions($base_plugin_definition);
46
47	}