xref: /webtrees/app/Cache.php (revision 14c0ee0ff901ef56e1effb389a9b6fee5244ab77)
1<?php
2
3/**
4 * webtrees: online genealogy
5 * Copyright (C) 2019 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 <http://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 */
29class Cache
30{
31    // Default time-to-live for cache items; 100 days.
32    private const DEFAULT_TTL = 8640000;
33
34    /** @var CacheInterface */
35    private $cache;
36
37    /**
38     * Cache constructor.
39     *
40     * @param CacheInterface $cache
41     */
42    public function __construct(CacheInterface $cache)
43    {
44        $this->cache = $cache;
45    }
46
47    /**
48     * Fetch an item from the cache - or create it where it does not exist.
49     *
50     * @param string  $key
51     * @param Closure $closure
52     * @param int     $ttl
53     *
54     * @return mixed
55     */
56    public function remember(string $key, Closure $closure, int $ttl = self::DEFAULT_TTL)
57    {
58        return $this->cache->get($key, static function (ItemInterface $item) use ($closure, $ttl) {
59            $item->expiresAfter($ttl);
60
61            return $closure();
62        });
63    }
64
65    /**
66     * Remove an item from the cache.
67     *
68     * @param string $key
69     */
70    public function forget(string $key): void
71    {
72        $this->cache->delete($key);
73    }
74}
75