Code Coverage
	Classes and Traits			Functions and Methods				Lines
Total							CRAP

1	<?php
2
3	namespace Environaut\Report;
4
5	use Environaut\Report\Results\IResult;
6	use Environaut\Config\Parameters;
7
8	/**
9	* Interface all reports must implement.
10	*/
11	interface IReport
12	{
13	/**
14	* Adds the specified result to the report.
15	*
16	* @param IResult $result
17	*/
18	public function addResult(IResult $result);
19
20	/**
21	* Runtime parameters to configure the report behaviour.
22	*
23	* @param Parameters $parameters runtime parameters to use
24	*/
25	public function setParameters(Parameters $parameters);
26
27	/**
28	* Sets the given results on this report.
29	*
30	* @param array $results array of IResult instances
31	*/
32	public function setResults(array $results);
33
34	/**
35	* Returns all results currently compiled
36	* for the report.
37	*
38	* @return array of IResult instances
39	*/
40	public function getResults();
41
42	/**
43	* Returns an array of ISetting instances that match the given criterias from the results of this report.
44	*
45	* @param mixed $groups string or array of group names settings should match, the default null matches always
46	* @param integer $flag type of settings to get
47	*
48	* @return array of ISetting instances
49	*/
50	public function getSettings($groups = null, $flag = null);
51
52	/**
53	* Returns an array of associative arrays for each ISetting instance
54	* that matches the given criterias (from the results of this report).
55	*
56	* @param mixed $groups string or array of group names settings should match, the default null matches always
57	* @param integer $flag type of settings to get
58	*
59	* @return array of associative arrays for each ISetting instance that matched
60	*/
61	public function getSettingsAsArray($groups = null, $flag = null);
62
63	/**
64	* Returns an array of cachable ISetting instances that match the given criterias from the results of this report.
65	*
66	* @param mixed $groups string or array of group names settings should match, the default null matches always
67	* @param integer $flag type of settings to get
68	*
69	* @return array of ISetting instances
70	*/
71	public function getCachableSettings($groups = null, $flag = null);
72
73	/**
74	* Returns an array of associative arrays for each cachable ISetting instance
75	* that matches the given criterias (from the results of this report).
76	*
77	* @param mixed $groups string or array of group names settings should match, the default null matches always
78	* @param integer $flag type of settings to get
79	*
80	* @return array of associative arrays for each ISetting instance that matched
81	*/
82	public function getCachableSettingsAsArray($groups = null, $flag = null);
83	}