CachedBagOStuff.php

Go to the documentation of this file.

<?php
class CachedBagOStuff extends HashBagOStuff {
    protected $backend;
 
    function __construct( BagOStuff $backend, $params = [] ) {
        unset( $params['reportDupes'] ); // useless here
 
        parent::__construct( $params );
 
        $this->backend = $backend;
        $this->attrMap = $backend->attrMap;
    }
 
    protected function doGet( $key, $flags = 0 ) {
        $ret = parent::doGet( $key, $flags );
        if ( $ret === false && !$this->hasKey( $key ) ) {
            $ret = $this->backend->doGet( $key, $flags );
            $this->set( $key, $ret, 0, self::WRITE_CACHE_ONLY );
        }
        return $ret;
    }
 
    public function set( $key, $value, $exptime = 0, $flags = 0 ) {
        parent::set( $key, $value, $exptime, $flags );
        if ( !( $flags & self::WRITE_CACHE_ONLY ) ) {
            $this->backend->set( $key, $value, $exptime, $flags & ~self::WRITE_CACHE_ONLY );
        }
        return true;
    }
 
    public function delete( $key, $flags = 0 ) {
        unset( $this->bag[$key] );
        if ( !( $flags & self::WRITE_CACHE_ONLY ) ) {
            $this->backend->delete( $key );
        }
 
        return true;
    }
 
    public function setDebug( $bool ) {
        parent::setDebug( $bool );
        $this->backend->setDebug( $bool );
    }
 
    public function deleteObjectsExpiringBefore( $date, $progressCallback = false ) {
        parent::deleteObjectsExpiringBefore( $date, $progressCallback );
        return $this->backend->deleteObjectsExpiringBefore( $date, $progressCallback );
    }
 
    public function makeKey( $class, $component = null ) {
        return call_user_func_array( [ $this->backend, __FUNCTION__ ], func_get_args() );
    }
 
    public function makeGlobalKey( $class, $component = null ) {
        return call_user_func_array( [ $this->backend, __FUNCTION__ ], func_get_args() );
    }
 
    // These just call the backend (tested elsewhere)
    // @codeCoverageIgnoreStart
 
    public function lock( $key, $timeout = 6, $expiry = 6, $rclass = '' ) {
        return $this->backend->lock( $key, $timeout, $expiry, $rclass );
    }
 
    public function unlock( $key ) {
        return $this->backend->unlock( $key );
    }
 
    public function getLastError() {
        return $this->backend->getLastError();
    }
 
    public function clearLastError() {
        return $this->backend->clearLastError();
    }
 
    public function modifySimpleRelayEvent( array $event ) {
        return $this->backend->modifySimpleRelayEvent( $event );
    }
 
    // @codeCoverageIgnoreEnd
}