Completed
Pull Request — master (#220)
by Luís
03:30
created

PhpFileCache::doContains()   A

Complexity

Conditions 3
Paths 3

Size

Total Lines 10
Code Lines 5

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 5
CRAP Score 3

Importance

Changes 0
Metric Value
c 0
b 0
f 0
dl 0
loc 10
ccs 5
cts 5
cp 1
rs 9.4285
cc 3
eloc 5
nc 3
nop 1
crap 3
1
<?php
2
/*
3
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
4
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
5
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
6
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
7
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
8
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
9
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
10
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
11
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
12
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
13
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
14
 *
15
 * This software consists of voluntary contributions made by many individuals
16
 * and is licensed under the MIT license. For more information, see
17
 * <http://www.doctrine-project.org>.
18
 */
19
20
namespace Doctrine\Common\Cache;
21
22
/**
23
 * Php file cache driver.
24
 *
25
 * @since  2.3
26
 * @author Fabio B. Silva <[email protected]>
27
 */
28
class PhpFileCache extends FileCache
29
{
30
    const EXTENSION = '.doctrinecache.php';
31
32
    /**
33
     * @var callable
34
     *
35
     * This is cached in a local static variable to avoid instantiating a closure each time we need an empty handler
36
     */
37
    private static $emptyErrorHandler;
38
39
    /**
40
     * {@inheritdoc}
41
     */
42 79
    public function __construct($directory, $extension = self::EXTENSION, $umask = 0002)
43
    {
44 79
        parent::__construct($directory, $extension, $umask);
45
46 79
        self::$emptyErrorHandler = function () {
47 79
        };
48 79
    }
49
50
    /**
51
     * {@inheritdoc}
52
     */
53 77
    protected function doFetch($id)
54
    {
55 77
        $value = $this->includeFileForId($id);
56
57 77
        if ($value === null) {
58 77
            return false;
59
        }
60
61 65
        if ($value['lifetime'] !== 0 && $value['lifetime'] < time()) {
62
            return false;
63
        }
64
65 65
        return $value['data'];
66
    }
67
68
    /**
69
     * {@inheritdoc}
70
     */
71 68
    protected function doContains($id)
72
    {
73 68
        $value = $this->includeFileForId($id);
74
75 68
        if ($value === null) {
76 48
            return false;
77
        }
78
79 64
        return $value['lifetime'] === 0 || $value['lifetime'] > time();
80
    }
81
82
    /**
83
     * {@inheritdoc}
84
     */
85 75
    protected function doSave($id, $data, $lifeTime = 0)
86
    {
87 75
        if ($lifeTime > 0) {
88 3
            $lifeTime = time() + $lifeTime;
89
        }
90
91 75
        $filename  = $this->getFilename($id);
92
93
        $value = [
94 75
            'lifetime'  => $lifeTime,
95 75
            'data'      => $data
96
        ];
97
98 75
        if (is_object($data) && method_exists($data, '__set_state')) {
99 1
            $value  = var_export($value, true);
100 1
            $code   = sprintf('<?php return %s;', $value);
101
        } else {
102 74
            $value  = var_export(serialize($value), true);
103 74
            $code   = sprintf('<?php return unserialize(%s);', $value);
104
        }
105
106 75
        return $this->writeFile($filename, $code);
107
    }
108
109
    /**
110
     * @param string $id
111
     *
112
     * @return array|null
113
     */
114 77
    private function includeFileForId(string $id) : ?array
115
    {
116 77
        $fileName = $this->getFilename($id);
117
118
        // note: error suppression is still faster than `file_exists`, `is_file` and `is_readable`
119 77
        set_error_handler(self::$emptyErrorHandler);
120
121 77
        $value = include $fileName;
122
123 77
        restore_error_handler();
124
125 77
        if (! isset($value['lifetime'])) {
126 77
            return null;
127
        }
128
129 70
        return $value;
130
    }
131
}
132