Code Coverage
	Classes and Traits			Functions and Methods				Lines
Total							CRAP

1	<?php
2
3	namespace Environaut\Cache;
4
5	use Environaut\Config\Parameters;
6
7	interface IReadOnlyCache
8	{
9	/**
10	* Sets the given location as the cache location to use.
11	*
12	* @param string $location cache file path
13	*
14	* @throws \InvalidArgumentException if location is not readable
15	*/
16	public function setLocation($location);
17
18	/**
19	* Returns the location currently set on the cache.
20	*
21	* @return string cache file location currently configured
22	*/
23	public function getLocation();
24
25	/**
26	* Runtime parameters to configure the cache operations.
27	*
28	* @param Parameters $parameters runtime parameters
29	*/
30	public function setParameters(Parameters $parameters);
31
32	/**
33	* Loads the settings from the configured or default location.
34	*
35	* @throws \InvalidArgumentException on invalid cache location (non-readable, non-existant etc.)
36	*/
37	public function load();
38
39	/**
40	* Returns the first setting from the loaded cache that matches the given criterias.
41	*
42	* @param string $name key of wanted setting
43	* @param mixed $groups group name of setting, default is null and matches always
44	* @param integer $flag setting type to match, default is null and matches always
45	*
46	* @return \Environaut\Report\Results\Settings\ISetting|null matching setting
47	*/
48	public function get($name, $groups = null, $flag = null);
49
50	/**
51	* Returns whether a cached value for a setting from the loaded cache exists, that matches the given criterias.
52	*
53	* @param string $name key of wanted setting
54	* @param mixed $groups group name of setting, default is null and matches always
55	* @param integer $flag setting type to match, default is null and matches always
56	*
57	* @return boolean true if value for that setting is in cache; false otherwise
58	*/
59	public function has($name, $groups = null, $flag = null);
60
61	/**
62	* Returns an array of settings matching the given criterias.
63	*
64	* @param mixed $groups name of a group or array of group names or null for all settings regardless of group
65	* @param type $flag only return settings that match the given flag value
66	*
67	* @return array of ISetting instances matching the specification
68	*/
69	public function getAll($groups = null, $flag = null);
70	}