ObjectCache::exists() - Code Metrics - Inspection of "Update CrudOrgaCest.php" - phpMv/ubiquity - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( e8f56b...3a2a94 )

by Jean-Christophe

created 2022-04-12 12:31 UTC

ObjectCache::exists() A

↳ Parent: ObjectCache

Complexity

Conditions	1
Paths	1

Size

Total Lines	2
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

Metric	Value
eloc	1
dl	0
loc	2
ccs	2
cts	2
cp	1
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	1
crap	1

<?php
namespace Ubiquity\cache\system;

use Ubiquity\utils\base\UFileSystem;
use Ubiquity\exceptions\CacheException;
use Ubiquity\cache\CacheFile;
use Ubiquity\utils\base\UArray;

/**
 * This class is responsible for storing Arrays in a PHP classe.
 * Ubiquity\cache\system$ObjectCache
 * This class is part of Ubiquity
 *
 * @author jcheron <[email protected]>
 * @version 1.0.2
 *
 */
class ObjectCache extends AbstractDataCache {

	/**
	 *
	 * @var int The file mode used when creating new cache files
	 */
	private $_fileMode;

	private $_cacheDirectory;

	/**
	 * Initializes the file cache-provider
	 *
	 * @param string $root
	 *        	absolute path to the root-folder where cache-files will be stored
	 * @param string $postfix
	 *        	Termination of file names
	 * @param array $cacheParams
	 *        	defaults to ["fileMode"=>"0755"]
	 */
	public function __construct($root, $postfix = "", $cacheParams = []) {
		parent::__construct($root, $postfix);
		$this->_cacheDirectory = \basename($root);
		$this->_fileMode = (isset($cacheParams["fileMode"])) ? $cacheParams["fileMode"] : 0755;
		if (! is_dir($root)) {
			\mkdir($root, $this->_fileMode, true);
		}
	}

	/**
	 * Check if annotation-data for the key has been stored.
	 *
	 * @param string $key
	 *        	cache key
	 * @return boolean true if data with the given key has been stored; otherwise false
	 */
	public function exists($key) {
		return file_exists($this->_getPath($key));
	}

	public function store($key, $content, $tag = null) {
		$path = $this->_getPath($key);
		$dir = pathinfo($path, PATHINFO_DIRNAME);
		if (UFileSystem::safeMkdir($dir)) {
			$content = "<?php\n" . UArray::asPhpClass($content, $this->getClassname($key), $this->getNamespace($key), true);
			if (@\file_put_contents($path, $content, LOCK_EX) === false) {
				throw new CacheException("Unable to write cache file: {$path}");
			}
			if (@\chmod($path, $this->_fileMode) === false) {
				throw new CacheException("Unable to set permissions of cache file: {$path}");
			}
		} else {
			throw new CacheException("Unable to create folder : {$dir}");
		}
	}

	protected function getCompleteClassname($key) {
		$key = \str_replace([
			'.',
			'/'
		], [
			'_',
			'\\'
		], $key);
		return "\\{$this->_cacheDirectory}\\{$key}_cache";
	}

	protected function getNamespace($key) {
		$key = \str_replace([
			'.',
			'/'
		], [
			'_',
			'\\'
		], $key);
		return $this->_cacheDirectory . '\\' . \substr($key, 0, \strrpos($key, '\\'));
	}

	protected function getClassname($key) {
		$key = \str_replace([
			'.',
			'/'
		], [
			'_',
			'\\'
		], $key);
		return \substr($key, \strrpos($key, '\\') + 1) . '_cache';
	}

	/**
	 * Fetches data stored for the given key.
	 *
	 * @param string $key
	 *        	cache key
	 * @return mixed the cached data
	 */
	public function fetch($key) {
		$class = $this->getCompleteClassname($key);
		return $class::$value;
	}

	/**
	 * return data stored for the given key.
	 *
	 * @param string $key
	 *        	cache key
	 * @return mixed the cached data
	 */
	public function file_get_contents($key) {
		return \file_get_contents($this->_getPath($key));
	}

	/**
	 * Returns the timestamp of the last cache update for the given key.
	 *
	 * @param string $key
	 *        	cache key
	 * @return int unix timestamp
	 */
	public function getTimestamp($key) {
		return \filemtime($this->_getPath($key));
	}

	/**
	 * Maps a cache-key to the absolute path of a PHP file
	 *
	 * @param string $key
	 *        	cache key
	 * @return string absolute path of the PHP file
	 */
	private function _getPath($key) {
		$key = \str_replace('.', '_', $key);
		return $this->_root . $key . '_cache.php';
	}

	/**
	 *
	 * {@inheritdoc}
	 * @see \Ubiquity\cache\system\AbstractDataCache::remove()
	 */
	public function remove($key) {
		$file = $this->_getPath($key);
		if (\file_exists($file))
			return \unlink($file);
		return false;
	}

	/**
	 *
	 * {@inheritdoc}
	 * @see \Ubiquity\cache\system\AbstractDataCache::clear()
	 */
	public function clear($matches = "") {
		$files = glob($this->_root . $matches . '*');
		foreach ($files as $file) {
			if (\is_file($file))
				\unlink($file);
		}
	}

	/**
	 *
	 * {@inheritdoc}
	 * @see \Ubiquity\cache\system\AbstractDataCache::getCacheFiles()
	 */
	public function getCacheFiles($type) {
		return CacheFile::initFromFiles($this->_root . $type, \ucfirst($type), function ($file) {
			$path = UFileSystem::relativePath(dirname($file), $this->_root);
			$file = \basename($file);
			return $path . \DS . substr($file, 0, strpos($file, $this->postfix . '.php'));
		});
	}

	/**
	 *
	 * {@inheritdoc}
	 * @see \Ubiquity\cache\system\AbstractDataCache::clearCache()
	 */
	public function clearCache($type) {
		CacheFile::delete($this->_root . \strtolower($type));
	}

	/**
	 *
	 * {@inheritdoc}
	 * @see \Ubiquity\cache\system\AbstractDataCache::getCacheInfo()
	 */
	public function getCacheInfo() {
		$result = parent::getCacheInfo();
		$result .= "\nRoot cache directory is <b>" . UFileSystem::cleanPathname($this->_root) . "</b>.";
		return $result;
	}

	/**
	 *
	 * {@inheritdoc}
	 * @see \Ubiquity\cache\system\AbstractDataCache::getEntryKey()
	 */
	public function getEntryKey($key) {
		return UFileSystem::cleanFilePathname($this->_getPath($key));
	}

	/**
	 *
	 * {@inheritdoc}
	 * @see \Ubiquity\cache\system\AbstractDataCache::setRoot()
	 */
	public function setRoot($root) {
		$this->_root = \rtrim($root, \DS) . \DS;
	}
}


1		<?php
2		namespace Ubiquity\cache\system;
3
4		use Ubiquity\utils\base\UFileSystem;
5		use Ubiquity\exceptions\CacheException;
6		use Ubiquity\cache\CacheFile;
7		use Ubiquity\utils\base\UArray;
8
9		/**
10		* This class is responsible for storing Arrays in a PHP classe.
11		* Ubiquity\cache\system$ObjectCache
12		* This class is part of Ubiquity
13		*
14		* @author jcheron <[email protected]>
15		* @version 1.0.2
16		*
17		*/
18		class ObjectCache extends AbstractDataCache {
19
20		/**
21		*
22		* @var int The file mode used when creating new cache files
23		*/
24		private $_fileMode;
25
26		private $_cacheDirectory;
27
28		/**
29		* Initializes the file cache-provider
30		*
31		* @param string $root
32		* absolute path to the root-folder where cache-files will be stored
33		* @param string $postfix
34		* Termination of file names
35		* @param array $cacheParams
36		* defaults to ["fileMode"=>"0755"]
37		*/
38	29	public function __construct($root, $postfix = "", $cacheParams = []) {
39	29	parent::__construct($root, $postfix);
40	29	$this->_cacheDirectory = \basename($root);
41	29	$this->_fileMode = (isset($cacheParams["fileMode"])) ? $cacheParams["fileMode"] : 0755;
42	29	if (! is_dir($root)) {
43		\mkdir($root, $this->_fileMode, true);
44		}
45		}
46
47		/**
48		* Check if annotation-data for the key has been stored.
49		*
50		* @param string $key
51		* cache key
52		* @return boolean true if data with the given key has been stored; otherwise false
53		*/
54	28	public function exists($key) {
55	28	return file_exists($this->_getPath($key));
56		}
57
58	28	public function store($key, $content, $tag = null) {
59	28	$path = $this->_getPath($key);
60	28	$dir = pathinfo($path, PATHINFO_DIRNAME);
61	28	if (UFileSystem::safeMkdir($dir)) {
62	28	$content = "<?php\n" . UArray::asPhpClass($content, $this->getClassname($key), $this->getNamespace($key), true);
63	28	if (@\file_put_contents($path, $content, LOCK_EX) === false) {
64		throw new CacheException("Unable to write cache file: {$path}");
65		}
66	28	if (@\chmod($path, $this->_fileMode) === false) {
67	28	throw new CacheException("Unable to set permissions of cache file: {$path}");
68		}
69		} else {
70		throw new CacheException("Unable to create folder : {$dir}");
71		}
72		}
73
74	28	protected function getCompleteClassname($key) {
75	28	$key = \str_replace([
76		'.',
77		'/'
78		], [
79	28	'_',
80		'\\'
81		], $key);
82	28	return "\\{$this->_cacheDirectory}\\{$key}_cache";
83		}
84
85	28	protected function getNamespace($key) {
86	28	$key = \str_replace([
87		'.',
88		'/'
89		], [
90	28	'_',
91		'\\'
92		], $key);
93	28	return $this->_cacheDirectory . '\\' . \substr($key, 0, \strrpos($key, '\\'));
94		}
95
96	28	protected function getClassname($key) {
97	28	$key = \str_replace([
98		'.',
99		'/'
100		], [
101	28	'_',
102		'\\'
103		], $key);
104	28	return \substr($key, \strrpos($key, '\\') + 1) . '_cache';
105		}
106
107		/**
108		* Fetches data stored for the given key.
109		*
110		* @param string $key
111		* cache key
112		* @return mixed the cached data
113		*/
114	28	public function fetch($key) {
115	28	$class = $this->getCompleteClassname($key);
116	28	return $class::$value;
117		}
118
119		/**
120		* return data stored for the given key.
121		*
122		* @param string $key
123		* cache key
124		* @return mixed the cached data
125		*/
126		public function file_get_contents($key) {
127		return \file_get_contents($this->_getPath($key));
128		}
129
130		/**
131		* Returns the timestamp of the last cache update for the given key.
132		*
133		* @param string $key
134		* cache key
135		* @return int unix timestamp
136		*/
137		public function getTimestamp($key) {
138		return \filemtime($this->_getPath($key));
139		}
140
141		/**
142		* Maps a cache-key to the absolute path of a PHP file
143		*
144		* @param string $key
145		* cache key
146		* @return string absolute path of the PHP file
147		*/
148	28	private function _getPath($key) {
149	28	$key = \str_replace('.', '_', $key);
150	28	return $this->_root . $key . '_cache.php';
151		}
152
153		/**
154		*
155		* {@inheritdoc}
156		* @see \Ubiquity\cache\system\AbstractDataCache::remove()
157		*/
158		public function remove($key) {
159		$file = $this->_getPath($key);
160		if (\file_exists($file))
161		return \unlink($file);
162		return false;
163		}
164
165		/**
166		*
167		* {@inheritdoc}
168		* @see \Ubiquity\cache\system\AbstractDataCache::clear()
169		*/
170		public function clear($matches = "") {
171		$files = glob($this->_root . $matches . '*');
172		foreach ($files as $file) {
173		if (\is_file($file))
174		\unlink($file);
175		}
176		}
177
178		/**
179		*
180		* {@inheritdoc}
181		* @see \Ubiquity\cache\system\AbstractDataCache::getCacheFiles()
182		*/
183		public function getCacheFiles($type) {
184		return CacheFile::initFromFiles($this->_root . $type, \ucfirst($type), function ($file) {
185		$path = UFileSystem::relativePath(dirname($file), $this->_root);
186		$file = \basename($file);
187		return $path . \DS . substr($file, 0, strpos($file, $this->postfix . '.php'));
188		});
189		}
190
191		/**
192		*
193		* {@inheritdoc}
194		* @see \Ubiquity\cache\system\AbstractDataCache::clearCache()
195		*/
196		public function clearCache($type) {
197		CacheFile::delete($this->_root . \strtolower($type));
198		}
199
200		/**
201		*
202		* {@inheritdoc}
203		* @see \Ubiquity\cache\system\AbstractDataCache::getCacheInfo()
204		*/
205		public function getCacheInfo() {
206		$result = parent::getCacheInfo();
207		$result .= "\nRoot cache directory is <b>" . UFileSystem::cleanPathname($this->_root) . "</b>.";
208		return $result;
209		}
210
211		/**
212		*
213		* {@inheritdoc}
214		* @see \Ubiquity\cache\system\AbstractDataCache::getEntryKey()
215		*/
216		public function getEntryKey($key) {
217		return UFileSystem::cleanFilePathname($this->_getPath($key));
218		}
219
220		/**
221		*
222		* {@inheritdoc}
223		* @see \Ubiquity\cache\system\AbstractDataCache::setRoot()
224		*/
225	29	public function setRoot($root) {
226	29	$this->_root = \rtrim($root, \DS) . \DS;
227		}
228		}
229

phpMv / ubiquity

Push — master ( e8f56b...3a2a94 )

ObjectCache::exists() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like