ClusterPoolAbstract::remapCacheItem() - Code Metrics - Inspection of "Added Firestore support + fixed some tests" - PHPSocialNetwork/phpfastcache - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — v9 ( 473b89...c87345 )

by Georges

created 2021-09-28 01:46 UTC

ClusterPoolAbstract::remapCacheItem() A

↳ Parent: ClusterPoolAbstract::getStats()

Complexity

Conditions	2
Paths	2

Size

Total Lines	12
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
eloc	9
nc	2
nop	3
dl	0
loc	12
rs	9.9666
c	0
b	0
f	0

<?php

/**
 *
 * This file is part of phpFastCache.
 *
 * @license MIT License (MIT)
 *
 * For full copyright and license information, please see the docs/CREDITS.txt file.
 *
 * @author  Georges.L (Geolim4)  <[email protected]>
 *
 */
declare(strict_types=1);

namespace Phpfastcache\Cluster;

use Phpfastcache\Cluster\Drivers\FullReplication\Driver as FullReplicationCluster;
use Phpfastcache\Cluster\Drivers\MasterSlaveReplication\Driver as MasterSlaveReplicationCluster;
use Phpfastcache\Cluster\Drivers\RandomReplication\Driver as RandomReplicationCluster;
use Phpfastcache\Cluster\Drivers\SemiReplication\Driver as SemiReplicationCluster;
use Phpfastcache\Config\ConfigurationOption;
use Phpfastcache\Core\Item\ExtendedCacheItemInterface;
use Phpfastcache\Core\Pool\ExtendedCacheItemPoolInterface;
use Phpfastcache\Core\Pool\TaggableCacheItemPoolTrait;
use Phpfastcache\Entities\DriverIO;
use Phpfastcache\Entities\DriverStatistic;
use Phpfastcache\Event\EventManagerInterface;
use Phpfastcache\EventManager;
use Phpfastcache\Exceptions\PhpfastcacheCoreException;
use Phpfastcache\Exceptions\PhpfastcacheDriverCheckException;
use Phpfastcache\Exceptions\PhpfastcacheDriverConnectException;
use Phpfastcache\Exceptions\PhpfastcacheDriverException;
use Phpfastcache\Exceptions\PhpfastcacheInvalidArgumentException;
use Phpfastcache\Exceptions\PhpfastcacheIOException;
use Phpfastcache\Exceptions\PhpfastcacheLogicException;
use Psr\Cache\CacheItemInterface;
use Psr\Cache\InvalidArgumentException;

/**
 * @property ConfigurationOption $config
 */
abstract class ClusterPoolAbstract implements ClusterPoolInterface
{
    use TaggableCacheItemPoolTrait;
    use ClusterPoolTrait {
        TaggableCacheItemPoolTrait::__construct as private __parentConstruct;
    }

    public const STRATEGY = [
        AggregatorInterface::STRATEGY_FULL_REPLICATION => FullReplicationCluster::class,
        AggregatorInterface::STRATEGY_SEMI_REPLICATION => SemiReplicationCluster::class,
        AggregatorInterface::STRATEGY_MASTER_SLAVE => MasterSlaveReplicationCluster::class,
        AggregatorInterface::STRATEGY_RANDOM_REPLICATION => RandomReplicationCluster::class,
    ];

    /**
     * @var ExtendedCacheItemPoolInterface[]
     */
    protected array $clusterPools;

    /**
     * ClusterPoolAbstract constructor.
     * @param string $clusterName
     * @param EventManagerInterface $em
     * @param ExtendedCacheItemPoolInterface ...$driverPools
     * @throws PhpfastcacheDriverCheckException
     * @throws PhpfastcacheDriverConnectException
     * @throws PhpfastcacheInvalidArgumentException
     * @throws PhpfastcacheCoreException
     * @throws PhpfastcacheDriverException
     * @throws PhpfastcacheIOException
     */
    public function __construct(string $clusterName, EventManagerInterface $em, ExtendedCacheItemPoolInterface ...$driverPools)
    {
        if (count($driverPools) < 2) {
            throw new PhpfastcacheInvalidArgumentException('A cluster requires at least two pools to be working.');
        }
        $this->clusterPools = $driverPools;
        $this->__parentConstruct(new ConfigurationOption(), $clusterName, $em);
        $this->setEventManager(EventManager::getInstance());
    }

    /**
     * @inheritDoc
     */
    public function getIO(): DriverIO
    {
        $io = new DriverIO();
        foreach ($this->clusterPools as $clusterPool) {
            $io->setReadHit($io->getReadHit() + $clusterPool->getIO()->getReadHit())
                ->setReadMiss($io->getReadMiss() + $clusterPool->getIO()->getReadMiss())
                ->setWriteHit($io->getWriteHit() + $clusterPool->getIO()->getWriteHit());
        }
        return $io;
    }

    /**
     * @inheritDoc
     */
    public function getClusterPools(): array
    {
        return $this->clusterPools;
    }

    /**
     * @inheritDoc
     */
    public function getConfigs() : array
    {
        $configs = [];

        foreach ($this->getClusterPools() as $clusterPool) {
            $configs[$clusterPool->getDriverName()] = $clusterPool->getConfig();
        }

        return $configs;
    }

    /**
     * @inheritDoc
     */
    public function getItems(array $keys = []): iterable
    {
        $items = [];

        foreach ($keys as $key) {
            $items[$key] = $this->getItem($key);
        }

        return $items;
    }
    /**
     * Shared method used by All Clusters
     */

    /**
     * @inheritDoc
     */
    public function deleteItems(array $keys): bool
    {
        $hasDeletedOnce = false;
        foreach ($this->clusterPools as $driverPool) {
            if ($result = $driverPool->deleteItems($keys)) {
                $hasDeletedOnce = $result;
            }
        }
        // Return true only if at least one backend confirmed the "clear" operation
        return $hasDeletedOnce;
    }

    /**
     * @param CacheItemInterface $item
     * @return bool
     * @throws InvalidArgumentException
     * @throws PhpfastcacheLogicException
     */
    public function saveDeferred(CacheItemInterface $item): bool
    {
        /** @var ExtendedCacheItemInterface $item */
        $hasSavedOnce = false;
        foreach ($this->clusterPools as $driverPool) {
            $poolItem = $this->getStandardizedItem($item, $driverPool);
            if ($result = $driverPool->saveDeferred($poolItem)) {
                $hasSavedOnce = $result;
            }
        }
        // Return true only if at least one backend confirmed the "commit" operation
        return $hasSavedOnce;
    }

    /**
     * @param ExtendedCacheItemInterface $item
     * @param ExtendedCacheItemPoolInterface $driverPool
     * @return ExtendedCacheItemInterface
     * @throws InvalidArgumentException
     * @throws PhpfastcacheLogicException
     */
    protected function getStandardizedItem(ExtendedCacheItemInterface $item, ExtendedCacheItemPoolInterface $driverPool): ExtendedCacheItemInterface
    {
        if (!$item->doesItemBelongToThatDriverBackend($driverPool)) {
            /**
             * Avoid infinite loop
             */
            if ($driverPool === $this) {

                /** @var ExtendedCacheItemInterface $itemPool */
                $itemClass = $driverPool->getItemClass();
                $itemPool = new $itemClass($this, $item->getKey(), $this->getEventManager());
                $item->cloneInto($itemPool, $driverPool);

                return $itemPool;
            }

            $itemPool = $driverPool->getItem($item->getKey());
            $item->cloneInto($itemPool, $driverPool);

            return $itemPool;
        }

        return $item->setEventManager($this->getEventManager());
    }

    /**
     * @return DriverStatistic
     */
    public function getStats(): DriverStatistic
    {
        $stats = new DriverStatistic();
        $stats->setInfo(
            sprintf(
                'Using %d pool(s): %s',
                \count($this->clusterPools),
                \implode(
                    ', ',
                    \array_map(
                        static fn (ExtendedCacheItemPoolInterface $pool) => \get_class($pool),
                        $this->clusterPools
                    )
                )
            )
        );

        $stats->setSize(
            (int)\array_sum(
                \array_map(
                    static fn (ExtendedCacheItemPoolInterface $pool) => $pool->getStats()->getSize(),
                    $this->clusterPools
                )
            )
        );

        $stats->setData(
            \implode(
                ', ',
                \array_map(
                    static fn (ExtendedCacheItemPoolInterface $pool) => $pool->getStats()->getData(),
                    $this->clusterPools
                )
            )
        );

        return $stats;
    }

    public function getConfig() : ConfigurationOption
    {
        return $this->config;
    }
}


1			<?php
2
3			/**
4			*
5			* This file is part of phpFastCache.
6			*
7			* @license MIT License (MIT)
8			*
9			* For full copyright and license information, please see the docs/CREDITS.txt file.
10			*
11			* @author Georges.L (Geolim4) <[email protected]>
12			*
13			*/
14			declare(strict_types=1);
15
16			namespace Phpfastcache\Cluster;
17
18			use Phpfastcache\Cluster\Drivers\FullReplication\Driver as FullReplicationCluster;
19			use Phpfastcache\Cluster\Drivers\MasterSlaveReplication\Driver as MasterSlaveReplicationCluster;
20			use Phpfastcache\Cluster\Drivers\RandomReplication\Driver as RandomReplicationCluster;
21			use Phpfastcache\Cluster\Drivers\SemiReplication\Driver as SemiReplicationCluster;
22			use Phpfastcache\Config\ConfigurationOption;
23			use Phpfastcache\Core\Item\ExtendedCacheItemInterface;
24			use Phpfastcache\Core\Pool\ExtendedCacheItemPoolInterface;
25			use Phpfastcache\Core\Pool\TaggableCacheItemPoolTrait;
26			use Phpfastcache\Entities\DriverIO;
27			use Phpfastcache\Entities\DriverStatistic;
28			use Phpfastcache\Event\EventManagerInterface;
29			use Phpfastcache\EventManager;
30			use Phpfastcache\Exceptions\PhpfastcacheCoreException;
31			use Phpfastcache\Exceptions\PhpfastcacheDriverCheckException;
32			use Phpfastcache\Exceptions\PhpfastcacheDriverConnectException;
33			use Phpfastcache\Exceptions\PhpfastcacheDriverException;
34			use Phpfastcache\Exceptions\PhpfastcacheInvalidArgumentException;
35			use Phpfastcache\Exceptions\PhpfastcacheIOException;
36			use Phpfastcache\Exceptions\PhpfastcacheLogicException;
37			use Psr\Cache\CacheItemInterface;
38			use Psr\Cache\InvalidArgumentException;
39
40			/**
41			* @property ConfigurationOption $config
42			*/
43			abstract class ClusterPoolAbstract implements ClusterPoolInterface
44			{
45			use TaggableCacheItemPoolTrait;
46			use ClusterPoolTrait {
47			TaggableCacheItemPoolTrait::__construct as private __parentConstruct;
48			}
49
50			public const STRATEGY = [
51			AggregatorInterface::STRATEGY_FULL_REPLICATION => FullReplicationCluster::class,
52			AggregatorInterface::STRATEGY_SEMI_REPLICATION => SemiReplicationCluster::class,
53			AggregatorInterface::STRATEGY_MASTER_SLAVE => MasterSlaveReplicationCluster::class,
54			AggregatorInterface::STRATEGY_RANDOM_REPLICATION => RandomReplicationCluster::class,
55			];
56
57			/**
58			* @var ExtendedCacheItemPoolInterface[]
59			*/
60			protected array $clusterPools;
61
62			/**
63			* ClusterPoolAbstract constructor.
64			* @param string $clusterName
65			* @param EventManagerInterface $em
66			* @param ExtendedCacheItemPoolInterface ...$driverPools
67			* @throws PhpfastcacheDriverCheckException
68			* @throws PhpfastcacheDriverConnectException
69			* @throws PhpfastcacheInvalidArgumentException
70			* @throws PhpfastcacheCoreException
71			* @throws PhpfastcacheDriverException
72			* @throws PhpfastcacheIOException
73			*/
74			public function __construct(string $clusterName, EventManagerInterface $em, ExtendedCacheItemPoolInterface ...$driverPools)
75			{
76			if (count($driverPools) < 2) {
77			throw new PhpfastcacheInvalidArgumentException('A cluster requires at least two pools to be working.');
78			}
79			$this->clusterPools = $driverPools;
80			$this->__parentConstruct(new ConfigurationOption(), $clusterName, $em);
81			$this->setEventManager(EventManager::getInstance());
82			}
83
84			/**
85			* @inheritDoc
86			*/
87			public function getIO(): DriverIO
88			{
89			$io = new DriverIO();
90			foreach ($this->clusterPools as $clusterPool) {
91			$io->setReadHit($io->getReadHit() + $clusterPool->getIO()->getReadHit())
92			->setReadMiss($io->getReadMiss() + $clusterPool->getIO()->getReadMiss())
93			->setWriteHit($io->getWriteHit() + $clusterPool->getIO()->getWriteHit());
94			}
95			return $io;
96			}
97
98			/**
99			* @inheritDoc
100			*/
101			public function getClusterPools(): array
102			{
103			return $this->clusterPools;
104			}
105
106			/**
107			* @inheritDoc
108			*/
109			public function getConfigs() : array
110			{
111			$configs = [];
112
113			foreach ($this->getClusterPools() as $clusterPool) {
114			$configs[$clusterPool->getDriverName()] = $clusterPool->getConfig();
115			}
116
117			return $configs;
118			}
119
120			/**
121			* @inheritDoc
122			*/
123			public function getItems(array $keys = []): iterable
124			{
125			$items = [];
126
127			foreach ($keys as $key) {
128			$items[$key] = $this->getItem($key);
129			}
130
131			return $items;
132			}
133			/**
134			* Shared method used by All Clusters
135			*/
136
137			/**
138			* @inheritDoc
139			*/
140			public function deleteItems(array $keys): bool
141			{
142			$hasDeletedOnce = false;
143			foreach ($this->clusterPools as $driverPool) {
144			if ($result = $driverPool->deleteItems($keys)) {
145			$hasDeletedOnce = $result;
146			}
147			}
148			// Return true only if at least one backend confirmed the "clear" operation
149			return $hasDeletedOnce;
150			}
151
152			/**
153			* @param CacheItemInterface $item
154			* @return bool
155			* @throws InvalidArgumentException
156			* @throws PhpfastcacheLogicException
157			*/
158			public function saveDeferred(CacheItemInterface $item): bool
159			{
160			/** @var ExtendedCacheItemInterface $item */
161			$hasSavedOnce = false;
162			foreach ($this->clusterPools as $driverPool) {
163			$poolItem = $this->getStandardizedItem($item, $driverPool);
164			if ($result = $driverPool->saveDeferred($poolItem)) {
165			$hasSavedOnce = $result;
166			}
167			}
168			// Return true only if at least one backend confirmed the "commit" operation
169			return $hasSavedOnce;
170			}
171
172			/**
173			* @param ExtendedCacheItemInterface $item
174			* @param ExtendedCacheItemPoolInterface $driverPool
175			* @return ExtendedCacheItemInterface
176			* @throws InvalidArgumentException
177			* @throws PhpfastcacheLogicException
178			*/
179			protected function getStandardizedItem(ExtendedCacheItemInterface $item, ExtendedCacheItemPoolInterface $driverPool): ExtendedCacheItemInterface
180			{
181			if (!$item->doesItemBelongToThatDriverBackend($driverPool)) {
182			/**
183			* Avoid infinite loop
184			*/
185			if ($driverPool === $this) {
			0 ignored issues – show introduced 2020-03-22 22:49 UTC by Report Bug Copy Issue Report The condition `$driverPool === $this` is always `false`. Loading history...
186			/** @var ExtendedCacheItemInterface $itemPool */
187			$itemClass = $driverPool->getItemClass();
188			$itemPool = new $itemClass($this, $item->getKey(), $this->getEventManager());
189			$item->cloneInto($itemPool, $driverPool);
190
191			return $itemPool;
192			}
193
194			$itemPool = $driverPool->getItem($item->getKey());
195			$item->cloneInto($itemPool, $driverPool);
196
197			return $itemPool;
198			}
199
200			return $item->setEventManager($this->getEventManager());
201			}
202
203			/**
204			* @return DriverStatistic
205			*/
206			public function getStats(): DriverStatistic
207			{
208			$stats = new DriverStatistic();
209			$stats->setInfo(
210			sprintf(
211			'Using %d pool(s): %s',
212			\count($this->clusterPools),
213			\implode(
214			', ',
215			\array_map(
216			static fn (ExtendedCacheItemPoolInterface $pool) => \get_class($pool),
217			$this->clusterPools
218			)
219			)
220			)
221			);
222
223			$stats->setSize(
224			(int)\array_sum(
225			\array_map(
226			static fn (ExtendedCacheItemPoolInterface $pool) => $pool->getStats()->getSize(),
227			$this->clusterPools
228			)
229			)
230			);
231
232			$stats->setData(
233			\implode(
234			', ',
235			\array_map(
236			static fn (ExtendedCacheItemPoolInterface $pool) => $pool->getStats()->getData(),
237			$this->clusterPools
238			)
239			)
240			);
241
242			return $stats;
243			}
244
245			public function getConfig() : ConfigurationOption
246			{
247			return $this->config;
248			}
249			}
250

PHPSocialNetwork / phpfastcache

Push — v9 ( 473b89...c87345 )

ClusterPoolAbstract::remapCacheItem() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like