Code Coverage for /home/graste/projects/environaut/src/Environaut/Cache/ReadOnlyCache.php

	Code Coverage
	Classes and Traits			Functions and Methods				Lines
Total		0.00%	0 / 1		10.00%	1 / 10	CRAP		10.14%	7 / 69
ReadOnlyCache		0.00%	0 / 1		10.00%	1 / 10	823.05		10.14%	7 / 69
__construct()					100.00%	1 / 1	1		100.00%	4 / 4
has($name, $groups = null, $flag = null)					0.00%	0 / 1	6.60		60.00%	3 / 5
get($name, $groups = null, $flag = null)					0.00%	0 / 1	30		0.00%	0 / 6
getAll($groups = null, $flag = null)					0.00%	0 / 1	72		0.00%	0 / 15
load()					0.00%	0 / 1	56		0.00%	0 / 25
setLocation($location)					0.00%	0 / 1	6		0.00%	0 / 4
getLocation()					0.00%	0 / 1	2		0.00%	0 / 1
setParameters(Parameters $parameters)					0.00%	0 / 1	2		0.00%	0 / 2
getDefaultLocation()					0.00%	0 / 1	2		0.00%	0 / 2
getCurrentWorkingDirectory()					0.00%	0 / 1	6		0.00%	0 / 5

1	<?php
2
3	namespace Environaut\Cache;
4
5	use Environaut\Cache\IReadOnlyCache;
6	use Environaut\Config\Parameters;
7	use Environaut\Report\Results\Settings\Setting;
8
9	class ReadOnlyCache implements IReadOnlyCache
10	{
11	const DEFAULT_PATH = './';
12	const DEFAULT_NAME = '.environaut';
13	const DEFAULT_EXTENSION = '.cache';
14
15	/**
16	* @var string location of the cache file
17	*/
18	protected $location = null;
19
20	/**
21	* @var Parameters runtime parameters
22	*/
23	protected $parameters;
24
25	/**
26	* @var array of ISetting implementing settings
27	*/
28	protected $settings = array();
29
30	public function __construct()
31	{
32	$this->location = null;
33	$this->parameters = new Parameters();
34	$this->settings = array();
35	}
36
37	/**
38	* Returns whether a cached value for a setting from the loaded cache exists, that matches the given criterias.
39	*
40	* @param string $name key of wanted setting
41	* @param mixed $groups group name of setting, default is null and matches always
42	* @param integer $flag setting type to match, default is null and matches always
43	*
44	* @return boolean true if value for that setting is in cache; false otherwise
45	*/
46	public function has($name, $groups = null, $flag = null)
47	{
48	foreach ($this->settings as $setting) {
49	if (($setting->getName() === $name) && $setting->matchesGroup($groups) && $setting->matchesFlag($flag)) {
50	return true;
51	}
52	}
53
54	return false;
55	}
56
57	/**
58	* Returns the first setting from the loaded cache that matches the given criterias.
59	*
60	* @param string $name key of wanted setting
61	* @param mixed $groups group name of setting, default is null and matches always
62	* @param integer $flag setting type to match, default is null and matches always
63	*
64	* @return ISetting\|null matching setting
65	*/
66	public function get($name, $groups = null, $flag = null)
67	{
68	$found = null;
69
70	foreach ($this->settings as $setting) {
71	if (($setting->getName() === $name) && $setting->matchesGroup($groups) && $setting->matchesFlag($flag)) {
72	return $setting;
73	}
74	}
75
76	return $found;
77	}
78
79	/**
80	* Returns an array of settings matching the given criterias.
81	*
82	* @param mixed $groups name of a group or array of group names or null for all settings regardless of group
83	* @param type $flag only return settings that match the given flag value
84	*
85	* @return array of setting instances matching the specification
86	*
87	* @throws \InvalidArgumentException if $groups is neither null nor a string or an array
88	*/
89	public function getAll($groups = null, $flag = null)
90	{
91	$settings = array();
92
93	if (null === $groups) {
94	foreach ($this->settings as $setting) {
95	$settings[] = $setting;
96	}
97	} elseif (is_string($groups) \|\| is_array($groups)) {
98	foreach ($this->settings as $setting) {
99	if ($setting->matchesGroup($groups) && $setting->matchesFlag($flag)) {
100	$settings[] = $setting;
101	}
102	}
103	} else {
104	throw new \InvalidArgumentException(
105	'Only a null value, a single string as group name or an array of group names are supported.'
106	);
107	}
108
109	return $settings;
110	}
111
112	/**
113	* Loads the settings from the configured or default location.
114	*
115	* @return boolean true, if reading from cache succeeded; false otherwise.
116	*
117	* @throws \InvalidArgumentException on invalid or broken cache file
118	*/
119	public function load()
120	{
121	$location = $this->location;
122
123	// no location given from commandline -> use config values or fallback to default location
124	if (empty($location)) {
125	$location = $this->parameters->get(
126	'read_location',
127	$this->parameters->get(
128	'location',
129	$this->getDefaultLocation()
130	)
131	);
132	}
133
134	$this->location = $location;
135
136	if (!is_readable($location) \|\| !is_file($location)) {
137	return false;
138	}
139
140	$content = file_get_contents($location);
141
142	if (false === $content) {
143	return false;
144	}
145
146	$result = json_decode($content, true);
147
148	if (null === $result) {
149	throw new \InvalidArgumentException('Cache could not be decoded from file: ' . $location);
150	}
151
152	$items = array();
153	foreach ($result as $setting) {
154	$items[] = new Setting($setting['name'], $setting['value'], $setting['group'], $setting['flag']);
155	}
156
157	$this->settings = $items;
158
159	return true;
160	}
161
162	/**
163	* Sets the given location as the cache location to use.
164	*
165	* @param string $location cache file path
166	*
167	* @return ReadOnlyCache this instance for fluent API support
168	*
169	* @throws \InvalidArgumentException if location is not readable
170	*/
171	public function setLocation($location)
172	{
173	if (!is_readable($location)) {
174	throw new \InvalidArgumentException('Given cache location "' . $location . '" is not readable.');
175	}
176
177	$this->location = $location;
178
179	return $this;
180	}
181
182	/**
183	* Returns the location currently set on the cache.
184	*
185	* @return string cache file location currently configured
186	*/
187	public function getLocation()
188	{
189	return $this->location;
190	}
191
192	/**
193	* Runtime parameters to configure the cache operations.
194	*
195	* @param Parameters $parameters runtime parameters
196	*
197	* @return ReadOnlyCache this instance for fluent API support
198	*/
199	public function setParameters(Parameters $parameters)
200	{
201	$this->parameters = $parameters;
202
203	return $this;
204	}
205
206	/**
207	* Returns the default location used for the cache file. Defaults to "./.environaut.cache".
208	*
209	* @return string file path and name
210	*/
211	protected function getDefaultLocation()
212	{
213	return $this->getCurrentWorkingDirectory() . DIRECTORY_SEPARATOR .
214	self::DEFAULT_PATH . self::DEFAULT_NAME . self::DEFAULT_EXTENSION;
215	}
216
217	/**
218	* @return string current working directory
219	*/
220	protected function getCurrentWorkingDirectory()
221	{
222	$dir = getcwd();
223
224	if (false === $dir) {
225	$dir = __DIR__; // fallback to folder of current class in case of strange errors
226	}
227
228	return $dir;
229	}
230	}