CachingSiteStore.php

Go to the documentation of this file.

<?php

class CachingSiteStore implements SiteStore {

    private $sites = null;

    private $cacheKey;

    private $cacheTimeout;

    private $cache;

    private $siteStore;

    public function __construct(
        SiteStore $siteStore,
        BagOStuff $cache,
        $cacheKey = null,
        $cacheTimeout = 3600
    ) {
        $this->siteStore = $siteStore;
        $this->cache = $cache;
        $this->cacheKey = $cacheKey;
        $this->cacheTimeout = $cacheTimeout;
    }

    private function getCacheKey() {
        if ( $this->cacheKey === null ) {
            $type = 'SiteList#' . SiteList::getSerialVersionId();
            $this->cacheKey = $this->cache->makeKey( "sites/$type" );
        }

        return $this->cacheKey;
    }

    public function getSites() {
        if ( $this->sites === null ) {
            $this->sites = $this->cache->get( $this->getCacheKey() );

            if ( !is_object( $this->sites ) ) {
                $this->sites = $this->siteStore->getSites();

                $this->cache->set( $this->getCacheKey(), $this->sites, $this->cacheTimeout );
            }
        }

        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 ( empty( $sites ) ) {
            return true;
        }

        $success = $this->siteStore->saveSites( $sites );

        // purge cache
        $this->reset();

        return $success;
    }

    public function reset() {
        // purge cache
        $this->cache->delete( $this->getCacheKey() );
        $this->sites = null;
    }

    public function clear() {
        $this->reset();

        return $this->siteStore->clear();
    }

}