MemCached::namespacedKey() - Code Metrics - Inspection of "Added support to memcached" - nielsenmg/ezcache - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#2)

by William Johnson S.

created 2016-10-30 17:16 UTC

MemCached::namespacedKey() A

↳ Parent: MemCached

Complexity

Conditions	2
Paths	2

Size

Total Lines	8
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	8
rs	9.4285
c	0
b	0
f	0
cc	2
eloc	4
nc	2
nop	1

<?php

namespace Ezcache\Cache;

/**
 * @codeCoverageIgnore
 * @author: William Johnson dos Santos Okano <[email protected]>
 */
class MemCached implements CacheInterface
{
    /** @var string */
    private $namespace;

    /** @var int */
    private $ttl;

    /** @var \Memcached */
    private $memcachedInstance;

    /**
     * MemCached constructor.
     *
     * @param \Memcached $memcached the memcached instance
     * @param int        $ttl       the cache lifetime in seconds (0 = Forever)
     * @param string     $namespace the cache namespace
     */
    public function __construct(\Memcached $memcached, $ttl = 0, string $namespace = null)
    {
        $this->ttl = $ttl;
        $this->memcachedInstance = $memcached;
        if ($namespace !== null) {
            $this->setNamespace($namespace);
        }
    }

    /**
     * Set the cache namespace.
     *
     * @param string $namespace the cache namespace
     *
     * @return bool true on success or false on failure
     */
    public function setNamespace(string $namespace) : bool
    {
        $this->namespace = $namespace;

        return true;
    }

    /**
     * Set a value to a key on cache.
     *
     * @param string   $key   the key to be set.
     * @param mixed    $value the correspondent value of that cache key.
     * @param int|null $ttl   the cache life time in seconds (If no value passed will use the default value).
     *
     * @return bool true on success or false on failure.
     */
    public function set(string $key, $value, int $ttl = null) : bool

    {
        $ttl = $ttl ?? $this->ttl;
        $key = $this->namespacedKey($key);

        return $this->memcachedInstance->set($key, $value, $ttl);
    }

    /**
     * Return the valid cache value stored with the given key.
     *
     * @param string $key the cache key to be found.
     *
     * @return mixed the data found.
     */
    public function get(string $key)

    {
        $key = $this->namespacedKey($key);
        $value = $this->memcachedInstance->get($key);
        if ($this->exists($key)) {
            return $value;
        }
    }

    /**
     * Delete cache especified by key.
     *
     * @param string $key the cache key to be deleted.
     *
     * @return bool true on success or false on failure.
     */
    public function delete(string $key) : bool
    {
        $key = $this->namespacedKey($key);

        return $this->memcachedInstance->delete($key);
    }

    /**
     * Check if given key exists and is valid on cache.
     *
     * @param string $key     the cache key to be verified.
     * @param bool   $isValid if set to true the function will verify if it is valid (not expired).
     *
     * @return bool true if exists false otherwise.
     */
    public function exists(string $key, bool $isValid = false) : bool
    {
        $this->memcachedInstance->get($key);

        return $this->memcachedInstance->getResultCode() !== \Memcached::RES_NOTFOUND;
    }

    /**
     * Renew the cache expiration time.
     *
     * @param string   $key the cache key to be renewed.
     * @param int|null $ttl extra time to live in seconds.
     *
     * @return bool true on success or false on failure.
     */
    public function renew(string $key, int $ttl) : bool
    {
        $key = $this->namespacedKey($key);
        $ttl = $ttl ?? $this->ttl;
        if ($this->exists($key)) {
            return $this->memcachedInstance->touch($key, $ttl);
        }
        return false;
    }

    /**
     * Clear all cache records.If namespace set, just clear those that starts with the namespace.
     *
     * @param string|null $namespace the cache namespace.
     *
     * @return bool true on success or false on failure.
     */
    public function clear(string $namespace = null) : bool
    {
        $namespace = $namespace ?? $this->namespace;
        if ($namespace === null) {
            return $this->memcachedInstance->flush();
        }

        // Find all keys, iterate and them delete the only ones that starts with the namespace
        $cacheKeys = $this->memcachedInstance->getAllKeys();
        $filteredCacheKeys = array_filter($cacheKeys, function ($key) use ($namespace) {
            return strpos($key, $namespace) === 0;
        });

        array_walk($filteredCacheKeys, [$this, 'delete']);

        return true;
    }

    /**
     * Return the key with the namespace. Since Memcached doesn't support namespaces
     * the method just simulate it by pre-pending some fixed string to the key.
     *
     * @param string $key the key to prepend the namespace, if necessary
     *
     * @return string the "namespaced" key
     */
    private function namespacedKey(string $key) : string
    {
        if ($this->namespace !== null) {
            return $this->namespace.$key;
        }

        return $key;
    }
}


1		<?php
2
3		namespace Ezcache\Cache;
4
5		/**
6		* @codeCoverageIgnore
7		* @author: William Johnson dos Santos Okano <[email protected]>
8		*/
9		class MemCached implements CacheInterface
10		{
11		/** @var string */
12		private $namespace;
13
14		/** @var int */
15		private $ttl;
16
17		/** @var \Memcached */
18		private $memcachedInstance;
19
20		/**
21		* MemCached constructor.
22		*
23		* @param \Memcached $memcached the memcached instance
24		* @param int $ttl the cache lifetime in seconds (0 = Forever)
25		* @param string $namespace the cache namespace
26		*/
27		public function __construct(\Memcached $memcached, $ttl = 0, string $namespace = null)
28		{
29		$this->ttl = $ttl;
30		$this->memcachedInstance = $memcached;
31		if ($namespace !== null) {
32		$this->setNamespace($namespace);
33		}
34		}
35
36		/**
37		* Set the cache namespace.
38		*
39		* @param string $namespace the cache namespace
40		*
41		* @return bool true on success or false on failure
42		*/
43		public function setNamespace(string $namespace) : bool
44		{
45		$this->namespace = $namespace;
46
47		return true;
48		}
49
50		/**
51		* Set a value to a key on cache.
52		*
53		* @param string $key the key to be set.
54		* @param mixed $value the correspondent value of that cache key.
55		* @param int\|null $ttl the cache life time in seconds (If no value passed will use the default value).
56		*
57		* @return bool true on success or false on failure.
58		*/
59	View Code Duplication	public function set(string $key, $value, int $ttl = null) : bool
		1 ignored issue – show Duplication introduced 2016-10-30 17:18 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
60		{
61		$ttl = $ttl ?? $this->ttl;
62		$key = $this->namespacedKey($key);
63
64		return $this->memcachedInstance->set($key, $value, $ttl);
65		}
66
67		/**
68		* Return the valid cache value stored with the given key.
69		*
70		* @param string $key the cache key to be found.
71		*
72		* @return mixed the data found.
73		*/
74	View Code Duplication	public function get(string $key)
		1 ignored issue – show Duplication introduced 2016-10-30 17:18 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
75		{
76		$key = $this->namespacedKey($key);
77		$value = $this->memcachedInstance->get($key);
78		if ($this->exists($key)) {
79		return $value;
80		}
81		}
82
83		/**
84		* Delete cache especified by key.
85		*
86		* @param string $key the cache key to be deleted.
87		*
88		* @return bool true on success or false on failure.
89		*/
90		public function delete(string $key) : bool
91		{
92		$key = $this->namespacedKey($key);
93
94		return $this->memcachedInstance->delete($key);
95		}
96
97		/**
98		* Check if given key exists and is valid on cache.
99		*
100		* @param string $key the cache key to be verified.
101		* @param bool $isValid if set to true the function will verify if it is valid (not expired).
102		*
103		* @return bool true if exists false otherwise.
104		*/
105		public function exists(string $key, bool $isValid = false) : bool
106		{
107		$this->memcachedInstance->get($key);
108
109		return $this->memcachedInstance->getResultCode() !== \Memcached::RES_NOTFOUND;
110		}
111
112		/**
113		* Renew the cache expiration time.
114		*
115		* @param string $key the cache key to be renewed.
116		* @param int\|null $ttl extra time to live in seconds.
117		*
118		* @return bool true on success or false on failure.
119		*/
120		public function renew(string $key, int $ttl) : bool
121		{
122		$key = $this->namespacedKey($key);
123		$ttl = $ttl ?? $this->ttl;
124		if ($this->exists($key)) {
125		return $this->memcachedInstance->touch($key, $ttl);
126		}
127		return false;
128		}
129
130		/**
131		* Clear all cache records.If namespace set, just clear those that starts with the namespace.
132		*
133		* @param string\|null $namespace the cache namespace.
134		*
135		* @return bool true on success or false on failure.
136		*/
137		public function clear(string $namespace = null) : bool
138		{
139		$namespace = $namespace ?? $this->namespace;
140		if ($namespace === null) {
141		return $this->memcachedInstance->flush();
142		}
143
144		// Find all keys, iterate and them delete the only ones that starts with the namespace
145		$cacheKeys = $this->memcachedInstance->getAllKeys();
146		$filteredCacheKeys = array_filter($cacheKeys, function ($key) use ($namespace) {
147		return strpos($key, $namespace) === 0;
148		});
149
150		array_walk($filteredCacheKeys, [$this, 'delete']);
151
152		return true;
153		}
154
155		/**
156		* Return the key with the namespace. Since Memcached doesn't support namespaces
157		* the method just simulate it by pre-pending some fixed string to the key.
158		*
159		* @param string $key the key to prepend the namespace, if necessary
160		*
161		* @return string the "namespaced" key
162		*/
163		private function namespacedKey(string $key) : string
164		{
165		if ($this->namespace !== null) {
166		return $this->namespace.$key;
167		}
168
169		return $key;
170		}
171		}
172

nielsenmg / ezcache

Pull Request — master (#2)

MemCached::namespacedKey() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like