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

1	<?php
2
3	/**
4	* @file
5	* Contains \Drupal\Component\Plugin\Context\ContextInterface.
6	*/
7
8	namespace Drupal\Component\Plugin\Context;
9
10	/**
11	* A generic context interface for wrapping data a plugin needs to operate.
12	*/
13	interface ContextInterface {
14
15	/**
16	* Gets the context value.
17	*
18	* @return mixed
19	* The currently set context value, or NULL if it is not set.
20	*/
21	public function getContextValue();
22
23	/**
24	* Returns whether the context has a value.
25	*
26	* @return bool
27	* TRUE if the context has a value, FALSE otherwise.
28	*/
29	public function hasContextValue();
30
31	/**
32	* Gets the provided definition that the context must conform to.
33	*
34	* @return \Drupal\Component\Plugin\Context\ContextDefinitionInterface
35	* The defining characteristic representation of the context.
36	*/
37	public function getContextDefinition();
38
39	/**
40	* Gets a list of validation constraints.
41	*
42	* @return array
43	* Array of constraints, each being an instance of
44	* \Symfony\Component\Validator\Constraint.
45	*/
46	public function getConstraints();
47
48	/**
49	* Validates the set context value.
50	*
51	* @return \Symfony\Component\Validator\ConstraintViolationListInterface
52	* A list of constraint violations. If the list is empty, validation
53	* succeeded.
54	*/
55	public function validate();
56
57	}