MessageGroupWANCache.php

Go to the documentation of this file.

<?php
class MessageGroupWANCache {
 
    protected $cache;
    protected $cacheKey;
    protected $cacheVersion;
    protected $regenerator;
    protected $lockTSE;
    protected $checkKeys;
    protected $touchedCallback;
    protected $ttl;
 
    private const KEY_PREFIX = 'translate-mg';
 
    public function __construct( WANObjectCache $cache ) {
        $this->cache = $cache;
    }
 
    public function getValue( $recache = false ) {
        $this->checkConfig();
 
        $cacheData = $this->cache->getWithSetCallback(
            $this->cacheKey,
            $this->ttl,
            $this->regenerator,
            [
                'lockTSE' => $this->lockTSE, // avoid stampedes (mutex)
                'checkKeys' => $this->checkKeys,
                'touchedCallback' => function ( $value ) {
                    if ( $this->touchedCallback && call_user_func( $this->touchedCallback, $value ) ) {
                        // treat value as if it just expired (for "lockTSE")
                        return time();
                    }
 
                    return null;
                },
                // "miss" on recache
                'minAsOf' => $recache ? INF : WANObjectCache::MIN_TIMESTAMP_NONE,
            ]
        );
 
        return $cacheData;
    }
 
    public function setValue( $cacheData ) {
        $this->checkConfig();
        $this->cache->set( $this->cacheKey, $cacheData, $this->ttl );
    }
 
    public function touchKey() {
        $this->checkConfig();
        $this->cache->touchCheckKey( $this->cacheKey );
    }
 
    public function delete() {
        $this->checkConfig();
        $this->cache->delete( $this->cacheKey );
    }
 
    public function configure( array $config ) {
        $this->cacheKey = $config['key'] ?? null;
        $this->cacheVersion = $config['version'] ?? null;
        $this->regenerator = $config['regenerator'] ?? null;
        $this->lockTSE = $config['lockTSE'] ?? 30;
        $this->checkKeys = $config['checkKeys'] ?? [ $this->cacheKey ];
        $this->touchedCallback = $config['touchedCallback'] ?? null;
        $this->ttl = $config['ttl'] ?? WANObjectCache::TTL_DAY;
 
        $this->checkConfig();
 
        if ( $this->cacheVersion ) {
            $this->cacheKey = $this->cache->makeKey( self::KEY_PREFIX,
                strtolower( $this->cacheKey ), 'v' . $this->cacheVersion );
        } else {
            $this->cacheKey = $this->cache->makeKey(
                self::KEY_PREFIX, strtolower( $this->cacheKey )
            );
        }
    }
 
    protected function checkConfig() {
        if ( $this->cacheKey === null ) {
            throw new InvalidArgumentException( "Invalid cache key set. " .
                "Ensure you have called the configure function before get / setting values." );
        }
 
        if ( !is_callable( $this->regenerator ) ) {
            throw new InvalidArgumentException( "Invalid regenerator set. " .
                "Ensure you have called the configure function before get / setting values." );
        }
 
        if ( $this->touchedCallback && !is_callable( $this->touchedCallback ) ) {
            throw new InvalidArgumentException( "touchedCallback is not callable. " );
        }
    }
}