Code Coverage for /Users/ericduran/Sites/drupal/drupal/core/lib/Drupal/Core/Condition/ConditionInterface.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\Condition\ConditionInterface.
6	*/
7
8	namespace Drupal\Core\Condition;
9
10	use Drupal\Component\Plugin\ConfigurablePluginInterface;
11	use Drupal\Component\Plugin\PluginInspectionInterface;
12	use Drupal\Core\Cache\CacheableDependencyInterface;
13	use Drupal\Core\Executable\ExecutableInterface;
14	use Drupal\Core\Executable\ExecutableManagerInterface;
15	use Drupal\Core\Plugin\PluginFormInterface;
16
17	/**
18	* An interface for condition plugins.
19	*
20	* Condition plugins are context-aware and configurable. They support the
21	* following keys in their plugin definitions:
22	* - context: An array of context definitions, keyed by context name. Each
23	* context definition is a typed data definition describing the context. Check
24	* the typed data definition docs for details.
25	* - configuration: An array of configuration option definitions, keyed by
26	* option name. Each option definition is a typed data definition describing
27	* the configuration option. Check the typed data definition docs for details.
28	*
29	* @todo Replace the dependency on \Drupal\Core\Form\FormInterface with a new
30	* interface from https://www.drupal.org/node/2006248.
31	* @todo WARNING: The condition API is going to receive some additions before release.
32	* The following additions are likely to happen:
33	* - The way configuration is handled and configuration forms are built is
34	* likely to change in order for the plugin to be of use for Rules.
35	* - Conditions will receive a data processing API that allows for token
36	* replacements to happen outside of the plugin implementations,
37	* see https://www.drupal.org/node/2347023.
38	* - Conditions will have to implement access control for checking who is
39	* allowed to configure or perform the action at
40	* https://www.drupal.org/node/2172017.
41	*
42	* @see \Drupal\Core\TypedData\TypedDataManager::create()
43	* @see \Drupal\Core\Executable\ExecutableInterface
44	* @see \Drupal\Core\Condition\ConditionManager
45	* @see \Drupal\Core\Condition\Annotation\Condition
46	* @see \Drupal\Core\Condition\ConditionPluginBase
47	*
48	* @ingroup plugin_api
49	*/
50	interface ConditionInterface extends ExecutableInterface, PluginFormInterface, ConfigurablePluginInterface, PluginInspectionInterface, CacheableDependencyInterface {
51
52	/**
53	* Determines whether condition result will be negated.
54	*
55	* @return bool
56	* Whether the condition result will be negated.
57	*/
58	public function isNegated();
59
60	/**
61	* Evaluates the condition and returns TRUE or FALSE accordingly.
62	*
63	* @return bool
64	* TRUE if the condition has been met, FALSE otherwise.
65	*/
66	public function evaluate();
67
68	/**
69	* Provides a human readable summary of the condition's configuration.
70	*/
71	public function summary();
72
73	/**
74	* Sets the executable manager class.
75	*
76	* @param \Drupal\Core\Executable\ExecutableManagerInterface $executableManager
77	* The executable manager.
78	*/
79	public function setExecutableManager(ExecutableManagerInterface $executableManager);
80
81	}