Files
Jump/jumpapp/classes/Cache.php
2022-02-04 11:52:57 +00:00

85 lines
3.1 KiB
PHP

<?php
namespace Jump;
use Nette\Caching;
/**
* Defines caches to be used throughout the site and provides a wrapper around
* the Nette\Caching library.
*
* @author Dale Davies <dale@daledavies.co.uk>
* @license MIT
*/
class Cache {
private Caching\Storages\FileStorage $storage;
/**
* The definition of various caches used throughout the application.
*
* @var array Multidimensional array
*/
private array $caches;
private Config $config;
/**
* Creates file storage for cache and initialises cache objects for each
* name/type specified in $caches definition.
*/
public function __construct(Config $config) {
$this->config = $config;
// Define the various caches used throughout the app.
$this->caches = [
'sites' => [
'cache' => null,
'expirationtype' => Caching\Cache::FILES,
'expirationparams' => $config->get('sitesfile')
],
'templates/sites' => [
'cache' => null,
'expirationtype' => Caching\Cache::FILES,
'expirationparams' => [
__DIR__.'/../config.php',
$config->get('sitesfile'),
$config->get('templatedir').'/sites.mustache'
]
]
];
// Inititalise file storage for cache using cachedir path from config.
$this->storage = new Caching\Storages\FileStorage($this->config->get('cachedir').'/application');
// Initialise a cache object for each cache name/type specified in caches array.
array_walk($this->caches, function(&$cachedef, $cachename) {
$cachedef['cache'] = new Caching\Cache($this->storage, $cachename);
});
}
/**
* Read the specified item from the cache or generate it, mostly a wrapper
* around Nette\Caching\Cache::load().
*
* @param string $cachename The name of a cache type, must match a key in $caches definition.
* @param callable $callback The code from which the result should be stored in cache.
* @return mixed The result of callback function retreieved from cache.
*/
public function load(string $cachename, callable $callback): mixed {
// If cachebypass has been set in config.php then just execute the callback.
if ($this->config->parse_bool($this->config->get('cachebypass'))) {
return $callback();
}
// We can only work with caches that have already been defined.
if (!array_key_exists($cachename, $this->caches)) {
throw new \Exception('Cache name not found ('.$cachename.')');
}
// Retrieve the initialised cache object from $caches, defines the caches expiry
// and executes the callback.
return $this->caches[$cachename]['cache']->load($cachename,
function (&$dependencies) use ($callback, $cachename) {
$dependencies[$this->caches[$cachename]['expirationtype']] = $this->caches[$cachename]['expirationparams'];
return $callback();
}
);
}
}