Code Coverage
	Classes and Traits			Functions and Methods				Lines
Total							CRAP

1	<?php
2
3	namespace Environaut\Report\Results\Settings;
4
5	/**
6	* Interface that defines settings.
7	*/
8	interface ISetting
9	{
10	/**
11	* Flag for a normal setting.
12	*/
13	const NORMAL = 1;
14
15	/**
16	* Flag for settings that contain sensitive values (like credentials)
17	* that should perhaps handled with care and e.g. not be shown on CLI.
18	*/
19	const SENSITIVE = 2;
20
21	/**
22	* Flag for all settings
23	*/
24	const ALL = 32768;
25
26	/**
27	* Returns the name of the setting (that is, a key for the setting)
28	*
29	* @return string name of the setting
30	*/
31	public function getName();
32
33	/**
34	* Returns the value of the setting.
35	*
36	* @return mixed value of the setting
37	*/
38	public function getValue();
39
40	/**
41	* Returns the group name of this setting that may be useful to group/namespaace settings.
42	*
43	* @return string group name
44	*/
45	public function getGroup();
46
47	/**
48	* Returns an associative array with the group containing an array with name and value of the setting.
49	*
50	* @return array representation of this setting
51	*/
52	public function toArray();
53	}