AbstractHandler::getMultipleCacheItems() - Code Metrics - Inspection of "Merge branch 'master' into inmemory-content-meta" - ezsystems/ezpublish-kernel - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — inmemory-content-meta ( 00873c...41469f )

by André

created 2019-04-16 09:32 UTC

AbstractHandler::getMultipleCacheItems() B

↳ Parent: AbstractHandler

Complexity

Conditions	8
Paths	25

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	8
nc	25
nop	5
dl	0
loc	55
rs	7.7373
c	0
b	0
f	0

How to fix Long Method

<?php

/**
 * @copyright Copyright (C) eZ Systems AS. All rights reserved.
 * @license For full copyright and license information view LICENSE file distributed with this source code.
 */
namespace eZ\Publish\Core\Persistence\Cache;

use eZ\Publish\SPI\Persistence\Handler as PersistenceHandler;
use Symfony\Component\Cache\Adapter\TagAwareAdapterInterface;

/**
 * Class AbstractHandler.
 *
 * Abstract handler for use in other Persistence Cache Handlers.
 */
abstract class AbstractHandler
{
    /**
     * @var \Symfony\Component\Cache\Adapter\TagAwareAdapterInterface
     */
    protected $cache;

    /**
     * @var \eZ\Publish\SPI\Persistence\Handler
     */
    protected $persistenceHandler;

    /**
     * @var \eZ\Publish\Core\Persistence\Cache\PersistenceLogger
     */
    protected $logger;

    /**
     * Setups current handler with everything needed.
     *
     * @param \Symfony\Component\Cache\Adapter\TagAwareAdapterInterface $cache
     * @param \eZ\Publish\SPI\Persistence\Handler $persistenceHandler
     * @param \eZ\Publish\Core\Persistence\Cache\PersistenceLogger $logger
     */
    public function __construct(
        TagAwareAdapterInterface $cache,
        PersistenceHandler $persistenceHandler,
        PersistenceLogger $logger
    ) {
        $this->cache = $cache;
        $this->persistenceHandler = $persistenceHandler;
        $this->logger = $logger;
    }

    /**
     * Helper for getting multiple cache items in one call and do the id extraction for you.
     *
     * Cache items must be stored with a key in the following format "${keyPrefix}${id}", like "ez-content-info-${id}",
     * in order for this method to be able to prefix key on id's and also extract key prefix afterwards.
     *
     * It also optionally supports a key suffixs, for use on a variable argument that affects all lookups,
     * like translations, i.e. "ez-content-${id}-${translationKey}" where $keySuffixes = [$id => "-${translationKey}"].
     *
     * @param array $ids
     * @param string $keyPrefix E.g "ez-content-"
     * @param callable $missingLoader Function for loading missing objects, gets array with missing id's as argument,
     *                                expects return value to be array with id as key. Missing items should be missing.
     * @param callable $loadedTagger Function for tagging loaded object, gets object as argument, return array of tags.
     * @param array $keySuffixes Optional, key is id as provided in $ids, and value is a key suffix e.g. "-eng-Gb"
     *
     * @return array
     */
    final protected function getMultipleCacheItems(
        array $ids,
        string $keyPrefix,
        callable $missingLoader,
        callable $loadedTagger,
        array $keySuffixes = []
    ): array {
        if (empty($ids)) {
            return [];
        }

        // Generate unique cache keys
        $cacheKeys = [];
        $cacheKeysToIdMap = [];
        foreach (\array_unique($ids) as $id) {
            $key = $keyPrefix . $id . ($keySuffixes[$id] ?? '');
            $cacheKeys[] = $key;
            $cacheKeysToIdMap[$key] = $id;
        }

        // Load cache items by cache keys (will contain hits and misses)
        $list = [];
        $cacheMisses = [];
        foreach ($this->cache->getItems($cacheKeys) as $key => $cacheItem) {
            $id = $cacheKeysToIdMap[$key];
            if ($cacheItem->isHit()) {
                $list[$id] = $cacheItem->get();
            } else {
                $cacheMisses[] = $id;
                $list[$id] = $cacheItem;
            }
        }

        // No misses, return completely cached list
        if (empty($cacheMisses)) {
            return $list;
        }

        // Load missing items, save to cache & apply to list if found
        $loadedList = $missingLoader($cacheMisses);
        foreach ($cacheMisses as $id) {
            if (isset($loadedList[$id])) {
                $this->cache->save(
                    $list[$id]
                        ->set($loadedList[$id])
                        ->tag($loadedTagger($loadedList[$id]))
                );
                $list[$id] = $loadedList[$id];
            } else {
                unset($list[$id]);
            }
        }

        return $list;
    }

    final protected function escapeForCacheKey(string $identifier)
    {
        return \str_replace(
            ['_', '/', ':', '(', ')', '@', '\\', '{', '}'],
            ['__', '_S', '_C', '_BO', '_BC', '_A', '_BS', '_CBO', '_CBC'],
            $identifier
        );
    }
}


1		<?php
2
3		/**
4		* @copyright Copyright (C) eZ Systems AS. All rights reserved.
5		* @license For full copyright and license information view LICENSE file distributed with this source code.
6		*/
7		namespace eZ\Publish\Core\Persistence\Cache;
8
9		use eZ\Publish\SPI\Persistence\Handler as PersistenceHandler;
10		use Symfony\Component\Cache\Adapter\TagAwareAdapterInterface;
11
12		/**
13		* Class AbstractHandler.
14		*
15		* Abstract handler for use in other Persistence Cache Handlers.
16		*/
17		abstract class AbstractHandler
18		{
19		/**
20		* @var \Symfony\Component\Cache\Adapter\TagAwareAdapterInterface
21		*/
22		protected $cache;
23
24		/**
25		* @var \eZ\Publish\SPI\Persistence\Handler
26		*/
27		protected $persistenceHandler;
28
29		/**
30		* @var \eZ\Publish\Core\Persistence\Cache\PersistenceLogger
31		*/
32		protected $logger;
33
34		/**
35		* Setups current handler with everything needed.
36		*
37		* @param \Symfony\Component\Cache\Adapter\TagAwareAdapterInterface $cache
38		* @param \eZ\Publish\SPI\Persistence\Handler $persistenceHandler
39		* @param \eZ\Publish\Core\Persistence\Cache\PersistenceLogger $logger
40		*/
41		public function __construct(
42		TagAwareAdapterInterface $cache,
43		PersistenceHandler $persistenceHandler,
44		PersistenceLogger $logger
45		) {
46		$this->cache = $cache;
47		$this->persistenceHandler = $persistenceHandler;
48		$this->logger = $logger;
49		}
50
51		/**
52		* Helper for getting multiple cache items in one call and do the id extraction for you.
53		*
54		* Cache items must be stored with a key in the following format "${keyPrefix}${id}", like "ez-content-info-${id}",
55		* in order for this method to be able to prefix key on id's and also extract key prefix afterwards.
56		*
57		* It also optionally supports a key suffixs, for use on a variable argument that affects all lookups,
58		* like translations, i.e. "ez-content-${id}-${translationKey}" where $keySuffixes = [$id => "-${translationKey}"].
59		*
60		* @param array $ids
61		* @param string $keyPrefix E.g "ez-content-"
62		* @param callable $missingLoader Function for loading missing objects, gets array with missing id's as argument,
63		* expects return value to be array with id as key. Missing items should be missing.
64		* @param callable $loadedTagger Function for tagging loaded object, gets object as argument, return array of tags.
65		* @param array $keySuffixes Optional, key is id as provided in $ids, and value is a key suffix e.g. "-eng-Gb"
66		*
67		* @return array
68		*/
69		final protected function getMultipleCacheItems(
70		array $ids,
71		string $keyPrefix,
72		callable $missingLoader,
73		callable $loadedTagger,
74		array $keySuffixes = []
75		): array {
76		if (empty($ids)) {
77		return [];
78		}
79
80		// Generate unique cache keys
81		$cacheKeys = [];
82		$cacheKeysToIdMap = [];
83		foreach (\array_unique($ids) as $id) {
84		$key = $keyPrefix . $id . ($keySuffixes[$id] ?? '');
85		$cacheKeys[] = $key;
86		$cacheKeysToIdMap[$key] = $id;
87		}
88
89		// Load cache items by cache keys (will contain hits and misses)
90		$list = [];
91		$cacheMisses = [];
92		foreach ($this->cache->getItems($cacheKeys) as $key => $cacheItem) {
93		$id = $cacheKeysToIdMap[$key];
94		if ($cacheItem->isHit()) {
95		$list[$id] = $cacheItem->get();
96		} else {
97		$cacheMisses[] = $id;
98		$list[$id] = $cacheItem;
99		}
100		}
101
102		// No misses, return completely cached list
103		if (empty($cacheMisses)) {
104		return $list;
105		}
106
107		// Load missing items, save to cache & apply to list if found
108		$loadedList = $missingLoader($cacheMisses);
109		foreach ($cacheMisses as $id) {
110		if (isset($loadedList[$id])) {
111		$this->cache->save(
112		$list[$id]
113		->set($loadedList[$id])
114		->tag($loadedTagger($loadedList[$id]))
115		);
116		$list[$id] = $loadedList[$id];
117		} else {
118		unset($list[$id]);
119		}
120		}
121
122		return $list;
123		}
124
125	View Code Duplication	final protected function escapeForCacheKey(string $identifier)
126		{
127		return \str_replace(
128		['_', '/', ':', '(', ')', '@', '\\', '{', '}'],
129		['__', '_S', '_C', '_BO', '_BC', '_A', '_BS', '_CBO', '_CBC'],
130		$identifier
131		);
132		}
133		}
134

ezsystems / ezpublish-kernel

Push — inmemory-content-meta ( 00873c...41469f )

AbstractHandler::getMultipleCacheItems() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like