CachingSiteStore.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Site;
 
use Wikimedia\ObjectCache\BagOStuff;
 
class CachingSiteStore implements SiteStore {
    private $siteStore;
    private $cache;
 
    private $cacheKey = null;
    private $sites = null;
 
    public function __construct(
        SiteStore $siteStore,
        BagOStuff $cache
    ) {
        $this->siteStore = $siteStore;
        $this->cache = $cache;
    }
 
    private function getCacheKey() {
        if ( $this->cacheKey === null ) {
            $version = SiteList::getSerialVersionId();
            $this->cacheKey = $this->cache->makeKey( 'site-SiteList', $version );
        }
 
        return $this->cacheKey;
    }
 
    public function getSites() {
        if ( $this->sites === null ) {
            $this->sites = $this->cache->getWithSetCallback(
                $this->getCacheKey(),
                BagOStuff::TTL_HOUR,
                function () {
                    return $this->siteStore->getSites();
                }
            );
        }
 
        return $this->sites;
    }
 
    public function getSite( $globalId ) {
        $sites = $this->getSites();
 
        return $sites->hasSite( $globalId ) ? $sites->getSite( $globalId ) : null;
    }
 
    public function saveSite( Site $site ) {
        return $this->saveSites( [ $site ] );
    }
 
    public function saveSites( array $sites ) {
        if ( !$sites ) {
            return true;
        }
 
        $success = $this->siteStore->saveSites( $sites );
 
        // purge cache
        $this->reset();
 
        return $success;
    }
 
    public function reset() {
        $this->cache->delete( $this->getCacheKey() );
        $this->sites = null;
    }
 
    public function clear() {
        $this->reset();
 
        return $this->siteStore->clear();
    }
 
}
 
class_alias( CachingSiteStore::class, 'CachingSiteStore' );