RedisCache::setMultiple() - Code Metrics - subjective-php/psr-cache-redis - Measure and Improve Code Quality continuously with Scrutinizer

RedisCache::setMultiple() A
last analyzed 2018-08-09 13:13 UTC

↳ Parent: RedisCache

Complexity

Conditions	3
Paths	3

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	12
rs	9.8666
c	0
b	0
f	0
cc	3
nc	3
nop	2

<?php

namespace SubjectivePHP\Psr\SimpleCache;

use SubjectivePHP\Psr\SimpleCache\Serializer\BasicSerializer;
use SubjectivePHP\Psr\SimpleCache\Serializer\SerializerInterface;
use DateInterval;
use DateTime;
use Predis\ClientInterface;
use Psr\SimpleCache\CacheInterface;

/**
 * A PSR-16 implementation which stores data in a RedisDB collection.
 */
final class RedisCache implements CacheInterface
{
    use KeyValidatorTrait;
    use TTLValidatorTrait;

    /**
     * Redis client for storing cache.
     *
     * @var ClientInterface
     */
    private $client;

    /**
     * The object responsible for serializing data to and from redis values.
     *
     * @var SerializerInterface
     */
    private $serializer;

    /**
     * Construct a new instance of RedisCache.
     *
     * @param ClientInterface     $client     Redis client for storing cache.
     * @param SerializerInterface $serializer Object responsible for serializing data to and from redis values.
     */
    public function __construct(ClientInterface $client, SerializerInterface $serializer = null)
    {
        $this->client = $client;
        $this->serializer = $serializer ?? new BasicSerializer();
    }

    /**
     * Fetches a value from the cache.
     *
     * @param string $key     The unique key of this item in the cache.
     * @param mixed  $default Default value to return if the key does not exist.
     *
     * @return mixed The value of the item from the cache, or $default in case of cache miss.
     *
     * @throws InvalidArgumentException Thrown if the $key string is not a legal value.
     */
    public function get($key, $default = null)//@codingStandardsIgnoreLine Interface does not define type-hints or return
    {
        $this->validateKey($key);

        $cached = $this->client->get($key);
        if ($cached !== null) {
            return $this->serializer->unserialize($cached);
        }

        return $default;
    }

    /**
     * Obtains multiple cache items by their unique keys.
     *
     * @param iterable $keys    A list of keys that can obtained in a single operation.
     * @param mixed    $default Default value to return for keys that do not exist.
     *
     * @return array List of key => value pairs. Cache keys that do not exist or are stale will have $default as value.
     *
     * @throws InvalidArgumentException Thrown if the $key string is not a legal value.
     */
    public function getMultiple($keys, $default = null)//@codingStandardsIgnoreLine Interface does not define type-hints or return
    {
        $result = [];
        foreach ($keys as $key) {
            $result[$key] = $this->get($key, $default);
        }

        return $result;
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }

    /**
     * Persists data in the cache, uniquely referenced by a key with an optional expiration TTL time.
     *
     * @param string                    $key   The key of the item to store.
     * @param mixed                     $value The value of the item to store, must be serializable.
     * @param null|integer|DateInterval $ttl   Optional. The TTL value of this item. If no value is sent and
     *                                         the driver supports TTL then the library may set a default value
     *                                         for it or let the driver take care of that.
     *
     * @return boolean True on success and false on failure.
     *
     * @throws InvalidArgumentException Thrown if the $key string is not a legal value.
     */
    public function set($key, $value, $ttl = null)//@codingStandardsIgnoreLine Interface does not define type-hints or return
    {
        $this->validateKey($key);
        $this->validateTTL($ttl);
        if ($this->client->set($key, $this->serializer->serialize($value))->getPayload() !== 'OK') {
            return false;
        }

        $this->setExpires($key, $ttl);

        return true;
    }

    /**
     * Persists a set of key => value pairs in the cache, with an optional TTL.
     *
     * @param iterable                  $values A list of key => value pairs for a multiple-set operation.
     * @param null|integer|DateInterval $ttl    Optional. The TTL value of this item. If no value is sent and
     *                                          the driver supports TTL then the library may set a default value
     *                                          for it or let the driver take care of that.
     *
     * @return boolean True on success and false on failure.
     *
     * @throws InvalidArgumentException Thrown if $values is neither an array nor a Traversable,
     *                                  or if any of the $values are not a legal value.
     */
    public function setMultiple($values, $ttl = null)//@codingStandardsIgnoreLine Interface does not define type-hints or return
    {
        $this->validateKeys(array_keys($values));
        $this->validateTTL($ttl);
        foreach ($values as $key => $value) {
            if (!$this->set($key, $value, $ttl)) {
                return false;
            }
        }

        return true;
    }

    /**
     * Delete an item from the cache by its unique key.
     *
     * @param string $key The unique cache key of the item to delete.
     *
     * @return boolean True if the item was successfully removed. False if there was an error.
     *
     * @throws InvalidArgumentException Thrown if the $key string is not a legal value.
     */
    public function delete($key)//@codingStandardsIgnoreLine Interface does not define type-hints or return
    {
        return $this->deleteMultiple([$key]);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    /**
     * Deletes multiple cache items in a single operation.
     *
     * @param iterable $keys A list of string-based keys to be deleted.
     *
     * @return boolean True if the items were successfully removed. False if there was an error.
     *
     * @throws InvalidArgumentException Thrown if $keys is neither an array nor a Traversable,
     *                                  or if any of the $keys are not a legal value.
     */
    public function deleteMultiple($keys)//@codingStandardsIgnoreLine Interface does not define type-hints
    {
        $this->validateKeys($keys);
        return $this->client->del($keys) === count($keys);
    }

    /**
     * Wipes clean the entire cache's keys.
     *
     * @return boolean True on success and false on failure.
     */
    public function clear()//@codingStandardsIgnoreLine Interface does not define type-hints or return
    {
        $this->client->flushall();
        return true;
    }

    /**
     * Determines whether an item is present in the cache.
     *
     * NOTE: It is recommended that has() is only to be used for cache warming type purposes
     * and not to be used within your live applications operations for get/set, as this method
     * is subject to a race condition where your has() will return true and immediately after,
     * another script can remove it making the state of your app out of date.
     *
     * @param string $key The cache item key.
     *
     * @return boolean
     *
     * @throws InvalidArgumentException Thrown if the $key string is not a legal value.
     */
    public function has($key) //@codingStandardsIgnoreLine  Interface does not define type-hints
    {
        $this->validateKey($key);
        return (bool)$this->client->exists($key);
    }

    /**
     * Converts the given time to live value to a DataTime instance;
     *
     * @param string $key The cache item key.
     * @param mixed  $ttl The time-to-live value to validate.
     *
     * @return void
     */
    private function setExpires(string $key, $ttl)
    {
        if ($ttl === null) {
            return;
        }

        if (is_int($ttl)) {
            $ttl = DateInterval::createFromDateString("{$ttl} seconds");
        }

        $this->client->expireat($key, (new DateTime())->add($ttl)->getTimestamp());
    }
}


1			<?php
2
3			namespace SubjectivePHP\Psr\SimpleCache;
4
5			use SubjectivePHP\Psr\SimpleCache\Serializer\BasicSerializer;
6			use SubjectivePHP\Psr\SimpleCache\Serializer\SerializerInterface;
7			use DateInterval;
8			use DateTime;
9			use Predis\ClientInterface;
10			use Psr\SimpleCache\CacheInterface;
11
12			/**
13			* A PSR-16 implementation which stores data in a RedisDB collection.
14			*/
15			final class RedisCache implements CacheInterface
16			{
17			use KeyValidatorTrait;
18			use TTLValidatorTrait;
19
20			/**
21			* Redis client for storing cache.
22			*
23			* @var ClientInterface
24			*/
25			private $client;
26
27			/**
28			* The object responsible for serializing data to and from redis values.
29			*
30			* @var SerializerInterface
31			*/
32			private $serializer;
33
34			/**
35			* Construct a new instance of RedisCache.
36			*
37			* @param ClientInterface $client Redis client for storing cache.
38			* @param SerializerInterface $serializer Object responsible for serializing data to and from redis values.
39			*/
40			public function __construct(ClientInterface $client, SerializerInterface $serializer = null)
41			{
42			$this->client = $client;
43			$this->serializer = $serializer ?? new BasicSerializer();
44			}
45
46			/**
47			* Fetches a value from the cache.
48			*
49			* @param string $key The unique key of this item in the cache.
50			* @param mixed $default Default value to return if the key does not exist.
51			*
52			* @return mixed The value of the item from the cache, or $default in case of cache miss.
53			*
54			* @throws InvalidArgumentException Thrown if the $key string is not a legal value.
55			*/
56			public function get($key, $default = null)//@codingStandardsIgnoreLine Interface does not define type-hints or return
57			{
58			$this->validateKey($key);
59
60			$cached = $this->client->get($key);
61			if ($cached !== null) {
62			return $this->serializer->unserialize($cached);
63			}
64
65			return $default;
66			}
67
68			/**
69			* Obtains multiple cache items by their unique keys.
70			*
71			* @param iterable $keys A list of keys that can obtained in a single operation.
72			* @param mixed $default Default value to return for keys that do not exist.
73			*
74			* @return array List of key => value pairs. Cache keys that do not exist or are stale will have $default as value.
75			*
76			* @throws InvalidArgumentException Thrown if the $key string is not a legal value.
77			*/
78			public function getMultiple($keys, $default = null)//@codingStandardsIgnoreLine Interface does not define type-hints or return
79			{
80			$result = [];
81			foreach ($keys as $key) {
82			$result[$key] = $this->get($key, $default);
83			}
84
85			return $result;
			0 ignored issues – show Bug Best Practice introduced 2018-07-15 16:25 UTC by Report Bug Copy Issue Report The return type of `return $result;` (`array`) is incompatible with the return type declared by the interface `Psr\SimpleCache\CacheInterface::getMultiple` of type `Psr\SimpleCache\iterable`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
86			}
87
88			/**
89			* Persists data in the cache, uniquely referenced by a key with an optional expiration TTL time.
90			*
91			* @param string $key The key of the item to store.
92			* @param mixed $value The value of the item to store, must be serializable.
93			* @param null\|integer\|DateInterval $ttl Optional. The TTL value of this item. If no value is sent and
94			* the driver supports TTL then the library may set a default value
95			* for it or let the driver take care of that.
96			*
97			* @return boolean True on success and false on failure.
98			*
99			* @throws InvalidArgumentException Thrown if the $key string is not a legal value.
100			*/
101			public function set($key, $value, $ttl = null)//@codingStandardsIgnoreLine Interface does not define type-hints or return
102			{
103			$this->validateKey($key);
104			$this->validateTTL($ttl);
105			if ($this->client->set($key, $this->serializer->serialize($value))->getPayload() !== 'OK') {
106			return false;
107			}
108
109			$this->setExpires($key, $ttl);
110
111			return true;
112			}
113
114			/**
115			* Persists a set of key => value pairs in the cache, with an optional TTL.
116			*
117			* @param iterable $values A list of key => value pairs for a multiple-set operation.
118			* @param null\|integer\|DateInterval $ttl Optional. The TTL value of this item. If no value is sent and
119			* the driver supports TTL then the library may set a default value
120			* for it or let the driver take care of that.
121			*
122			* @return boolean True on success and false on failure.
123			*
124			* @throws InvalidArgumentException Thrown if $values is neither an array nor a Traversable,
125			* or if any of the $values are not a legal value.
126			*/
127			public function setMultiple($values, $ttl = null)//@codingStandardsIgnoreLine Interface does not define type-hints or return
128			{
129			$this->validateKeys(array_keys($values));
130			$this->validateTTL($ttl);
131			foreach ($values as $key => $value) {
132			if (!$this->set($key, $value, $ttl)) {
133			return false;
134			}
135			}
136
137			return true;
138			}
139
140			/**
141			* Delete an item from the cache by its unique key.
142			*
143			* @param string $key The unique cache key of the item to delete.
144			*
145			* @return boolean True if the item was successfully removed. False if there was an error.
146			*
147			* @throws InvalidArgumentException Thrown if the $key string is not a legal value.
148			*/
149			public function delete($key)//@codingStandardsIgnoreLine Interface does not define type-hints or return
150			{
151			return $this->deleteMultiple([$key]);
			0 ignored issues – show Documentation introduced 2018-07-15 16:36 UTC by Report Bug Copy Issue Report `array($key)` is of type `array<integer,string,{"0":"string"}>`, but the function expects a `object<SubjectivePHP\Psr\SimpleCache\iterable>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
152			}
153
154			/**
155			* Deletes multiple cache items in a single operation.
156			*
157			* @param iterable $keys A list of string-based keys to be deleted.
158			*
159			* @return boolean True if the items were successfully removed. False if there was an error.
160			*
161			* @throws InvalidArgumentException Thrown if $keys is neither an array nor a Traversable,
162			* or if any of the $keys are not a legal value.
163			*/
164			public function deleteMultiple($keys)//@codingStandardsIgnoreLine Interface does not define type-hints
165			{
166			$this->validateKeys($keys);
167			return $this->client->del($keys) === count($keys);
168			}
169
170			/**
171			* Wipes clean the entire cache's keys.
172			*
173			* @return boolean True on success and false on failure.
174			*/
175			public function clear()//@codingStandardsIgnoreLine Interface does not define type-hints or return
176			{
177			$this->client->flushall();
178			return true;
179			}
180
181			/**
182			* Determines whether an item is present in the cache.
183			*
184			* NOTE: It is recommended that has() is only to be used for cache warming type purposes
185			* and not to be used within your live applications operations for get/set, as this method
186			* is subject to a race condition where your has() will return true and immediately after,
187			* another script can remove it making the state of your app out of date.
188			*
189			* @param string $key The cache item key.
190			*
191			* @return boolean
192			*
193			* @throws InvalidArgumentException Thrown if the $key string is not a legal value.
194			*/
195			public function has($key) //@codingStandardsIgnoreLine Interface does not define type-hints
196			{
197			$this->validateKey($key);
198			return (bool)$this->client->exists($key);
199			}
200
201			/**
202			* Converts the given time to live value to a DataTime instance;
203			*
204			* @param string $key The cache item key.
205			* @param mixed $ttl The time-to-live value to validate.
206			*
207			* @return void
208			*/
209			private function setExpires(string $key, $ttl)
210			{
211			if ($ttl === null) {
212			return;
213			}
214
215			if (is_int($ttl)) {
216			$ttl = DateInterval::createFromDateString("{$ttl} seconds");
217			}
218
219			$this->client->expireat($key, (new DateTime())->add($ttl)->getTimestamp());
220			}
221			}
222

subjective-php / psr-cache-redis

RedisCache::setMultiple() A last analyzed 2018-08-09 13:13 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

RedisCache::setMultiple() A
last analyzed 2018-08-09 13:13 UTC