Code Coverage
	Classes and Traits			Functions and Methods				Lines
Total							CRAP

1	<?php
2
3	namespace Environaut\Export\Formatter;
4
5	use Environaut\Config\Parameters;
6	use Environaut\Report\IReport;
7
8	/**
9	* Interface that report formatters must implement.
10	*/
11	interface IReportFormatter
12	{
13	/**
14	* This method takes the given report and then does something with it. This may include
15	* writing the settings and messages to different files or send them somewhere.
16	*
17	* It may return strings that will be output to the console afterwards. The return
18	* messages may be formatted with tags understood by the Symfony Console Component.
19	*
20	* @param \Environaut\Report\IReport $report
21	*
22	* @return string console messages to be displayed
23	*/
24	public function format(IReport $report);
25
26	/**
27	* Sets the given runtime parameters on the formatter.
28	*
29	* @param Parameters $parameters options understood by the formatter
30	*/
31	public function setParameters(Parameters $parameters);
32	}