xref: /webtrees/app/Cache.php (revision 24f2a3af38709f9bf0a739b30264240d20ba34e8)
1<?php
2
3/**
4 * webtrees: online genealogy
5 * Copyright (C) 2021 webtrees development team
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program. If not, see <https://www.gnu.org/licenses/>.
16 */
17
18declare(strict_types=1);
19
20namespace Fisharebest\Webtrees;
21
22use Closure;
23use Symfony\Contracts\Cache\CacheInterface;
24use Symfony\Contracts\Cache\ItemInterface;
25
26/**
27 * Wrapper around the symfony PSR6 cache library.
28 * Hash the keys to protect against characters that are not allowed in PSR6.
29 */
30class Cache
31{
32    /** @var CacheInterface */
33    private $cache;
34
35    /**
36     * Cache constructor.
37     *
38     * @param CacheInterface $cache
39     */
40    public function __construct(CacheInterface $cache)
41    {
42        $this->cache = $cache;
43    }
44
45    /**
46     * Fetch an item from the cache - or create it where it does not exist.
47     *
48     * @param string   $key
49     * @param Closure  $closure
50     * @param int|null $ttl
51     *
52     * @return mixed
53     */
54    public function remember(string $key, Closure $closure, int $ttl = null)
55    {
56        return $this->cache->get(md5($key), static function (ItemInterface $item) use ($closure, $ttl) {
57            $item->expiresAfter($ttl);
58
59            return $closure();
60        });
61    }
62
63    /**
64     * Remove an item from the cache.
65     *
66     * @param string $key
67     */
68    public function forget(string $key): void
69    {
70        $this->cache->delete(md5($key));
71    }
72}
73