Code Coverage
	Classes and Traits			Functions and Methods				Lines
Total							CRAP

1	<?php
2
3	namespace Environaut\Runner;
4
5	use Environaut\Cache\IReadOnlyCache;
6	use Environaut\Command\Command;
7	use Environaut\Config\IConfig;
8	use Environaut\Config\Parameters;
9
10	/**
11	* Interface all check running instances must implement. Runners
12	* should get the necessary data via setters, then run() should
13	* be called and the report getter used afterwards.
14	*/
15	interface IRunner
16	{
17	/**
18	* Sets the readonly cache used by checks to determine if they've been run before and
19	* if they can reuse prior settings to let users just confirm settings etc.
20	*
21	* The cache instance should've already been loaded and thus contain everything needed for the checks.
22	*
23	* @param IReadOnlyCache $cache instance that already contains all cached settings loaded for checks
24	*/
25	public function setCache(IReadOnlyCache $cache);
26
27	/**
28	* Sets the given config on the runner.
29	*
30	* @param IConfig $config config data
31	*/
32	public function setConfig(IConfig $config);
33
34	/**
35	* Sets the command on the runner to have access to the input and output.
36	*
37	* @param Command $command
38	*/
39	public function setCommand(Command $command);
40
41	/**
42	* Sets the given runtime parameter on the runner.
43	*
44	* @param Parameters $parameters runtime options understood by the runner
45	*/
46	public function setParameters(Parameters $parameters);
47
48	/**
49	* Execute the checks that are defined in the config and generate a report to consume by others.
50	*/
51	public function run();
52
53	/**
54	* @return IReport report created by the runner
55	*/
56	public function getReport();
57	}