Passed
Push — develop ( cc6e0d...eb2865 )
by nguereza
03:00
created

ApcuStorage::delete()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 3
Code Lines 1

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
cc 1
eloc 1
c 1
b 0
f 0
nc 1
nop 1
dl 0
loc 3
rs 10
1
<?php
2
3
/**
4
 * Platine Framework
5
 *
6
 * Platine Framework is a lightweight, high-performance, simple and elegant
7
 * PHP Web framework
8
 *
9
 * This content is released under the MIT License (MIT)
10
 *
11
 * Copyright (c) 2020 Platine Framework
12
 *
13
 * Permission is hereby granted, free of charge, to any person obtaining a copy
14
 * of this software and associated documentation files (the "Software"), to deal
15
 * in the Software without restriction, including without limitation the rights
16
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
17
 * copies of the Software, and to permit persons to whom the Software is
18
 * furnished to do so, subject to the following conditions:
19
 *
20
 * The above copyright notice and this permission notice shall be included in all
21
 * copies or substantial portions of the Software.
22
 *
23
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
24
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
25
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
26
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
27
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
28
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
29
 * SOFTWARE.
30
 */
31
32
/**
33
 *  @file ApcuStorage.php
34
 *
35
 *  The APCu Rate Limit storage class
36
 *
37
 *  @package    Platine\Framework\Http\RateLimit\Storage
38
 *  @author Platine Developers team
39
 *  @copyright  Copyright (c) 2020
40
 *  @license    http://opensource.org/licenses/MIT  MIT License
41
 *  @link   https://www.platine-php.com
42
 *  @version 1.0.0
43
 *  @filesource
44
 */
45
46
declare(strict_types=1);
47
48
namespace Platine\Framework\Http\RateLimit\Storage;
49
50
use Platine\Framework\Http\RateLimit\RateLimitStorageInterface;
51
use RuntimeException;
52
53
/**
54
 * @class ApcuStorage
55
 * @package Platine\Framework\Http\RateLimit\Storage
56
 */
57
class ApcuStorage implements RateLimitStorageInterface
58
{
59
   /**
60
     * Create new instance
61
     */
62
    public function __construct()
63
    {
64
        if ((!extension_loaded('apcu')) || !((bool) ini_get('apc.enabled'))) {
65
            throw new RuntimeException('The rate limit storage for APCu driver is not available.'
66
                            . ' Check if APCu extension is loaded and enabled.');
67
        }
68
    }
69
70
     /**
71
     * {@inheritdoc}
72
     */
73
    public function set(string $key, float $value, int $ttl): bool
74
    {
75
        return apcu_store($key, $value, $ttl);
76
    }
77
78
    /**
79
     * {@inheritdoc}
80
     */
81
    public function get(string $key): float
82
    {
83
        $success = false;
84
        /** @var mixed */
85
        $value = apcu_fetch($key, $success);
86
87
        return $success ? $value : 0;
0 ignored issues
show
Bug Best Practice introduced by
The expression return $success ? $value : 0 could return the type null|string which is incompatible with the type-hinted return double. Consider adding an additional type-check to rule them out.
Loading history...
88
    }
89
90
    /**
91
     * {@inheritdoc}
92
     */
93
    public function exists(string $key): bool
94
    {
95
        return apcu_exists($key);
96
    }
97
98
    /**
99
     * {@inheritdoc}
100
     */
101
    public function delete(string $key): bool
102
    {
103
        return (bool) apcu_delete($key);
104
    }
105
}
106