Code Coverage
	Classes and Traits			Functions and Methods				Lines
Total							CRAP

1	<?php
2
3	namespace Environaut\Report\Results;
4
5	use Environaut\Checks\ICheck;
6	use Environaut\Report\Results\Messages\IMessage;
7	use Environaut\Report\Results\Settings\ISetting;
8
9	/**
10	* Interface that check results must implement.
11	*/
12	interface IResult
13	{
14	/**
15	* Check run was a failure and did not succeed.
16	*/
17	const FAIL = 'fail';
18
19	/**
20	* Check ran successfully.
21	*/
22	const SUCCESS = 'success';
23
24	/**
25	* Check was not yet run or processed.
26	*/
27	const UNEXECUTED = 'unexecuted';
28
29	/**
30	* Check result should not be used as something failed during or prior execution.
31	*/
32	const INVALID = 'invalid';
33
34	/**
35	* Adds the given message to the internal list of messages.
36	*
37	* @param IMessage $message
38	*/
39	public function addMessage(IMessage $message);
40
41	/**
42	* Returns the internal list of messages emitted by the processed check.
43	*
44	* @return array of IMessage implementing instances
45	*/
46	public function getMessages();
47
48	/**
49	* Replaces the internal list of messages with the given list.
50	*
51	* @param array $messages array with IMessage implementing instances
52	*/
53	public function setMessages(array $messages);
54
55	/**
56	* Adds the given setting to the internal list of settings.
57	*
58	* @param ISetting $setting setting to add to the internal lists of settings
59	* @param bool $cachable whether or not the setting may be put into a cache for reuse. Defaults to true.
60	*
61	* @return Result this instance for fluent API support
62	*/
63	public function addSetting(ISetting $setting, $cachable = true);
64
65	/**
66	* Adds the given setting to the internal list of settings.
67	*
68	* @param \Environaut\Report\Results\Settings\ISetting $setting setting to add
69	* @param bool $cachable whether or not the setting may be put into a cache for reuse on re-execution of the check
70	*/
71	public function addSettings(array $setting, $cachable = true);
72
73	/**
74	* Returns the internal list of settings emitted by the processed check.
75	*
76	* @return array of ISetting implementing instances
77	*/
78	public function getSettings();
79
80	/**
81	* Returns the internal list of cachable settings emitted by the processed check.
82	*
83	* @return array of ISetting implementing instances
84	*/
85	public function getCachableSettings();
86
87	/**
88	* Return all settings or the settings of the specified group as an array.
89	*
90	* @param string $group group name of settings to return
91	*
92	* @return array all settings (for the specified group); empty array if group doesn't exist.
93	*/
94	public function getSettingsAsArray($group = null);
95
96	/**
97	* Return all cachable settings or the cachable settings of the specified group as an array.
98	*
99	* @param string $group group name of cachable settings to return
100	*
101	* @return array all cachable settings (for the specified group); empty array if group doesn't exist.
102	*/
103	public function getCachableSettingsAsArray($group = null);
104
105	/**
106	* Sets the status of the current result (which may be of interest for the later export and cache writing).
107	*
108	* @param string $status one of the constants from IResult (like IResult::SUCCESS or IResult::FAIL)
109	*/
110	public function setStatus($status = self::INVALID);
111
112	/**
113	* Returns the current status of this result (usually one of the IResult::SUCCESS or IResult::FAIL constants).
114	*
115	* @return string status of this result instance
116	*/
117	public function getStatus();
118
119	/**
120	* Sets the check instance this result belongs to.
121	*
122	* @param \Environaut\Checks\ICheck $check check this result belongs to
123	*/
124	public function setCheck(ICheck $check);
125
126	/**
127	* Returns the check instance this result belongs to.
128	*
129	* @return \Environaut\Checks\ICheck check instance this result belongs to
130	*/
131	public function getCheck();
132	}