GenericCacheAdapter::mergeAttributesRecursive() - Code Metrics - Inspection of "Add LocalCacheAdapter implementation for maximum p..." - techdivision/import - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — 11.x (#154)

by Tim

created 2019-06-24 16:52 UTC

GenericCacheAdapter::mergeAttributesRecursive() A

↳ Parent: Project

Complexity

Conditions	3
Paths	3

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	12

Importance

Changes

Metric	Value
dl	0
loc	23
c	0
b	0
f	0
ccs	0
cts	17
cp	0
rs	9.552
cc	3
nc	3
nop	2
crap	12

<?php

/**
 * TechDivision\Import\Cache\GenericCacheAdapter
 *
 * NOTICE OF LICENSE
 *
 * This source file is subject to the Open Software License (OSL 3.0)
 * that is available through the world-wide-web at this URL:
 * http://opensource.org/licenses/osl-3.0.php
 *
 * PHP version 5
 *
 * @author    Tim Wagner <[email protected]>
 * @copyright 2019 TechDivision GmbH <[email protected]>
 * @license   http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link      https://github.com/techdivision/import
 * @link      http://www.techdivision.com
 */

namespace TechDivision\Import\Cache;

use Psr\Cache\CacheItemPoolInterface;
use TechDivision\Import\Utils\CacheKeys;
use TechDivision\Import\Utils\CacheKeyUtilInterface;

/**
 * Generic cache adapter that wrappes any PSR-6 compatible cache implementation and can be
 * used in a distributed environment.
 *
 * If you're searching for a maximum performance consider using the LocalCacheAdapter
 * implementation.
 *
 * ATTENTION: Please be aware, that this cache adapter is NOT multiprocess or -threadsafe!
 *
 * @author    Tim Wagner <[email protected]>
 * @copyright 2019 TechDivision GmbH <[email protected]>
 * @license   http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link      https://github.com/techdivision/import
 * @link      http://www.techdivision.com
 * @see       \TechDivision\Import\Cache\LocalCacheAdapter
 */
class GenericCacheAdapter implements CacheAdapterInterface
{

    /**
     * Trait that provides custom cache adapter functionality.
     *
     * @var TechDivision\Import\Cache\CacheAdapterTrait
     */
    use CacheAdapterTrait;

    /**
     * The cache for the query results.
     *
     * @var \Psr\Cache\CacheItemPoolInterface
     */
    protected $cache;

    /**
     * The cache key utility instance.
     *
     * @var \TechDivision\Import\Utils\CacheKeyUtilInterface
     */
    protected $cacheKeyUtil;

    /**
     * Initialize the cache handler with the passed cache and configuration instances.
     * .
     * @param \Psr\Cache\CacheItemPoolInterface                $cache        The cache instance
     * @param \TechDivision\Import\Utils\CacheKeyUtilInterface $cacheKeyUtil The cache key utility instance
     */
    public function __construct(
        CacheItemPoolInterface $cache,
        CacheKeyUtilInterface $cacheKeyUtil
    ) {

        // set the cache and the cache key utility instance
        $this->cache = $cache;
        $this->cacheKeyUtil = $cacheKeyUtil;
    }

    /**
     * Resolve's the cache key.
     *
     * @param string $from The cache key to resolve
     *
     * @return string The resolved reference
     */
    protected function resolveReference($from)
    {

        // try to load the load the references
        if ($this->cache->hasItem(CacheKeys::REFERENCES)) {
            // load the array with references from the cache
            $references = $this->cache->getItem(CacheKeys::REFERENCES)->get();

            // query whether a reference is available
            if (isset($references[$from])) {
                return $references[$from];
            }
        }

        // return the passed reference
        return $from;
    }

    /**
     * Creates a unique cache key from the passed data.
     *
     * @param mixed $data The date to create the cache key from
     *
     * @return string The generated cache key
     */
    public function cacheKey($data)
    {
        return $this->cacheKeyUtil->cacheKey($data);
    }

    /**
     * Query whether or not a cache value for the passed cache key is available.
     *
     * @param string $key The cache key to query for
     *
     * @return boolean TRUE if the a value is available, else FALSE
     */
    public function isCached($key)
    {

        // query whether or not the item has been cached, and if yes if the cache is valid
        if ($this->cache->hasItem($resolvedKey = $this->resolveReference($this->cacheKey($key)))) {
            return $this->cache->getItem($resolvedKey)->isHit();
        }

        // return FALSE in all other cases
        return false;
    }

    /**
     * Inversion of the isCached() method.
     *
     * @param string $key The cache key to query for
     *
     * @return boolean TRUE if the value is not available, else FALSE
     */
    public function notCached($key)
    {
        return !$this->isCached($key);
    }

    /**
     * Add's a cache reference from one key to another.
     *
     * @param string $from The key to reference from
     * @param string $to   The key to reference to
     *
     * @return void
     */
    public function addReference($from, $to)
    {

        // initialize the array with references
        $references = array();

        // try to load the references from the cache
        if ($this->isCached(CacheKeys::REFERENCES)) {
            $references = $this->fromCache(CacheKeys::REFERENCES);
        }

        // add the reference to the array
        $references[$this->cacheKey($from)] = $this->cacheKey($to);

        // add the references back to the cache
        $this->toCache(CacheKeys::REFERENCES, $references);
    }

    /**
     * Add the passed item to the cache.
     *
     * @param string  $key        The cache key to use
     * @param mixed   $value      The value that has to be cached
     * @param array   $references An array with references to add
     * @param array   $tags       An array with tags to add
     * @param boolean $override   Flag that allows to override an exising cache entry
     * @param integer $time       The TTL in seconds for the passed item
     *
     * @return void
     */
    public function toCache($key, $value, array $references = array(), array $tags = array(), $override = false, $time = null)
    {

        // create the unique cache key
        $uniqueKey = $this->cacheKey($key);

        // query whether or not the key has already been used
        if ($this->isCached($uniqueKey) && $override === false) {
            throw new \Exception(
                sprintf(
                    'Try to override data with key "%s"',
                    $uniqueKey
                )
            );
        }

        // prepend the tags with the cache key
        array_walk($tags, function (&$tag) {
            $tag = $this->cacheKey($tag);
        });

        // initialize the cache item
        $cacheItem = $this->cache->getItem($uniqueKey);
        $cacheItem->set($value)->expiresAfter($time)->setTags($tags);

        // set the attribute in the registry
        $this->cache->save($cacheItem);

        // also register the references if given
        foreach ($references as $from => $to) {
            $this->addReference($from, $to);
        }
    }

    /**
     * Returns a new cache item for the passed key
     *
     * @param string $key The cache key to return the item for
     *
     * @return mixed The value for the passed key
     */
    public function fromCache($key)
    {
        return $this->cache->getItem($this->resolveReference($this->cacheKey($key)))->get();
    }

    /**
     * Flush the cache and remove the references.
     *
     * @return void
     */
    public function flushCache()
    {
        $this->cache->clear();
    }

    /**
     * Invalidate the cache entries for the passed tags.
     *
     * @param array $tags The tags to invalidate the cache for
     *
     * @return void
     */
    public function invalidateTags(array $tags)
    {

        // prepend the tags with the cache key
        array_walk($tags, function (&$tag) {
            $tag = $this->cacheKey($tag);
        });

        // query whether or not references are available
        if ($this->isCached(CacheKeys::REFERENCES)) {
            // load the array with references from the cache
            $references = $this->fromCache(CacheKeys::REFERENCES);

            // remove all the references of items that has one of the passed tags
            foreach ($tags as $tag) {
                foreach ($references as $from => $to) {
                    // load the cache item for the referenced key
                    $cacheItem = $this->cache->getItem($to);
                    // query whether or not the cache item has the tag, if yes remove the reference
                    if (in_array($tag, $cacheItem->getPreviousTags())) {
                        unset($references[$from]);
                    }
                }
            }

            // query whether or not the references exists
            if (sizeof($references) > 0) {
                // set the array with references to the cache
                $this->toCache(CacheKeys::REFERENCES, $references);
            } else {
                $this->removeCache(CacheKeys::REFERENCES);
            }
        }

        // finally, invalidate the items with the passed tags
        $this->cache->invalidateTags($tags);
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
    }

    /**
     * Remove the item with the passed key and all its references from the cache.
     *
     * @param string $key The key of the cache item to Remove
     *
     * @return void
     */
    public function removeCache($key)
    {

        // delete the item with the passed key
        $this->cache->deleteItem($this->resolveReference($uniqueKey = $this->cacheKey($key)));

        // query whether or not references are available
        if ($this->isCached(CacheKeys::REFERENCES)) {
            // load the array with references from the cache
            $references = $this->fromCache(CacheKeys::REFERENCES);
            // query whether or not the references exists
            if (isset($references[$uniqueKey])) {
                // remove the reference
                unset($references[$uniqueKey]);
                // set the array with references to the cache
                $this->toCache(CacheKeys::REFERENCES, $references);
            }
        }
    }
}


1			<?php
2
3			/**
4			* TechDivision\Import\Cache\GenericCacheAdapter
5			*
6			* NOTICE OF LICENSE
7			*
8			* This source file is subject to the Open Software License (OSL 3.0)
9			* that is available through the world-wide-web at this URL:
10			* http://opensource.org/licenses/osl-3.0.php
11			*
12			* PHP version 5
13			*
14			* @author Tim Wagner <[email protected]>
15			* @copyright 2019 TechDivision GmbH <[email protected]>
16			* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
17			* @link https://github.com/techdivision/import
18			* @link http://www.techdivision.com
19			*/
20
21			namespace TechDivision\Import\Cache;
22
23			use Psr\Cache\CacheItemPoolInterface;
24			use TechDivision\Import\Utils\CacheKeys;
25			use TechDivision\Import\Utils\CacheKeyUtilInterface;
26
27			/**
28			* Generic cache adapter that wrappes any PSR-6 compatible cache implementation and can be
29			* used in a distributed environment.
30			*
31			* If you're searching for a maximum performance consider using the LocalCacheAdapter
32			* implementation.
33			*
34			* ATTENTION: Please be aware, that this cache adapter is NOT multiprocess or -threadsafe!
35			*
36			* @author Tim Wagner <[email protected]>
37			* @copyright 2019 TechDivision GmbH <[email protected]>
38			* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
39			* @link https://github.com/techdivision/import
40			* @link http://www.techdivision.com
41			* @see \TechDivision\Import\Cache\LocalCacheAdapter
42			*/
43			class GenericCacheAdapter implements CacheAdapterInterface
44			{
45
46			/**
47			* Trait that provides custom cache adapter functionality.
48			*
49			* @var TechDivision\Import\Cache\CacheAdapterTrait
50			*/
51			use CacheAdapterTrait;
52
53			/**
54			* The cache for the query results.
55			*
56			* @var \Psr\Cache\CacheItemPoolInterface
57			*/
58			protected $cache;
59
60			/**
61			* The cache key utility instance.
62			*
63			* @var \TechDivision\Import\Utils\CacheKeyUtilInterface
64			*/
65			protected $cacheKeyUtil;
66
67			/**
68			* Initialize the cache handler with the passed cache and configuration instances.
69			* .
70			* @param \Psr\Cache\CacheItemPoolInterface $cache The cache instance
71			* @param \TechDivision\Import\Utils\CacheKeyUtilInterface $cacheKeyUtil The cache key utility instance
72			*/
73			public function __construct(
74			CacheItemPoolInterface $cache,
75			CacheKeyUtilInterface $cacheKeyUtil
76			) {
77
78			// set the cache and the cache key utility instance
79			$this->cache = $cache;
80			$this->cacheKeyUtil = $cacheKeyUtil;
81			}
82
83			/**
84			* Resolve's the cache key.
85			*
86			* @param string $from The cache key to resolve
87			*
88			* @return string The resolved reference
89			*/
90			protected function resolveReference($from)
91			{
92
93			// try to load the load the references
94			if ($this->cache->hasItem(CacheKeys::REFERENCES)) {
95			// load the array with references from the cache
96			$references = $this->cache->getItem(CacheKeys::REFERENCES)->get();
97
98			// query whether a reference is available
99			if (isset($references[$from])) {
100			return $references[$from];
101			}
102			}
103
104			// return the passed reference
105			return $from;
106			}
107
108			/**
109			* Creates a unique cache key from the passed data.
110			*
111			* @param mixed $data The date to create the cache key from
112			*
113			* @return string The generated cache key
114			*/
115			public function cacheKey($data)
116			{
117			return $this->cacheKeyUtil->cacheKey($data);
118			}
119
120			/**
121			* Query whether or not a cache value for the passed cache key is available.
122			*
123			* @param string $key The cache key to query for
124			*
125			* @return boolean TRUE if the a value is available, else FALSE
126			*/
127			public function isCached($key)
128			{
129
130			// query whether or not the item has been cached, and if yes if the cache is valid
131			if ($this->cache->hasItem($resolvedKey = $this->resolveReference($this->cacheKey($key)))) {
132			return $this->cache->getItem($resolvedKey)->isHit();
133			}
134
135			// return FALSE in all other cases
136			return false;
137			}
138
139			/**
140			* Inversion of the isCached() method.
141			*
142			* @param string $key The cache key to query for
143			*
144			* @return boolean TRUE if the value is not available, else FALSE
145			*/
146			public function notCached($key)
147			{
148			return !$this->isCached($key);
149			}
150
151			/**
152			* Add's a cache reference from one key to another.
153			*
154			* @param string $from The key to reference from
155			* @param string $to The key to reference to
156			*
157			* @return void
158			*/
159			public function addReference($from, $to)
160			{
161
162			// initialize the array with references
163			$references = array();
164
165			// try to load the references from the cache
166			if ($this->isCached(CacheKeys::REFERENCES)) {
167			$references = $this->fromCache(CacheKeys::REFERENCES);
168			}
169
170			// add the reference to the array
171			$references[$this->cacheKey($from)] = $this->cacheKey($to);
172
173			// add the references back to the cache
174			$this->toCache(CacheKeys::REFERENCES, $references);
175			}
176
177			/**
178			* Add the passed item to the cache.
179			*
180			* @param string $key The cache key to use
181			* @param mixed $value The value that has to be cached
182			* @param array $references An array with references to add
183			* @param array $tags An array with tags to add
184			* @param boolean $override Flag that allows to override an exising cache entry
185			* @param integer $time The TTL in seconds for the passed item
186			*
187			* @return void
188			*/
189			public function toCache($key, $value, array $references = array(), array $tags = array(), $override = false, $time = null)
190			{
191
192			// create the unique cache key
193			$uniqueKey = $this->cacheKey($key);
194
195			// query whether or not the key has already been used
196			if ($this->isCached($uniqueKey) && $override === false) {
197			throw new \Exception(
198			sprintf(
199			'Try to override data with key "%s"',
200			$uniqueKey
201			)
202			);
203			}
204
205			// prepend the tags with the cache key
206			array_walk($tags, function (&$tag) {
207			$tag = $this->cacheKey($tag);
208			});
209
210			// initialize the cache item
211			$cacheItem = $this->cache->getItem($uniqueKey);
212			$cacheItem->set($value)->expiresAfter($time)->setTags($tags);
213
214			// set the attribute in the registry
215			$this->cache->save($cacheItem);
216
217			// also register the references if given
218			foreach ($references as $from => $to) {
219			$this->addReference($from, $to);
220			}
221			}
222
223			/**
224			* Returns a new cache item for the passed key
225			*
226			* @param string $key The cache key to return the item for
227			*
228			* @return mixed The value for the passed key
229			*/
230			public function fromCache($key)
231			{
232			return $this->cache->getItem($this->resolveReference($this->cacheKey($key)))->get();
233			}
234
235			/**
236			* Flush the cache and remove the references.
237			*
238			* @return void
239			*/
240			public function flushCache()
241			{
242			$this->cache->clear();
243			}
244
245			/**
246			* Invalidate the cache entries for the passed tags.
247			*
248			* @param array $tags The tags to invalidate the cache for
249			*
250			* @return void
251			*/
252			public function invalidateTags(array $tags)
253			{
254
255			// prepend the tags with the cache key
256			array_walk($tags, function (&$tag) {
257			$tag = $this->cacheKey($tag);
258			});
259
260			// query whether or not references are available
261			if ($this->isCached(CacheKeys::REFERENCES)) {
262			// load the array with references from the cache
263			$references = $this->fromCache(CacheKeys::REFERENCES);
264
265			// remove all the references of items that has one of the passed tags
266			foreach ($tags as $tag) {
267			foreach ($references as $from => $to) {
268			// load the cache item for the referenced key
269			$cacheItem = $this->cache->getItem($to);
270			// query whether or not the cache item has the tag, if yes remove the reference
271			if (in_array($tag, $cacheItem->getPreviousTags())) {
272			unset($references[$from]);
273			}
274			}
275			}
276
277			// query whether or not the references exists
278			if (sizeof($references) > 0) {
279			// set the array with references to the cache
280			$this->toCache(CacheKeys::REFERENCES, $references);
281			} else {
282			$this->removeCache(CacheKeys::REFERENCES);
283			}
284			}
285
286			// finally, invalidate the items with the passed tags
287			$this->cache->invalidateTags($tags);
			0 ignored issues – show Bug introduced 2019-06-14 08:57 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Psr\Cache\CacheItemPoolInterface` as the method `invalidateTags()` does only exist in the following implementations of said interface: `Cache\Adapter\Common\AbstractCachePool`, `Cache\Adapter\PHPArray\ArrayCachePool`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
288			}
289
290			/**
291			* Remove the item with the passed key and all its references from the cache.
292			*
293			* @param string $key The key of the cache item to Remove
294			*
295			* @return void
296			*/
297			public function removeCache($key)
298			{
299
300			// delete the item with the passed key
301			$this->cache->deleteItem($this->resolveReference($uniqueKey = $this->cacheKey($key)));
302
303			// query whether or not references are available
304			if ($this->isCached(CacheKeys::REFERENCES)) {
305			// load the array with references from the cache
306			$references = $this->fromCache(CacheKeys::REFERENCES);
307			// query whether or not the references exists
308			if (isset($references[$uniqueKey])) {
309			// remove the reference
310			unset($references[$uniqueKey]);
311			// set the array with references to the cache
312			$this->toCache(CacheKeys::REFERENCES, $references);
313			}
314			}
315			}
316			}
317

techdivision / import

Pull Request — 11.x (#154)

GenericCacheAdapter::mergeAttributesRecursive() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like