RedisTaggedCacheTrait::getInternalKeysPrefix() - Code Metrics - limoncello-php-dist/redis-tagged-cache - Measure and Improve Code Quality continuously with Scrutinizer

RedisTaggedCacheTrait::getInternalKeysPrefix() A
last analyzed 2019-05-28 17:53 UTC

↳ Parent: RedisTaggedCacheTrait

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	4
c	0
b	0
f	0
ccs	2
cts	2
cp	1
rs	10
cc	1
nc	1
nop	0
crap	1

<?php declare(strict_types=1);

namespace Limoncello\RedisTaggedCache;

/**
 * Copyright 2015-2019 [email protected]
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

use Limoncello\RedisTaggedCache\Exceptions\RedisTaggedCacheException;
use Limoncello\RedisTaggedCache\Scripts\RedisTaggedScripts;
use Redis;
use RuntimeException;
use function array_values;
use function assert;
use function json_encode;

/**
 * @package Limoncello\RedisTaggedCache
 */
trait RedisTaggedCacheTrait
{
    /**
     * @var Redis
     */
    private $redisInstance;

    /**
     * @var string
     */
    private $internalKeysPrefix = '_:k:';

    /**
     * @var string
     */
    private $internalTagsPrefix = '_:t:';
    /**
     * @return Redis
     */
    protected function getRedisInstance(): Redis
    {
        assert($this->redisInstance !== null, 'Redis instance should be set before usage.');

        return $this->redisInstance;
    }

    /**
     * @param Redis $redisInstance
     */
    protected function setRedisInstance(Redis $redisInstance): void
    {
        $this->redisInstance = $redisInstance;
    }

    /** @noinspection PhpDocRedundantThrowsInspection
     * @param string $key
     * @param string $value
     * @param array  $tags
     * @param int    $ttl
     *
     * @return void
     *
     * @throws RedisTaggedCacheException
     */
    public function addTaggedValue(string $key, string $value, array $tags, $ttl = 0): void
    {
        // if array keys are non-consecutive it will be encoded to object instead of an array.
        // to be on a safe side we gonna use `array_values`
        $jsonTags = json_encode(array_values($tags));
        $isOk     = $this->evalScript(
            RedisTaggedScripts::ADD_VALUE_SCRIPT_INDEX,
            [$key, $value, $jsonTags, $this->getInternalKeysPrefix(), $this->getInternalTagsPrefix(), $ttl],
            1
        );

        if ($isOk === false) {
            throw new class extends RuntimeException implements RedisTaggedCacheException
            {
            };
        }
    }

    /** @noinspection PhpDocRedundantThrowsInspection
     * @param string $key
     *
     * @return void
     *
     * @throws RedisTaggedCacheException
     */
    public function removeTaggedValue(string $key): void

    {
        $isOk = $this->evalScript(
            RedisTaggedScripts::REMOVE_VALUE_SCRIPT_INDEX,
            [$key, $this->getInternalKeysPrefix(), $this->getInternalTagsPrefix()],
            1
        );

        if ($isOk === false) {
            throw new class extends RuntimeException implements RedisTaggedCacheException
            {
            };
        }
    }

    /** @noinspection PhpDocRedundantThrowsInspection
     * @param string $tag
     *
     * @return void
     *
     * @throws RedisTaggedCacheException
     */
    public function invalidateTag(string $tag): void

    {
        $isOk = $this->evalScript(
            RedisTaggedScripts::INVALIDATE_TAG_SCRIPT_INDEX,
            [$tag, $this->getInternalKeysPrefix(), $this->getInternalTagsPrefix()],
            1
        );

        if ($isOk === false) {
            throw new class extends RuntimeException implements RedisTaggedCacheException
            {
            };
        }
    }

    /**
     * @param int   $scriptIndex
     * @param array $arguments
     * @param int   $keysInArgs
     *
     * @return bool
     *
     * @SuppressWarnings(PHPMD.StaticAccess)
     */
    protected function evalScript(int $scriptIndex, array $arguments, int $keysInArgs): bool
    {
        $retValue = $this->getRedisInstance()
            ->evalSha(RedisTaggedScripts::getScriptDigest($scriptIndex), $arguments, $keysInArgs);

        if ($retValue === false) {
            // script not loaded yet
            $script = RedisTaggedScripts::getScriptBody($scriptIndex);
            $digest = $this->getRedisInstance()->script('load', $script);
            assert($digest === RedisTaggedScripts::getScriptDigest($scriptIndex));

            // eval one more time
            $retValue = $this->getRedisInstance()
                ->evalSha(RedisTaggedScripts::getScriptDigest($scriptIndex), $arguments, $keysInArgs);
        }

        return $retValue === 0;
    }

    /**
     * @return string
     */
    protected function getInternalKeysPrefix(): string
    {
        return $this->internalKeysPrefix;
    }

    /**
     * @param string $internalKeysPrefix
     */
    protected function setInternalKeysPrefix(string $internalKeysPrefix): void
    {
        $this->internalKeysPrefix = $internalKeysPrefix;
    }

    /**
     * @return string
     */
    protected function getInternalTagsPrefix(): string
    {
        return $this->internalTagsPrefix;
    }

    /**
     * @param string $internalTagsPrefix
     */
    protected function setInternalTagsPrefix(string $internalTagsPrefix): void
    {
        $this->internalTagsPrefix = $internalTagsPrefix;
    }
}


1			<?php declare(strict_types=1);
2
3			namespace Limoncello\RedisTaggedCache;
4
5			/**
6			* Copyright 2015-2019 [email protected]
7			*
8			* Licensed under the Apache License, Version 2.0 (the "License");
9			* you may not use this file except in compliance with the License.
10			* You may obtain a copy of the License at
11			*
12			* http://www.apache.org/licenses/LICENSE-2.0
13			*
14			* Unless required by applicable law or agreed to in writing, software
15			* distributed under the License is distributed on an "AS IS" BASIS,
16			* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17			* See the License for the specific language governing permissions and
18			* limitations under the License.
19			*/
20
21			use Limoncello\RedisTaggedCache\Exceptions\RedisTaggedCacheException;
22			use Limoncello\RedisTaggedCache\Scripts\RedisTaggedScripts;
23			use Redis;
24			use RuntimeException;
25			use function array_values;
26			use function assert;
27			use function json_encode;
28
29			/**
30			* @package Limoncello\RedisTaggedCache
31			*/
32			trait RedisTaggedCacheTrait
33			{
34			/**
35			* @var Redis
36			*/
37			private $redisInstance;
38
39			/**
40			* @var string
41			*/
42			private $internalKeysPrefix = '_:k:';
43
44			/**
45			* @var string
46			*/
47			private $internalTagsPrefix = '_:t:';
48			/**
49			* @return Redis
50			*/
51	6		protected function getRedisInstance(): Redis
52			{
53	6		assert($this->redisInstance !== null, 'Redis instance should be set before usage.');
54
55	6		return $this->redisInstance;
56			}
57
58			/**
59			* @param Redis $redisInstance
60			*/
61	6		protected function setRedisInstance(Redis $redisInstance): void
62			{
63	6		$this->redisInstance = $redisInstance;
64			}
65
66			/** @noinspection PhpDocRedundantThrowsInspection
67			* @param string $key
68			* @param string $value
69			* @param array $tags
70			* @param int $ttl
71			*
72			* @return void
73			*
74			* @throws RedisTaggedCacheException
75			*/
76	2		public function addTaggedValue(string $key, string $value, array $tags, $ttl = 0): void
77			{
78			// if array keys are non-consecutive it will be encoded to object instead of an array.
79			// to be on a safe side we gonna use `array_values`
80	2		$jsonTags = json_encode(array_values($tags));
81	2		$isOk = $this->evalScript(
82	2		RedisTaggedScripts::ADD_VALUE_SCRIPT_INDEX,
83	2		[$key, $value, $jsonTags, $this->getInternalKeysPrefix(), $this->getInternalTagsPrefix(), $ttl],
84	2		1
85			);
86
87	2		if ($isOk === false) {
88			throw new class extends RuntimeException implements RedisTaggedCacheException
89			{
90			};
91			}
92			}
93
94			/** @noinspection PhpDocRedundantThrowsInspection
95			* @param string $key
96			*
97			* @return void
98			*
99			* @throws RedisTaggedCacheException
100			*/
101	2	View Code Duplication	public function removeTaggedValue(string $key): void
			0 ignored issues – show Duplication introduced 2019-05-28 10:02 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...
102			{
103	2		$isOk = $this->evalScript(
104	2		RedisTaggedScripts::REMOVE_VALUE_SCRIPT_INDEX,
105	2		[$key, $this->getInternalKeysPrefix(), $this->getInternalTagsPrefix()],
106	2		1
107			);
108
109	2		if ($isOk === false) {
110			throw new class extends RuntimeException implements RedisTaggedCacheException
111			{
112			};
113			}
114			}
115
116			/** @noinspection PhpDocRedundantThrowsInspection
117			* @param string $tag
118			*
119			* @return void
120			*
121			* @throws RedisTaggedCacheException
122			*/
123	2	View Code Duplication	public function invalidateTag(string $tag): void
			0 ignored issues – show Duplication introduced 2019-05-28 10:02 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...
124			{
125	2		$isOk = $this->evalScript(
126	2		RedisTaggedScripts::INVALIDATE_TAG_SCRIPT_INDEX,
127	2		[$tag, $this->getInternalKeysPrefix(), $this->getInternalTagsPrefix()],
128	2		1
129			);
130
131	2		if ($isOk === false) {
132			throw new class extends RuntimeException implements RedisTaggedCacheException
133			{
134			};
135			}
136			}
137
138			/**
139			* @param int $scriptIndex
140			* @param array $arguments
141			* @param int $keysInArgs
142			*
143			* @return bool
144			*
145			* @SuppressWarnings(PHPMD.StaticAccess)
146			*/
147	6		protected function evalScript(int $scriptIndex, array $arguments, int $keysInArgs): bool
148			{
149	6		$retValue = $this->getRedisInstance()
150	6		->evalSha(RedisTaggedScripts::getScriptDigest($scriptIndex), $arguments, $keysInArgs);
151
152	6		if ($retValue === false) {
153			// script not loaded yet
154	6		$script = RedisTaggedScripts::getScriptBody($scriptIndex);
155	6		$digest = $this->getRedisInstance()->script('load', $script);
156	6		assert($digest === RedisTaggedScripts::getScriptDigest($scriptIndex));
157
158			// eval one more time
159	6		$retValue = $this->getRedisInstance()
160	6		->evalSha(RedisTaggedScripts::getScriptDigest($scriptIndex), $arguments, $keysInArgs);
161			}
162
163	6		return $retValue === 0;
164			}
165
166			/**
167			* @return string
168			*/
169	6		protected function getInternalKeysPrefix(): string
170			{
171	6		return $this->internalKeysPrefix;
172			}
173
174			/**
175			* @param string $internalKeysPrefix
176			*/
177	6		protected function setInternalKeysPrefix(string $internalKeysPrefix): void
178			{
179	6		$this->internalKeysPrefix = $internalKeysPrefix;
180			}
181
182			/**
183			* @return string
184			*/
185	6		protected function getInternalTagsPrefix(): string
186			{
187	6		return $this->internalTagsPrefix;
188			}
189
190			/**
191			* @param string $internalTagsPrefix
192			*/
193	6		protected function setInternalTagsPrefix(string $internalTagsPrefix): void
194			{
195	6		$this->internalTagsPrefix = $internalTagsPrefix;
196			}
197			}
198

limoncello-php-dist / redis-tagged-cache

RedisTaggedCacheTrait::getInternalKeysPrefix() A last analyzed 2019-05-28 17:53 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

RedisTaggedCacheTrait::getInternalKeysPrefix() A
last analyzed 2019-05-28 17:53 UTC