Code Coverage
	Classes and Traits			Functions and Methods				Lines
Total							CRAP

1	<?php
2
3	namespace Environaut\Checks;
4
5	use Environaut\Config\Parameters;
6
7	/**
8	* Interface all checks must implement. Checks deliver IResult instances with messages and settings.
9	*/
10	interface ICheck
11	{
12	/**
13	* Default group name used to store settings of this check.
14	*/
15	const DEFAULT_GROUP_NAME = 'default';
16
17	/**
18	* Returns the name of the check.
19	*
20	* @return string name of the check
21	*/
22	public function getName();
23
24	/**
25	* Sets the name of the check.
26	*
27	* @param string $name name of the check
28	*/
29	public function setName($name);
30
31	/**
32	* Returns the group name of the check.
33	*
34	* @return string group name of the check
35	*/
36	public function getGroup();
37
38	/**
39	* Sets the group name of the check (for reports).
40	*
41	* @param string $group name of the group the check belongs to
42	*/
43	public function setGroup($group);
44
45	/**
46	* Returns the runtime parameters of the check.
47	*
48	* @return \Environaut\Config\Parameters instance with runtime parameters
49	*/
50	public function getParameters();
51
52	/**
53	* Sets the necessary runtime parameters of the check.
54	*
55	* @param \Environaut\Config\Parameters $parameters runtime configuration parameters for this check
56	*/
57	public function setParameters(Parameters $parameters);
58
59	/**
60	* Returns the default group name this check uses when none is specified.
61	*
62	* @return string default group name of the check
63	*/
64	public function getDefaultGroupName();
65
66	/**
67	* Returns the default group name this check uses for settings when none is specified.
68	*
69	* @return string default group name of settings of this check
70	*/
71	public function getDefaultSettingGroupName();
72
73	/**
74	* Execute the check and add messages and settings to the result.
75	*
76	* @return boolean true if check succeeded; false otherwise
77	*/
78	public function run();
79
80	/**
81	* Return the result of the check after it ran (consisting of messages and settings).
82	*
83	* @return IResult the result of the check
84	*/
85	public function getResult();
86
87	/**
88	* Return dependencies that must be fulfilled for this check to run.
89	*
90	* @return array of simple string tokens that are necessary to run the check
91	*/
92	public function getDependencies();
93	}