ArrayCache::getMultiple() - Code Metrics - Inspection of "Merge remote-tracking branch 'origin/refactoring'" - krowinski/php-mysql-replication - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Branch — master (e090ea)

by kacper

created 2017-07-14 09:14 UTC

ArrayCache::getMultiple() A

↳ Parent: ArrayCache

Complexity

Conditions	4
Paths	6

Size

Total Lines	11
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	20

Importance

Changes

Metric	Value
dl	0
loc	11
ccs	0
cts	8
cp	0
rs	9.2
c	0
b	0
f	0
cc	4
eloc	6
nc	6
nop	2
crap	20

<?php

namespace MySQLReplication\Cache;

use MySQLReplication\Config\Config;
use Psr\SimpleCache\CacheInterface;

/**
 * Class ArrayCache
 * @package MySQLReplication\Cache
 */
class ArrayCache implements CacheInterface
{
    /**
     * @var array
     */
    private static $tableMapCache = [];
    
    /**
     * Fetches a value from the cache.
     *
     * @param string $key The unique key of this item in the cache.
     * @param mixed $default Default value to return if the key does not exist.
     *
     * @return mixed The value of the item from the cache, or $default in case of cache miss.
     *
     * @throws \Psr\SimpleCache\InvalidArgumentException
     *   MUST be thrown if the $key string is not a legal value.
     */
    public function get($key, $default = null)
    {
        return $this->has($key) ? self::$tableMapCache[$key] : $default;
    }

    /**
     * Persists data in the cache, uniquely referenced by a key with an optional expiration TTL time.
     *
     * @param string $key The key of the item to store.
     * @param mixed $value The value of the item to store, must be serializable.
     * @param null|int|\DateInterval $ttl Optional. The TTL value of this item. If no value is sent and
     *                                     the driver supports TTL then the library may set a default value
     *                                     for it or let the driver take care of that.
     *
     * @return bool True on success and false on failure.
     *
     * @throws \Psr\SimpleCache\InvalidArgumentException
     *   MUST be thrown if the $key string is not a legal value.
     */
    public function set($key, $value, $ttl = null)
    {
        // automatically clear table cache to save memory
        if (count(self::$tableMapCache) > Config::getTableCacheSize()) {
            self::$tableMapCache = array_slice(
                self::$tableMapCache,
                ceil(Config::getTableCacheSize() / 2),
                null,
                true
            );
        }

        self::$tableMapCache[$key] = $value;

        return true;
    }

    /**
     * Delete an item from the cache by its unique key.
     *
     * @param string $key The unique cache key of the item to delete.
     *
     * @return bool True if the item was successfully removed. False if there was an error.
     *
     * @throws \Psr\SimpleCache\InvalidArgumentException
     *   MUST be thrown if the $key string is not a legal value.
     */
    public function delete($key)
    {
        unset(self::$tableMapCache[$key]);

        return true;
    }

    /**
     * Wipes clean the entire cache's keys.
     *
     * @return bool True on success and false on failure.
     */
    public function clear()
    {
        self::$tableMapCache = [];

        return true;
    }

    /**
     * Obtains multiple cache items by their unique keys.
     *
     * @param iterable $keys A list of keys that can obtained in a single operation.
     * @param mixed $default Default value to return for keys that do not exist.
     *
     * @return iterable A list of key => value pairs. Cache keys that do not exist or are stale will have $default as value.
     *
     * @throws \Psr\SimpleCache\InvalidArgumentException
     *   MUST be thrown if $keys is neither an array nor a Traversable,
     *   or if any of the $keys are not a legal value.
     */
    public function getMultiple($keys, $default = null)
    {
        $data = [];
        foreach ($keys as $key) {
            if ($this->has($key)) {
                $data[$key] = self::$tableMapCache[$key];
            }
        }

        return [] !== $data ? $data : $default;
    }

    /**
     * Persists a set of key => value pairs in the cache, with an optional TTL.
     *
     * @param iterable $values A list of key => value pairs for a multiple-set operation.
     * @param null|int|\DateInterval $ttl Optional. The TTL value of this item. If no value is sent and
     *                                      the driver supports TTL then the library may set a default value
     *                                      for it or let the driver take care of that.
     *
     * @return bool True on success and false on failure.
     *
     * @throws \Psr\SimpleCache\InvalidArgumentException
     *   MUST be thrown if $values is neither an array nor a Traversable,
     *   or if any of the $values are not a legal value.
     */
    public function setMultiple($values, $ttl = null)
    {
        foreach ($values as $key => $value) {
            $this->set($key, $value);
        }

        return true;
    }

    /**
     * Deletes multiple cache items in a single operation.
     *
     * @param iterable $keys A list of string-based keys to be deleted.
     *
     * @return bool True if the items were successfully removed. False if there was an error.
     *
     * @throws \Psr\SimpleCache\InvalidArgumentException
     *   MUST be thrown if $keys is neither an array nor a Traversable,
     *   or if any of the $keys are not a legal value.
     */
    public function deleteMultiple($keys)
    {
        foreach ($keys as $key) {
            $this->delete($key);
        }

        return true;
    }

    /**
     * Determines whether an item is present in the cache.
     *
     * NOTE: It is recommended that has() is only to be used for cache warming type purposes
     * and not to be used within your live applications operations for get/set, as this method
     * is subject to a race condition where your has() will return true and immediately after,
     * another script can remove it making the state of your app out of date.
     *
     * @param string $key The cache item key.
     *
     * @return bool
     *
     * @throws \Psr\SimpleCache\InvalidArgumentException
     *   MUST be thrown if the $key string is not a legal value.
     */
    public function has($key)
    {
        return isset(self::$tableMapCache[$key]);
    }
}

1		<?php
2
3		namespace MySQLReplication\Cache;
4
5		use MySQLReplication\Config\Config;
6		use Psr\SimpleCache\CacheInterface;
7
8		/**
9		* Class ArrayCache
10		* @package MySQLReplication\Cache
11		*/
12		class ArrayCache implements CacheInterface
13		{
14		/**
15		* @var array
16		*/
17		private static $tableMapCache = [];
18
19		/**
20		* Fetches a value from the cache.
21		*
22		* @param string $key The unique key of this item in the cache.
23		* @param mixed $default Default value to return if the key does not exist.
24		*
25		* @return mixed The value of the item from the cache, or $default in case of cache miss.
26		*
27		* @throws \Psr\SimpleCache\InvalidArgumentException
28		* MUST be thrown if the $key string is not a legal value.
29		*/
30	52	public function get($key, $default = null)
31		{
32	52	return $this->has($key) ? self::$tableMapCache[$key] : $default;
33		}
34
35		/**
36		* Persists data in the cache, uniquely referenced by a key with an optional expiration TTL time.
37		*
38		* @param string $key The key of the item to store.
39		* @param mixed $value The value of the item to store, must be serializable.
40		* @param null\|int\|\DateInterval $ttl Optional. The TTL value of this item. If no value is sent and
41		* the driver supports TTL then the library may set a default value
42		* for it or let the driver take care of that.
43		*
44		* @return bool True on success and false on failure.
45		*
46		* @throws \Psr\SimpleCache\InvalidArgumentException
47		* MUST be thrown if the $key string is not a legal value.
48		*/
49	52	public function set($key, $value, $ttl = null)
50		{
51		// automatically clear table cache to save memory
52	52	if (count(self::$tableMapCache) > Config::getTableCacheSize()) {
53		self::$tableMapCache = array_slice(
54		self::$tableMapCache,
55		ceil(Config::getTableCacheSize() / 2),
56		null,
57		true
58		);
59		}
60
61	52	self::$tableMapCache[$key] = $value;
62
63	52	return true;
64		}
65
66		/**
67		* Delete an item from the cache by its unique key.
68		*
69		* @param string $key The unique cache key of the item to delete.
70		*
71		* @return bool True if the item was successfully removed. False if there was an error.
72		*
73		* @throws \Psr\SimpleCache\InvalidArgumentException
74		* MUST be thrown if the $key string is not a legal value.
75		*/
76		public function delete($key)
77		{
78		unset(self::$tableMapCache[$key]);
79
80		return true;
81		}
82
83		/**
84		* Wipes clean the entire cache's keys.
85		*
86		* @return bool True on success and false on failure.
87		*/
88		public function clear()
89		{
90		self::$tableMapCache = [];
91
92		return true;
93		}
94
95		/**
96		* Obtains multiple cache items by their unique keys.
97		*
98		* @param iterable $keys A list of keys that can obtained in a single operation.
99		* @param mixed $default Default value to return for keys that do not exist.
100		*
101		* @return iterable A list of key => value pairs. Cache keys that do not exist or are stale will have $default as value.
102		*
103		* @throws \Psr\SimpleCache\InvalidArgumentException
104		* MUST be thrown if $keys is neither an array nor a Traversable,
105		* or if any of the $keys are not a legal value.
106		*/
107		public function getMultiple($keys, $default = null)
108		{
109		$data = [];
110		foreach ($keys as $key) {
111		if ($this->has($key)) {
112		$data[$key] = self::$tableMapCache[$key];
113		}
114		}
115
116		return [] !== $data ? $data : $default;
117		}
118
119		/**
120		* Persists a set of key => value pairs in the cache, with an optional TTL.
121		*
122		* @param iterable $values A list of key => value pairs for a multiple-set operation.
123		* @param null\|int\|\DateInterval $ttl Optional. The TTL value of this item. If no value is sent and
124		* the driver supports TTL then the library may set a default value
125		* for it or let the driver take care of that.
126		*
127		* @return bool True on success and false on failure.
128		*
129		* @throws \Psr\SimpleCache\InvalidArgumentException
130		* MUST be thrown if $values is neither an array nor a Traversable,
131		* or if any of the $values are not a legal value.
132		*/
133		public function setMultiple($values, $ttl = null)
134		{
135		foreach ($values as $key => $value) {
136		$this->set($key, $value);
137		}
138
139		return true;
140		}
141
142		/**
143		* Deletes multiple cache items in a single operation.
144		*
145		* @param iterable $keys A list of string-based keys to be deleted.
146		*
147		* @return bool True if the items were successfully removed. False if there was an error.
148		*
149		* @throws \Psr\SimpleCache\InvalidArgumentException
150		* MUST be thrown if $keys is neither an array nor a Traversable,
151		* or if any of the $keys are not a legal value.
152		*/
153		public function deleteMultiple($keys)
154		{
155		foreach ($keys as $key) {
156		$this->delete($key);
157		}
158
159		return true;
160		}
161
162		/**
163		* Determines whether an item is present in the cache.
164		*
165		* NOTE: It is recommended that has() is only to be used for cache warming type purposes
166		* and not to be used within your live applications operations for get/set, as this method
167		* is subject to a race condition where your has() will return true and immediately after,
168		* another script can remove it making the state of your app out of date.
169		*
170		* @param string $key The cache item key.
171		*
172		* @return bool
173		*
174		* @throws \Psr\SimpleCache\InvalidArgumentException
175		* MUST be thrown if the $key string is not a legal value.
176		*/
177	52	public function has($key)
178		{
179	52	return isset(self::$tableMapCache[$key]);
180		}
181		}

krowinski / php-mysql-replication

Branch — master (e090ea)

ArrayCache::getMultiple() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like