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

	Code Coverage
	Classes and Traits		Functions and Methods				Lines
Total	100.00% covered (success)	0 / 0	100.00% covered (success)	100.00%	0 / 0	CRAP	100.00% covered (success)	100.00%	0 / 0

1	<?php
2
3	/**
4	* @file
5	* Contains \Drupal\Component\Plugin\ContextAwarePluginInterface.
6	*/
7
8	namespace Drupal\Component\Plugin;
9
10	use \Drupal\Component\Plugin\Context\ContextInterface;
11
12	/**
13	* Interface for defining context aware plugins.
14	*
15	* Context aware plugins can specify an array of context definitions keyed by
16	* context name at the plugin definition under the "context" key.
17	*
18	* @ingroup plugin_api
19	*/
20	interface ContextAwarePluginInterface extends PluginInspectionInterface {
21
22	/**
23	* Gets the context definitions of the plugin.
24	*
25	* @return \Drupal\Component\Plugin\Context\ContextDefinitionInterface[]
26	* The array of context definitions, keyed by context name.
27	*/
28	public function getContextDefinitions();
29
30	/**
31	* Gets a specific context definition of the plugin.
32	*
33	* @param string $name
34	* The name of the context in the plugin definition.
35	*
36	* @return \Drupal\Component\Plugin\Context\ContextDefinitionInterface.
37	* The definition against which the context value must validate.
38	*
39	* @throws \Drupal\Component\Plugin\Exception\PluginException
40	* If the requested context is not defined.
41	*/
42	public function getContextDefinition($name);
43
44	/**
45	* Gets the defined contexts.
46	*
47	* @return array
48	* The set context objects.
49	*
50	* @throws \Drupal\Component\Plugin\Exception\PluginException
51	* If contexts are defined but not set.
52	*/
53	public function getContexts();
54
55	/**
56	* Gets a defined context.
57	*
58	* @param string $name
59	* The name of the context in the plugin definition.
60	*
61	* @return \Drupal\Component\Plugin\Context\ContextInterface
62	* The context object.
63	*
64	* @throws \Drupal\Component\Plugin\Exception\PluginException
65	* If the requested context is not set.
66	*/
67	public function getContext($name);
68
69	/**
70	* Gets the values for all defined contexts.
71	*
72	* @return array
73	* An array of set context values, keyed by context name. If a context is
74	* unset its value is returned as NULL.
75	*/
76	public function getContextValues();
77
78	/**
79	* Gets the value for a defined context.
80	*
81	* @param string $name
82	* The name of the context in the plugin configuration.
83	*
84	* @return mixed
85	* The currently set context value.
86	*
87	* @throws \Drupal\Component\Plugin\Exception\PluginException
88	* If the requested context is not set.
89	*/
90	public function getContextValue($name);
91
92	/**
93	* Set a context on this plugin.
94	*
95	* @param string $name
96	* The name of the context in the plugin configuration.
97	* @param \Drupal\Component\Plugin\Context\ContextInterface $context
98	* The context object to set.
99	*/
100	public function setContext($name, ContextInterface $context);
101
102	/**
103	* Sets the value for a defined context.
104	*
105	* @param string $name
106	* The name of the context in the plugin definition.
107	* @param mixed $value
108	* The value to set the context to. The value has to validate against the
109	* provided context definition.
110	*
111	* @return \Drupal\Component\Plugin\ContextAwarePluginInterface.
112	* A context aware plugin object for chaining.
113	*
114	* @throws \Drupal\Component\Plugin\Exception\PluginException
115	* If the value does not pass validation.
116	*/
117	public function setContextValue($name, $value);
118
119	/**
120	* Validates the set values for the defined contexts.
121	*
122	* @return \Symfony\Component\Validator\ConstraintViolationListInterface
123	* A list of constraint violations. If the list is empty, validation
124	* succeeded.
125	*/
126	public function validateContexts();
127
128	/**
129	* Gets a mapping of the expected assignment names to their context names.
130	*
131	* @return array
132	* A mapping of the expected assignment names to their context names. For
133	* example, if one of the $contexts is named 'user.current_user', but the
134	* plugin expects a context named 'user', then this map would contain
135	* 'user' => 'user.current_user'.
136	*/
137	public function getContextMapping();
138
139	/**
140	* Sets a mapping of the expected assignment names to their context names.
141	*
142	* @param array $context_mapping
143	* A mapping of the expected assignment names to their context names. For
144	* example, if one of the $contexts is named 'user.current_user', but the
145	* plugin expects a context named 'user', then this map would contain
146	* 'user' => 'user.current_user'.
147	*
148	* @return $this
149	*/
150	public function setContextMapping(array $context_mapping);
151
152	}