SimpleCacheAdapter::set()   A
last analyzed

Complexity

Conditions 4
Paths 7

Size

Total Lines 15
Code Lines 10

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
dl 0
loc 15
rs 9.2
c 0
b 0
f 0
cc 4
eloc 10
nc 7
nop 3
1
<?php
2
3
namespace Spiral\PhpFastCache;
4
5
use phpFastCache\Cache\ExtendedCacheItemInterface;
6
use Psr\Cache\CacheItemPoolInterface;
7
use Psr\SimpleCache\CacheInterface;
8
use Spiral\PhpFastCache\Exceptions\SpiralFastCacheException;
9
10
class SimpleCacheAdapter implements CacheInterface
11
{
12
    /**
13
     * @var CacheItemPoolInterface
14
     */
15
    protected $pool;
16
17
    /**
18
     * PSR16Adapter constructor.
19
     *
20
     * @param CacheItemPoolInterface $pool
21
     */
22
    public function __construct(CacheItemPoolInterface $pool)
23
    {
24
        $this->pool = $pool;
25
    }
26
27
    /**
28
     * {@inheritdoc}
29
     */
30
    public function get($key, $default = null)
31
    {
32
        try {
33
            $value = $this->pool->getItem($key)->get();
34
            if ($value !== null) {
35
                return $value;
36
            } else {
37
                return $default;
38
            }
39
        } catch (\Throwable $e) {
40
            throw new SpiralFastCacheException($e->getMessage(), $e->getMessage(), $e);
41
        }
42
    }
43
44
    /**
45
     * {@inheritdoc}
46
     */
47
    public function set($key, $value, $ttl = null)
48
    {
49
        try {
50
            $item = $this->pool
51
                ->getItem($key)
52
                ->set($value);
53
            if (is_int($ttl) || $ttl instanceof \DateInterval) {
54
                $item->expiresAfter($ttl);
55
            }
56
57
            return $this->pool->save($item);
58
        } catch (\Throwable $e) {
59
            throw new SpiralFastCacheException($e->getMessage(), $e->getMessage(), $e);
60
        }
61
    }
62
63
    /**
64
     * {@inheritdoc}
65
     */
66
    public function delete($key)
67
    {
68
        try {
69
            return $this->pool->deleteItem($key);
70
        } catch (\Throwable $e) {
71
            throw new SpiralFastCacheException($e->getMessage(), $e->getMessage(), $e);
72
        }
73
    }
74
75
    /**
76
     * {@inheritdoc}
77
     */
78
    public function clear()
79
    {
80
        try {
81
            return $this->pool->clear();
82
        } catch (\Throwable $e) {
83
            throw new SpiralFastCacheException($e->getMessage(), $e->getMessage(), $e);
84
        }
85
    }
86
87
    /**
88
     * {@inheritdoc}
89
     */
90
    public function getMultiple($keys, $default = null)
91
    {
92
        try {
93
            return array_map(function (ExtendedCacheItemInterface $item) {
0 ignored issues
show
Bug Best Practice introduced by
The return type of return array_map(functio...pool->getItems($keys)); (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...
94
                return $item->get();
95
            }, $this->pool->getItems($keys));
96
        } catch (\Throwable $e) {
97
            throw new SpiralFastCacheException($e->getMessage(), $e->getMessage(), $e);
98
        }
99
    }
100
101
    /**
102
     * {@inheritdoc}
103
     */
104
    public function setMultiple($values, $ttl = null)
105
    {
106
        try {
107
            foreach ($values as $key => $value) {
108
                $item = $this->pool->getItem($key)->set($value);
109
                $this->pool->saveDeferred($item);
110
                unset($item);
111
            }
112
113
            return $this->pool->commit();
114
        } catch (\Throwable $e) {
115
            throw new SpiralFastCacheException($e->getMessage(), $e->getMessage(), $e);
116
        }
117
    }
118
119
    /**
120
     * {@inheritdoc}
121
     */
122
    public function deleteMultiple($keys)
123
    {
124
        try {
125
            return $this->pool->deleteItems($keys);
126
        } catch (\Throwable $e) {
127
            throw new SpiralFastCacheException($e->getMessage(), $e->getMessage(), $e);
128
        }
129
    }
130
131
    /**
132
     * {@inheritdoc}
133
     */
134
    public function has($key)
135
    {
136
        try {
137
            return $this->pool->getItem($key)->isHit();
138
        } catch (\Throwable $e) {
139
            throw new SpiralFastCacheException($e->getMessage(), $e->getMessage(), $e);
140
        }
141
    }
142
}