nur-sery/nur_src/b/io/CacheManager.php

68 lines
2.0 KiB
PHP
Raw Normal View History

2023-12-03 22:10:18 +04:00
<?php
namespace nur\b\io;
use nur\A;
/**
* Class CacheManager: un gestionnaire de cache permettant de désactiver la mise
* en cache d'une valeur dans le cadre d'une session.
*
* en effet, si on désactive le cache, il doit être réactivé après que la valeur
* est calculée, pour éviter qu'une valeur soit calculée encore et encore dans
* une session de travail
*/
class CacheManager {
2024-07-05 15:43:02 +04:00
function __construct(?array $includes=null, ?array $excludes=null) {
2023-12-03 22:10:18 +04:00
$this->caches = [];
$this->defaultCache = true;
2024-07-05 15:43:02 +04:00
$this->includes = $includes;
$this->excludes = $excludes;
2023-12-03 22:10:18 +04:00
}
/**
* @var array tableau {id => cache} indiquant si l'élément id doit être mis en
* cache
*/
2024-07-05 15:44:06 +04:00
protected array $caches;
2023-12-03 22:10:18 +04:00
/**
* @var bool valeur par défaut de cache si la valeur n'est pas trouvée dans
* $caches
*/
2024-07-05 15:44:06 +04:00
protected bool $defaultCache;
2023-12-03 22:10:18 +04:00
2024-07-05 15:43:02 +04:00
/**
* @var array|null groupes à toujours inclure dans le cache. pour les
* identifiants de ces groupe, {@link self::shouldCache()} retourne toujours
* true.
*
* $excludes est prioritaire par rapport à $includes
*/
2024-07-05 15:44:06 +04:00
protected ?array $includes;
2024-07-05 15:43:02 +04:00
/**
* @var array|null groupes à exclure de la mise en cache. la mise en cache est
* toujours calculée pour les identifiants de ces groupes.
*/
2024-07-05 15:44:06 +04:00
protected ?array $excludes;
2024-07-05 15:43:02 +04:00
2023-12-03 22:10:18 +04:00
function setNoCache(bool $noCache=true, bool $reset=true): self {
if ($reset) $this->caches = [];
$this->defaultCache = !$noCache;
return $this;
}
2024-07-05 15:43:02 +04:00
function shouldCache(string $id, ?string $groupId=null, bool $reset=true): bool {
2024-07-05 15:44:06 +04:00
if ($groupId !== null) {
$includes = $this->includes;
$shouldInclude = $includes !== null && in_array($groupId, $includes);
$excludes = $this->excludes;
$shouldExclude = $excludes !== null && in_array($groupId, $excludes);
if ($shouldInclude && !$shouldExclude) return true;
}
2023-12-03 22:10:18 +04:00
$cache = A::get($this->caches, $id, $this->defaultCache);
$this->caches[$id] = $reset?: $cache;
return $cache;
}
}