Code Coverage for /home/graste/projects/environaut/src/Environaut/Report/Results/Result.php

	Code Coverage
	Classes and Traits			Functions and Methods				Lines
Total		0.00%	0 / 1		81.25%	13 / 16	CRAP		80.43%	37 / 46
Result		0.00%	0 / 1		81.25%	13 / 16	29.68		80.43%	37 / 46
__construct()					100.00%	1 / 1	1		100.00%	6 / 6
addMessage(IMessage $message)					100.00%	1 / 1	1		100.00%	2 / 2
addSetting(ISetting $setting, $cachable = true)					100.00%	1 / 1	2		100.00%	5 / 5
addSettings(array $settings, $cachable = true)					0.00%	0 / 1	12		0.00%	0 / 6
setMessages(array $messages)					0.00%	0 / 1	2		0.00%	0 / 2
getMessages()					100.00%	1 / 1	1		100.00%	1 / 1
getSettings($groups = null, $flag = null)					100.00%	1 / 1	1		100.00%	1 / 1
getCachableSettings($groups = null, $flag = null)					100.00%	1 / 1	1		100.00%	1 / 1
getSettingsAsArray($groups = null, $flag = null)					100.00%	1 / 1	1		100.00%	1 / 1
getCachableSettingsAsArray($groups = null, $flag = null)					100.00%	1 / 1	1		100.00%	1 / 1
setStatus($status = self::INVALID)					100.00%	1 / 1	1		100.00%	2 / 2
getStatus()					100.00%	1 / 1	1		100.00%	1 / 1
setCheck(ICheck $check)					100.00%	1 / 1	1		100.00%	2 / 2
getCheck()					0.00%	0 / 1	2		0.00%	0 / 1
getFiltered(array $all_settings = array(), $groups = null, $flag = null)					100.00%	1 / 1	4		100.00%	7 / 7
getFilteredAsArray(array $all_settings, $groups = null, $flag = null)					100.00%	1 / 1	4		100.00%	7 / 7

1	<?php
2
3	namespace Environaut\Report\Results;
4
5	use Environaut\Checks\ICheck;
6	use Environaut\Report\Results\IResult;
7	use Environaut\Report\Results\Messages\IMessage;
8	use Environaut\Report\Results\Settings\ISetting;
9
10	/**
11	* Result that checks provide for a report.
12	*/
13	class Result implements IResult
14	{
15	/**
16	* Check this result belongs to.
17	*
18	* @var ICheck check instance
19	*/
20	protected $check;
21
22	/**
23	* Messages from the check.
24	*
25	* @var array of IMessage instances
26	*/
27	protected $messages = array();
28
29	/**
30	* Settings from the check.
31	*
32	* @var array of ISetting instances
33	*/
34	protected $settings = array();
35
36	/**
37	* Settings from the check that should be available from cache on re-execution of the check.
38	*
39	* @var array of ISetting instances
40	*/
41	protected $cachable_settings = array();
42
43	/**
44	* Status of the result. See available constants on IResult.
45	*
46	* @var string status of this result
47	*/
48	protected $status = self::UNEXECUTED;
49
50	/**
51	* Create a new Result instance.
52	*/
53	public function __construct()
54	{
55	$this->check = null;
56	$this->messages = array();
57	$this->settings = array();
58	$this->cachable_settings = array();
59	$this->status = self::UNEXECUTED;
60	}
61
62	/**
63	* Adds the given message to the internal list of messages.
64	*
65	* @param \Environaut\Report\Results\Messages\IMessage $message
66	*
67	* @return Result this instance for fluent API support
68	*/
69	public function addMessage(IMessage $message)
70	{
71	$this->messages[] = $message;
72	return $this;
73	}
74
75	/**
76	* Adds the given setting to the internal lists of settings.
77	*
78	* @param ISetting $setting setting to add to internal lists of settings
79	* @param bool $cachable whether or not the setting may be put into a cache for reuse on re-execution of the check
80	*
81	* @return Result this instance for fluent API support
82	*/
83	public function addSetting(ISetting $setting, $cachable = true)
84	{
85	$this->settings[] = $setting;
86
87	if (true === $cachable) {
88	$this->cachable_settings[] = $setting;
89	}
90
91	return $this;
92	}
93
94	/**
95	* Adds the given setting to the internal list of settings.
96	*
97	* @param array $settings array with ISetting implementing instances to add
98	* @param bool $cachable whether or not the setting may be put into a cache for reuse on re-execution of the check
99	*
100	* @return Result this instance for fluent API support
101	*/
102	public function addSettings(array $settings, $cachable = true)
103	{
104	foreach ($settings as $setting) {
105	if ($setting instanceof ISetting) {
106	$this->addSetting($setting);
107	}
108	}
109
110	return $this;
111	}
112
113	/**
114	* Replaces the internal list of messages with the given list.
115	*
116	* @param array $messages array with IMessage implementing instances
117	*
118	* @return Result this instance for fluent API support
119	*/
120	public function setMessages(array $messages)
121	{
122	$this->messages = $messages;
123
124	return $this;
125	}
126
127	/**
128	* Returns the internal list of messages emitted by the processed check.
129	*
130	* @return array of IMessage implementing instances
131	*/
132	public function getMessages()
133	{
134	return $this->messages;
135	}
136
137	/**
138	* Returns the internal list of settings emitted by the processed check.
139	*
140	* @param string $groups group names of settings to return
141	* @param integer $flag flag value the settings should belong to
142	*
143	* @return array of ISetting implementing instances matching the arguments
144	*/
145	public function getSettings($groups = null, $flag = null)
146	{
147	return $this->getFiltered($this->settings, $groups, $flag);
148	}
149
150	/**
151	* Returns the internal list of cachable settings emitted by the processed check.
152	*
153	* @param string $groups group names of settings to return
154	* @param integer $flag flag value the settings should belong to
155	*
156	* @return array of ISetting implementing instances matching the arguments
157	*/
158	public function getCachableSettings($groups = null, $flag = null)
159	{
160	return $this->getFiltered($this->cachable_settings, $groups, $flag);
161	}
162
163	/**
164	* Return all settings or the settings of the specified groups as an array.
165	*
166	* @param string $groups group names of settings to return
167	* @param integer $flag flag value the settings should belong to
168	*
169	* @return array all settings (for the specified groups); empty array if groups don't exist.
170	*/
171	public function getSettingsAsArray($groups = null, $flag = null)
172	{
173	return $this->getFilteredAsArray($this->settings, $groups, $flag);
174	}
175
176	/**
177	* Return all cachable settings or the cachable settings of the specified groups as an array.
178	*
179	* @param string $groups group names of cachable settings to return
180	* @param integer $flag flag value the settings should belong to
181	*
182	* @return array all cachable settings (for the specified groups); empty array if groups don't exist.
183	*/
184	public function getCachableSettingsAsArray($groups = null, $flag = null)
185	{
186	return $this->getFilteredAsArray($this->cachable_settings, $groups, $flag);
187	}
188
189	/**
190	* Sets the status of the current result (which may be of interest for the later export and cache writing).
191	*
192	* @param string $status one of the constants from IResult (like IResult::SUCCESS or IResult::FAIL)
193	*
194	* @return Result this instance for fluent API support
195	*/
196	public function setStatus($status = self::INVALID)
197	{
198	$this->status = $status;
199
200	return $this;
201	}
202
203	/**
204	* Returns the current status of this result (usually one of the IResult::SUCCESS or IResult::FAIL constants).
205	*
206	* @return string status of this result instance
207	*/
208	public function getStatus()
209	{
210	return $this->status;
211	}
212
213	/**
214	* Sets the check instance this result belongs to.
215	*
216	* @param \Environaut\Checks\ICheck $check check this result belongs to
217	*
218	* @return Result this instance for fluent API support
219	*/
220	public function setCheck(ICheck $check)
221	{
222	$this->check = $check;
223
224	return $this;
225	}
226
227	/**
228	* Returns the check instance this result belongs to.
229	*
230	* @return \Environaut\Checks\ICheck check instance this result belongs to
231	*/
232	public function getCheck()
233	{
234	return $this->check;
235	}
236
237	/**
238	* Returns all settings from the given array that match the groups and flag.
239	*
240	* @param array $all_settings array of ISetting implementing classes
241	* @param string $groups group names of settings to return
242	* @param integer $flag flag value the settings should belong to
243	*
244	* @return array of entries from all_settings that match the given groups and flag
245	*/
246	protected function getFiltered(array $all_settings = array(), $groups = null, $flag = null)
247	{
248	$settings = array();
249
250	foreach ($all_settings as $setting) {
251	if ($setting->matchesGroup($groups) && $setting->matchesFlag($flag)) {
252	$settings[] = $setting;
253	}
254	}
255
256	return $settings;
257	}
258
259	/**
260	* Returns all or just the matching settings of the given groups as an associative array.
261	*
262	* @param array $all_settings array of ISetting implementing setting instances
263	* @param string $group name of group to filter given settings for
264	* @param integer $flag flag value the setting must be matching
265	*
266	* @return array with associative arrays (for each setting)
267	*/
268	protected function getFilteredAsArray(array $all_settings, $groups = null, $flag = null)
269	{
270	$settings = array();
271
272	foreach ($all_settings as $setting) {
273	if ($setting->matchesGroup($groups) && $setting->matchesFlag($flag)) {
274	$settings[] = $setting->toArray();
275	}
276	}
277
278	return $settings;
279	}
280	}