Driver::getConfig() - Code Metrics - Inspection of "Merge branch 'v9.1' into v9" - PHPSocialNetwork/phpfastcache - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — v9 ( 467cbb...1836cb )

by Georges

created 2022-04-03 22:27 UTC

Driver::getConfig() A

↳ Parent: Project

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	1
nc	1
nop	0
dl	0
loc	3
rs	10
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 and LICENCE files.
 *
 * @author Georges.L (Geolim4)  <[email protected]>
 * @author Contributors  https://github.com/PHPSocialNetwork/phpfastcache/graphs/contributors
 */

declare(strict_types=1);

namespace Phpfastcache\Drivers\Memcache;

use DateTime;
use Exception;
use Memcache as MemcacheSoftware;
use Phpfastcache\Cluster\AggregatablePoolInterface;
use Phpfastcache\Config\ConfigurationOption;
use Phpfastcache\Core\Pool\ExtendedCacheItemPoolInterface;
use Phpfastcache\Core\Pool\TaggableCacheItemPoolTrait;
use Phpfastcache\Core\Item\ExtendedCacheItemInterface;
use Phpfastcache\Entities\DriverStatistic;
use Phpfastcache\Event\EventManagerInterface;
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 Phpfastcache\Util\MemcacheDriverCollisionDetectorTrait;

/**
 * @property MemcacheSoftware $instance
 * @method Config getConfig()
 */
class Driver implements ExtendedCacheItemPoolInterface, AggregatablePoolInterface
{
    use TaggableCacheItemPoolTrait {
        __construct as protected __parentConstruct;
    }
    use MemcacheDriverCollisionDetectorTrait;

    protected int $memcacheFlags = 0;

    /**
     * Driver constructor.
     * @param ConfigurationOption $config
     * @param string $instanceId
     * @param EventManagerInterface $em
     * @throws PhpfastcacheDriverConnectException
     * @throws PhpfastcacheInvalidArgumentException
     * @throws PhpfastcacheCoreException
     * @throws PhpfastcacheDriverCheckException
     * @throws PhpfastcacheIOException
     */
    public function __construct(ConfigurationOption $config, string $instanceId, EventManagerInterface $em)
    {
        self::checkCollision('Memcache');
        $this->__parentConstruct($config, $instanceId, $em);
    }

    /**
     * @return bool
     */
    public function driverCheck(): bool
    {
        return class_exists('Memcache');
    }

    /**
     * @return DriverStatistic
     */
    public function getStats(): DriverStatistic
    {
        $stats = (array)$this->instance->getstats();
        $stats['uptime'] = (isset($stats['uptime']) ? $stats['uptime'] : 0);
        $stats['version'] = (isset($stats['version']) ? $stats['version'] : 'UnknownVersion');
        $stats['bytes'] = (isset($stats['bytes']) ? $stats['version'] : 0);

        $date = (new DateTime())->setTimestamp(time() - $stats['uptime']);

        return (new DriverStatistic())
            ->setData(implode(', ', array_keys($this->itemInstances)))
            ->setInfo(sprintf("The memcache daemon v%s is up since %s.\n For more information see RawData.", $stats['version'], $date->format(DATE_RFC2822)))
            ->setRawData($stats)
            ->setSize((int)$stats['bytes']);
    }

    /**
     * @return bool
     * @throws PhpfastcacheDriverException
     */
    protected function driverConnect(): bool
    {
        $this->instance = new MemcacheSoftware();

        foreach ($this->getConfig()->getServers() as $server) {
            try {
                /**
                 * If path is provided we consider it as a UNIX Socket
                 */
                if (!empty($server['path'])) {
                    $this->instance->addServer($server['path'], 0);
                } elseif (!empty($server['host'])) {
                    $this->instance->addServer($server['host'], $server['port']);
                }

                if (!empty($server['saslUser']) && !empty($server['saslPassword'])) {
                    throw new PhpfastcacheDriverException('Unlike Memcached, Memcache does not support SASL authentication');
                }
            } catch (Exception $e) {
                throw new PhpfastcacheDriverConnectException(
                    sprintf(
                        'Failed to connect to memcache host/path "%s" with the following error: %s',
                        $server['host'] ?: $server['path'],
                        $e->getMessage()
                    )
                );
            }

            /**
             * Since Memcached does not throw
             * any error if not connected ...
             */
            if (
                !$this->instance->getServerStatus(
                    !empty($server['path']) ? $server['path'] : $server['host'],
                    !empty($server['port']) ? $server['port'] : 0
                )
            ) {
                throw new PhpfastcacheDriverException('Memcache seems to not be connected');
            }
        }

        return true;
    }

    /**
     * @param ExtendedCacheItemInterface $item
     * @return null|array
     */
    protected function driverRead(ExtendedCacheItemInterface $item): ?array
    {
        $val = $this->instance->get($item->getKey());

        if ($val === false) {
            return null;
        }

        return $val;

    }

    /**
     * @param ExtendedCacheItemInterface $item
     * @return mixed
     * @throws PhpfastcacheInvalidArgumentException
     * @throws PhpfastcacheLogicException
     */
    protected function driverWrite(ExtendedCacheItemInterface $item): bool
    {
        $this->assertCacheItemType($item, Item::class);

        $ttl = $item->getExpirationDate()->getTimestamp() - time();

        // Memcache will only allow an expiration timer less than 2592000 seconds,
        // otherwise, it will assume you're giving it a UNIX timestamp.
        if ($ttl > 2592000) {
            $ttl = time() + $ttl;
        }
        return $this->instance->set($item->getKey(), $this->driverPreWrap($item), $this->memcacheFlags, $ttl);
    }

    /**
     * @param ExtendedCacheItemInterface $item
     * @return bool
     * @throws PhpfastcacheInvalidArgumentException
     */
    protected function driverDelete(ExtendedCacheItemInterface $item): bool
    {
        $this->assertCacheItemType($item, Item::class);

        return $this->instance->delete($item->getKey());
    }

    /**
     * @return bool
     */
    protected function driverClear(): bool
    {
        return $this->instance->flush();
    }
}


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 and LICENCE files.
10			*
11			* @author Georges.L (Geolim4) <[email protected]>
12			* @author Contributors https://github.com/PHPSocialNetwork/phpfastcache/graphs/contributors
13			*/
14
15			declare(strict_types=1);
16
17			namespace Phpfastcache\Drivers\Memcache;
18
19			use DateTime;
20			use Exception;
21			use Memcache as MemcacheSoftware;
22			use Phpfastcache\Cluster\AggregatablePoolInterface;
23			use Phpfastcache\Config\ConfigurationOption;
24			use Phpfastcache\Core\Pool\ExtendedCacheItemPoolInterface;
25			use Phpfastcache\Core\Pool\TaggableCacheItemPoolTrait;
26			use Phpfastcache\Core\Item\ExtendedCacheItemInterface;
27			use Phpfastcache\Entities\DriverStatistic;
28			use Phpfastcache\Event\EventManagerInterface;
29			use Phpfastcache\Exceptions\PhpfastcacheCoreException;
30			use Phpfastcache\Exceptions\PhpfastcacheDriverCheckException;
31			use Phpfastcache\Exceptions\PhpfastcacheDriverConnectException;
32			use Phpfastcache\Exceptions\PhpfastcacheDriverException;
33			use Phpfastcache\Exceptions\PhpfastcacheInvalidArgumentException;
34			use Phpfastcache\Exceptions\PhpfastcacheIOException;
35			use Phpfastcache\Exceptions\PhpfastcacheLogicException;
36			use Phpfastcache\Util\MemcacheDriverCollisionDetectorTrait;
37
38			/**
39			* @property MemcacheSoftware $instance
40			* @method Config getConfig()
41			*/
42			class Driver implements ExtendedCacheItemPoolInterface, AggregatablePoolInterface
43			{
44			use TaggableCacheItemPoolTrait {
45			__construct as protected __parentConstruct;
46			}
47			use MemcacheDriverCollisionDetectorTrait;
48
49			protected int $memcacheFlags = 0;
50
51			/**
52			* Driver constructor.
53			* @param ConfigurationOption $config
54			* @param string $instanceId
55			* @param EventManagerInterface $em
56			* @throws PhpfastcacheDriverConnectException
57			* @throws PhpfastcacheInvalidArgumentException
58			* @throws PhpfastcacheCoreException
59			* @throws PhpfastcacheDriverCheckException
60			* @throws PhpfastcacheIOException
61			*/
62			public function __construct(ConfigurationOption $config, string $instanceId, EventManagerInterface $em)
63			{
64			self::checkCollision('Memcache');
65			$this->__parentConstruct($config, $instanceId, $em);
66			}
67
68			/**
69			* @return bool
70			*/
71			public function driverCheck(): bool
72			{
73			return class_exists('Memcache');
74			}
75
76			/**
77			* @return DriverStatistic
78			*/
79			public function getStats(): DriverStatistic
80			{
81			$stats = (array)$this->instance->getstats();
82			$stats['uptime'] = (isset($stats['uptime']) ? $stats['uptime'] : 0);
83			$stats['version'] = (isset($stats['version']) ? $stats['version'] : 'UnknownVersion');
84			$stats['bytes'] = (isset($stats['bytes']) ? $stats['version'] : 0);
85
86			$date = (new DateTime())->setTimestamp(time() - $stats['uptime']);
87
88			return (new DriverStatistic())
89			->setData(implode(', ', array_keys($this->itemInstances)))
90			->setInfo(sprintf("The memcache daemon v%s is up since %s.\n For more information see RawData.", $stats['version'], $date->format(DATE_RFC2822)))
91			->setRawData($stats)
92			->setSize((int)$stats['bytes']);
93			}
94
95			/**
96			* @return bool
97			* @throws PhpfastcacheDriverException
98			*/
99			protected function driverConnect(): bool
100			{
101			$this->instance = new MemcacheSoftware();
102
103			foreach ($this->getConfig()->getServers() as $server) {
104			try {
105			/**
106			* If path is provided we consider it as a UNIX Socket
107			*/
108			if (!empty($server['path'])) {
109			$this->instance->addServer($server['path'], 0);
110			} elseif (!empty($server['host'])) {
111			$this->instance->addServer($server['host'], $server['port']);
112			}
113
114			if (!empty($server['saslUser']) && !empty($server['saslPassword'])) {
115			throw new PhpfastcacheDriverException('Unlike Memcached, Memcache does not support SASL authentication');
116			}
117			} catch (Exception $e) {
118			throw new PhpfastcacheDriverConnectException(
119			sprintf(
120			'Failed to connect to memcache host/path "%s" with the following error: %s',
121			$server['host'] ?: $server['path'],
122			$e->getMessage()
123			)
124			);
125			}
126
127			/**
128			* Since Memcached does not throw
129			* any error if not connected ...
130			*/
131			if (
132			!$this->instance->getServerStatus(
133			!empty($server['path']) ? $server['path'] : $server['host'],
134			!empty($server['port']) ? $server['port'] : 0
135			)
136			) {
137			throw new PhpfastcacheDriverException('Memcache seems to not be connected');
138			}
139			}
140
141			return true;
142			}
143
144			/**
145			* @param ExtendedCacheItemInterface $item
146			* @return null\|array
147			*/
148			protected function driverRead(ExtendedCacheItemInterface $item): ?array
149			{
150			$val = $this->instance->get($item->getKey());
151
152			if ($val === false) {
153			return null;
154			}
155
156			return $val;
			0 ignored issues – show Bug Best Practice introduced 2021-09-04 20:11 UTC by Report Bug Copy Issue Report The expression `return $val` could return the type `string` which is incompatible with the type-hinted return `array\|null`. Consider adding an additional type-check to rule them out. Loading history...
157			}
158
159			/**
160			* @param ExtendedCacheItemInterface $item
161			* @return mixed
162			* @throws PhpfastcacheInvalidArgumentException
163			* @throws PhpfastcacheLogicException
164			*/
165			protected function driverWrite(ExtendedCacheItemInterface $item): bool
166			{
167			$this->assertCacheItemType($item, Item::class);
168
169			$ttl = $item->getExpirationDate()->getTimestamp() - time();
170
171			// Memcache will only allow an expiration timer less than 2592000 seconds,
172			// otherwise, it will assume you're giving it a UNIX timestamp.
173			if ($ttl > 2592000) {
174			$ttl = time() + $ttl;
175			}
176			return $this->instance->set($item->getKey(), $this->driverPreWrap($item), $this->memcacheFlags, $ttl);
177			}
178
179			/**
180			* @param ExtendedCacheItemInterface $item
181			* @return bool
182			* @throws PhpfastcacheInvalidArgumentException
183			*/
184			protected function driverDelete(ExtendedCacheItemInterface $item): bool
185			{
186			$this->assertCacheItemType($item, Item::class);
187
188			return $this->instance->delete($item->getKey());
189			}
190
191			/**
192			* @return bool
193			*/
194			protected function driverClear(): bool
195			{
196			return $this->instance->flush();
197			}
198			}
199

PHPSocialNetwork / phpfastcache

Push — v9 ( 467cbb...1836cb )

Driver::getConfig() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like