Code Coverage for /Users/ericduran/Sites/drupal/drupal/core/lib/Drupal/Core/Plugin/Context/ContextHandlerInterface.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\Core\Plugin\Context\ContextHandlerInterface.
6	*/
7
8	namespace Drupal\Core\Plugin\Context;
9
10	use Drupal\Core\Plugin\ContextAwarePluginInterface;
11
12	/**
13	* Provides an interface for handling sets of contexts.
14	*/
15	interface ContextHandlerInterface {
16
17	/**
18	* Determines plugins whose constraints are satisfied by a set of contexts.
19	*
20	* @todo Use context definition objects after
21	* https://www.drupal.org/node/2281635.
22	*
23	* @param \Drupal\Component\Plugin\Context\ContextInterface[] $contexts
24	* An array of contexts.
25	* @param array $definitions .
26	* An array of plugin definitions.
27	*
28	* @return array
29	* An array of plugin definitions.
30	*/
31	public function filterPluginDefinitionsByContexts(array $contexts, array $definitions);
32
33	/**
34	* Checks a set of requirements against a set of contexts.
35	*
36	* @todo Use context definition objects after
37	* https://www.drupal.org/node/2281635.
38	*
39	* @param \Drupal\Component\Plugin\Context\ContextInterface[] $contexts
40	* An array of available contexts.
41	* @param \Drupal\Core\TypedData\DataDefinitionInterface[] $requirements
42	* An array of requirements.
43	*
44	* @return bool
45	* TRUE if all of the requirements are satisfied by the context, FALSE
46	* otherwise.
47	*/
48	public function checkRequirements(array $contexts, array $requirements);
49
50	/**
51	* Determines which contexts satisfy the constraints of a given definition.
52	*
53	* @todo Use context definition objects after
54	* https://www.drupal.org/node/2281635.
55	*
56	* @param \Drupal\Component\Plugin\Context\ContextInterface[] $contexts
57	* An array of contexts.
58	* @param \Drupal\Core\Plugin\Context\ContextDefinitionInterface $definition
59	* The definition to satisfy.
60	*
61	* @return \Drupal\Component\Plugin\Context\ContextInterface[]
62	* An array of matching contexts.
63	*/
64	public function getMatchingContexts(array $contexts, ContextDefinitionInterface $definition);
65
66	/**
67	* Prepares a plugin for evaluation.
68	*
69	* @param \Drupal\Core\Plugin\ContextAwarePluginInterface $plugin
70	* A plugin about to be evaluated.
71	* @param \Drupal\Core\Plugin\Context\ContextInterface[] $contexts
72	* An array of contexts to set on the plugin. They will only be set if they
73	* match the plugin's context definitions.
74	* @param array $mappings
75	* (optional) A mapping of the expected assignment names to their context
76	* names. For example, if one of the $contexts is named 'current_user', but the
77	* plugin expects a context named 'user', then this map would contain
78	* 'user' => 'current_user'.
79	*
80	* @throws \Drupal\Component\Plugin\Exception\ContextException
81	* Thrown when a context assignment was not satisfied.
82	*/
83	public function applyContextMapping(ContextAwarePluginInterface $plugin, $contexts, $mappings = array());
84
85	}