Passed
Push — develop ( b817d6...234651 )
by nguereza
02:05
created

ApcuStorage::delete()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 3
Code Lines 1

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
eloc 1
dl 0
loc 3
rs 10
c 0
b 0
f 0
cc 1
nc 1
nop 1
1
<?php
2
3
/**
4
 * Platine Cache
5
 *
6
 * Platine Cache is the implementation of PSR 16 simple cache
7
 *
8
 * This content is released under the MIT License (MIT)
9
 *
10
 * Copyright (c) 2020 Platine Cache
11
 *
12
 * Permission is hereby granted, free of charge, to any person obtaining a copy
13
 * of this software and associated documentation files (the "Software"), to deal
14
 * in the Software without restriction, including without limitation the rights
15
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
16
 * copies of the Software, and to permit persons to whom the Software is
17
 * furnished to do so, subject to the following conditions:
18
 *
19
 * The above copyright notice and this permission notice shall be included in all
20
 * copies or substantial portions of the Software.
21
 *
22
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
23
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
24
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
25
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
26
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
27
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
28
 * SOFTWARE.
29
 */
30
31
/**
32
 *  @file ApcuStorage.php
33
 *
34
 *  The Cache Storage using APCu extension to manage the cache data
35
 *
36
 *  @package    Platine\Cache\Storage
37
 *  @author Platine Developers Team
38
 *  @copyright  Copyright (c) 2020
39
 *  @license    http://opensource.org/licenses/MIT  MIT License
40
 *  @link   http://www.iacademy.cf
41
 *  @version 1.0.0
42
 *  @filesource
43
 */
44
45
declare(strict_types=1);
46
47
namespace Platine\Cache\Storage;
48
49
use DateInterval;
50
use Platine\Cache\Configuration;
51
use Platine\Cache\Exception\CacheException;
52
use Platine\Cache\Storage\AbstractStorage;
53
54
/**
55
 * Class ApcuStorage
56
 * @package Platine\Cache\Storage
57
 */
58
class ApcuStorage extends AbstractStorage
59
{
60
    /**
61
     * {@inheritdoc}
62
     *
63
     * Create new instance
64
     */
65
    public function __construct(?Configuration $config = null)
66
    {
67
        if ((!extension_loaded('apcu')) || !((bool) ini_get('apc.enabled'))) {
68
            throw new CacheException('The cache for APCu driver is not available.'
69
                            . ' Check if APCu extension is loaded and enabled.');
70
        }
71
72
        parent::__construct($config);
73
    }
74
75
    /**
76
     * {@inheritdoc}
77
     */
78
    public function get(string $key, $default = null)
79
    {
80
        $success = false;
81
        /** @var mixed */
82
        $data = apcu_fetch($key, $success);
83
84
        return $success ? $data : $default;
85
    }
86
87
    /**
88
     * {@inheritdoc}
89
     */
90
    public function set(string $key, $value, $ttl = null): bool
91
    {
92
        if ($ttl === null) {
93
            $ttl = $this->config->get('ttl');
94
        } elseif ($ttl instanceof DateInterval) {
95
            $ttl = $this->convertDateIntervalToSeconds($ttl);
96
        } elseif (!is_int($ttl)) {
97
            throw new CacheException(sprintf(
98
                'Invalid cache TTL value expected null|int|DateInterval but got [%s]',
99
                gettype($ttl)
100
            ));
101
        }
102
        /** @var bool */
103
        return apcu_store($key, $value, $ttl);
104
    }
105
106
    /**
107
     * {@inheritdoc}
108
     */
109
    public function delete(string $key): bool
110
    {
111
        return apcu_delete($key) === true;
112
    }
113
114
    /**
115
     * {@inheritdoc}
116
     */
117
    public function clear(): bool
118
    {
119
        /** @var bool */
120
        return apcu_clear_cache();
121
    }
122
123
    /**
124
     * {@inheritdoc}
125
     */
126
    public function has(string $key): bool
127
    {
128
        return apcu_exists($key) === true;
129
    }
130
}
131