Code Coverage
	Classes and Traits			Functions and Methods				Lines
Total							CRAP

1	<?php
2
3	namespace Environaut\Config;
4
5	/**
6	* Interface all Environaut configs must implement.
7	*/
8	interface IConfig
9	{
10	/**
11	* Parameter name in a check, export or similar defintion to define the implementor to use.
12	*/
13	const PARAM_CLASS = '__class';
14
15	/**
16	* Parameter name in a check, export or similar definition to e.g. name a check.
17	*/
18	const PARAM_NAME = '__name';
19
20	/**
21	* Parameter name in a check, export or similar definition to e.g. assign a check to a group.
22	*/
23	const PARAM_GROUP = '__group';
24
25	/**
26	* @return array of parameters to create checks
27	*/
28	public function getCheckDefinitions();
29
30	/**
31	* Defaults to "Environaut\Export\Export".
32	*
33	* @return string (namespaced) class name to use for exporting a report
34	*/
35	public function getExportImplementor();
36
37	/**
38	* Defaults to "Environaut\Report\Report".
39	*
40	* @return string (namespaced) class name to use for a report
41	*/
42	public function getReportImplementor();
43
44	/**
45	* Defaults to "Environaut\Runner\Runner".
46	*
47	* @return string (namespaced) class name to use for running checks read from the config
48	*/
49	public function getRunnerImplementor();
50
51	/**
52	* Defaults to "Environaut\Cache\ReadOnlyCache".
53	*
54	* @return string (namespaced) class name to use for cache given to checks
55	*/
56	public function getReadOnlyCacheImplementor();
57
58	/**
59	* Defaults to "Environaut\Cache\Cache".
60	*
61	* @return string (namespaced) class name to use for writing cachable settings after report generation
62	*/
63	public function getCacheImplementor();
64
65	/**
66	* Returns the config value for the given key.
67	*
68	* @param string $key name of config key
69	* @param mixed $default value to return if key doesn't exist
70	*
71	* @return mixed value for that key or default given
72	*/
73	public function get($key, $default = null);
74
75	/**
76	* Returns whether the config key exists or nor.
77	*
78	* @param string $key name of config key to check
79	*
80	* @return bool true if key exists; false otherwise
81	*/
82	public function has($key);
83
84	/**
85	* Sets a given value to the config under the specified key.
86	*
87	* @param string $key name of config entry
88	* @param mixed $value value to set for the given key
89	*
90	* @return mixed the value set
91	*/
92	public function set($key, $value);
93
94	/**
95	* Returns the config data as an associative array.
96	*
97	* @return array with all config data
98	*/
99	public function toArray();
100	}