Code Coverage for /Users/ericduran/Sites/drupal/drupal/core/lib/Drupal/Component/Plugin/Context/ContextDefinitionInterface.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\Context\ContextDefinitionInterface.
6	*/
7
8	namespace Drupal\Component\Plugin\Context;
9
10	/**
11	* Interface for context definitions.
12	*
13	* @todo WARNING: This interface is going to receive some additions as part of
14	* https://www.drupal.org/node/2346999.
15	*/
16	interface ContextDefinitionInterface {
17
18	/**
19	* Gets a human readable label.
20	*
21	* @return string
22	* The label.
23	*/
24	public function getLabel();
25
26	/**
27	* Sets the human readable label.
28	*
29	* @param string $label
30	* The label to set.
31	*
32	* @return $this
33	*/
34	public function setLabel($label);
35
36	/**
37	* Gets a human readable description.
38	*
39	* @return string\|null
40	* The description, or NULL if no description is available.
41	*/
42	public function getDescription();
43
44	/**
45	* Sets the human readable description.
46	*
47	* @param string\|null $description
48	* The description to set.
49	*
50	* @return $this
51	*/
52	public function setDescription($description);
53
54	/**
55	* Gets the data type needed by the context.
56	*
57	* If the context is multiple-valued, this represents the type of each value.
58	*
59	* @return string
60	* The data type.
61	*/
62	public function getDataType();
63
64	/**
65	* Sets the data type needed by the context.
66	*
67	* @param string $data_type
68	* The data type to set.
69	*
70	* @return $this
71	*/
72	public function setDataType($data_type);
73
74	/**
75	* Determines whether the data is multi-valued, i.e. a list of data items.
76	*
77	* @return bool
78	* Whether the data is multi-valued; i.e. a list of data items.
79	*/
80	public function isMultiple();
81
82	/**
83	* Sets whether the data is multi-valued.
84	*
85	* @param bool $multiple
86	* (optional) Whether the data is multi-valued. Defaults to TRUE.
87	*
88	* @return $this
89	*/
90	public function setMultiple($multiple = TRUE);
91
92	/**
93	* Determines whether the context is required.
94	*
95	* For required data a non-NULL value is mandatory.
96	*
97	* @return bool
98	* Whether a data value is required.
99	*/
100	public function isRequired();
101
102	/**
103	* Sets whether the data is required.
104	*
105	* @param bool $required
106	* (optional) Whether the data is multi-valued. Defaults to TRUE.
107	*
108	* @return $this
109	*/
110	public function setRequired($required = TRUE);
111
112	/**
113	* Gets the default value for this context definition.
114	*
115	* @return mixed
116	* The default value or NULL if no default value is set.
117	*/
118	public function getDefaultValue();
119
120	/**
121	* Sets the default data value.
122	*
123	* @param mixed $default_value
124	* The default value to be set or NULL to remove any default value.
125	*
126	* @return $this
127	*/
128	public function setDefaultValue($default_value);
129
130	/**
131	* Gets an array of validation constraints.
132	*
133	* @return array
134	* An array of validation constraint definitions, keyed by constraint name.
135	* Each constraint definition can be used for instantiating
136	* \Symfony\Component\Validator\Constraint objects.
137	*/
138	public function getConstraints();
139
140	/**
141	* Sets the array of validation constraints.
142	*
143	* NOTE: This will override any previously set constraints. In most cases
144	* ContextDefinitionInterface::addConstraint() should be used instead.
145	*
146	* @param array $constraints
147	* The array of constraints.
148	*
149	* @return $this
150	*
151	* @see self::addConstraint()
152	*/
153	public function setConstraints(array $constraints);
154
155	/**
156	* Adds a validation constraint.
157	*
158	* @param string $constraint_name
159	* The name of the constraint to add, i.e. its plugin id.
160	* @param array\|null $options
161	* The constraint options as required by the constraint plugin, or NULL.
162	*
163	* @return $this
164	*/
165	public function addConstraint($constraint_name, $options = NULL);
166
167	/**
168	* Gets a validation constraint.
169	*
170	* @param string $constraint_name
171	* The name of the constraint, i.e. its plugin id.
172	*
173	* @return array
174	* A validation constraint definition which can be used for instantiating a
175	* \Symfony\Component\Validator\Constraint object.
176	*/
177	public function getConstraint($constraint_name);
178
179	}