1<?php 2 3/** 4 * webtrees: online genealogy 5 * Copyright (C) 2023 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 private CacheInterface $cache; 33 34 /** 35 * @param CacheInterface $cache 36 */ 37 public function __construct(CacheInterface $cache) 38 { 39 $this->cache = $cache; 40 } 41 42 /** 43 * Fetch an item from the cache - or create it where it does not exist. 44 * 45 * @template T 46 * 47 * @param string $key 48 * @param Closure(): T $closure 49 * @param int|null $ttl 50 * 51 * @return T 52 */ 53 public function remember(string $key, Closure $closure, int|null $ttl = null) 54 { 55 return $this->cache->get(md5($key), static function (ItemInterface $item) use ($closure, $ttl) { 56 $item->expiresAfter($ttl); 57 58 return $closure(); 59 }); 60 } 61 62 /** 63 * Remove an item from the cache. 64 * 65 * @param string $key 66 */ 67 public function forget(string $key): void 68 { 69 $this->cache->delete(md5($key)); 70 } 71} 72