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;
    }

    public function get( $key, $flags = 0 ) {
        $ret = parent::get( $key, $flags );
        if ( $ret === false && !$this->hasKey( $key ) ) {
            $ret = $this->backend->get( $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 ) {
        parent::delete( $key, $flags );
        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 makeKeyInternal( $keyspace, $args ) {
        return $this->backend->makeKeyInternal( ...func_get_args() );
    }

    public function makeKey( $class, $component = null ) {
        return $this->backend->makeKey( ...func_get_args() );
    }

    public function makeGlobalKey( $class, $component = null ) {
        return $this->backend->makeGlobalKey( ...func_get_args() );
    }

    // These just call the backend (tested elsewhere)
    // @codeCoverageIgnoreStart

    public function add( $key, $value, $exptime = 0, $flags = 0 ) {
        if ( $this->get( $key ) === false ) {
            return $this->set( $key, $value, $exptime, $flags );
        }

        return false; // key already set
    }

    public function incr( $key, $value = 1 ) {
        $n = $this->backend->incr( $key, $value );
        parent::delete( $key );

        return $n;
    }

    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();
    }

    // @codeCoverageIgnoreEnd
}