CachedBagOStuff.php

Go to the documentation of this file.

<?php
class CachedBagOStuff extends BagOStuff {
    protected $backend;
    protected $procCache;

    public function __construct( BagOStuff $backend, $params = [] ) {
        parent::__construct( $params );

        $this->backend = $backend;
        $this->procCache = new HashBagOStuff( $params );
        $this->attrMap = $backend->attrMap;
    }

    public function setDebug( $enabled ) {
        parent::setDebug( $enabled );
        $this->backend->setDebug( $enabled );
    }

    public function get( $key, $flags = 0 ) {
        $value = $this->procCache->get( $key, $flags );
        if ( $value === false && !$this->procCache->hasKey( $key ) ) {
            $value = $this->backend->get( $key, $flags );
            $this->set( $key, $value, self::TTL_INDEFINITE, self::WRITE_CACHE_ONLY );
        }

        return $value;
    }

    public function getMulti( array $keys, $flags = 0 ) {
        $valuesByKeyCached = [];

        $keysMissing = [];
        foreach ( $keys as $key ) {
            $value = $this->procCache->get( $key, $flags );
            if ( $value === false && !$this->procCache->hasKey( $key ) ) {
                $keysMissing[] = $key;
            } else {
                $valuesByKeyCached[$key] = $value;
            }
        }

        $valuesByKeyFetched = $this->backend->getMulti( $keysMissing, $flags );
        $this->setMulti( $valuesByKeyFetched, self::TTL_INDEFINITE, self::WRITE_CACHE_ONLY );

        return $valuesByKeyCached + $valuesByKeyFetched;
    }

    public function set( $key, $value, $exptime = 0, $flags = 0 ) {
        $this->procCache->set( $key, $value, $exptime, $flags );

        if ( !$this->fieldHasFlags( $flags, self::WRITE_CACHE_ONLY ) ) {
            $this->backend->set( $key, $value, $exptime, $flags );
        }

        return true;
    }

    public function delete( $key, $flags = 0 ) {
        $this->procCache->delete( $key, $flags );

        if ( !$this->fieldHasFlags( $flags, self::WRITE_CACHE_ONLY ) ) {
            $this->backend->delete( $key, $flags );
        }

        return true;
    }

    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
    }

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

    public function merge( $key, callable $callback, $exptime = 0, $attempts = 10, $flags = 0 ) {
        $this->procCache->delete( $key );

        return $this->backend->merge( $key, $callback, $exptime, $attempts, $flags );
    }

    public function changeTTL( $key, $exptime = 0, $flags = 0 ) {
        $this->procCache->delete( $key );

        return $this->backend->changeTTL( $key, $exptime, $flags );
    }

    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 deleteObjectsExpiringBefore(
        $timestamp,
        callable $progress = null,
        $limit = INF
    ) {
        $this->procCache->deleteObjectsExpiringBefore( $timestamp, $progress, $limit );

        return $this->backend->deleteObjectsExpiringBefore( $timestamp, $progress, $limit );
    }

    public function makeKeyInternal( $keyspace, $args ) {
        return $this->backend->makeKeyInternal( $keyspace, $args );
    }

    public function makeKey( $class, ...$components ) {
        return $this->backend->makeKey( $class, ...$components );
    }

    public function makeGlobalKey( $class, ...$components ) {
        return $this->backend->makeGlobalKey( $class, ...$components );
    }

    public function getLastError() {
        return $this->backend->getLastError();
    }

    public function clearLastError() {
        return $this->backend->clearLastError();
    }

    public function setMulti( array $data, $exptime = 0, $flags = 0 ) {
        $this->procCache->setMulti( $data, $exptime, $flags );

        if ( !$this->fieldHasFlags( $flags, self::WRITE_CACHE_ONLY ) ) {
            return $this->backend->setMulti( $data, $exptime, $flags );
        }

        return true;
    }

    public function deleteMulti( array $keys, $flags = 0 ) {
        $this->procCache->deleteMulti( $keys, $flags );

        if ( !$this->fieldHasFlags( $flags, self::WRITE_CACHE_ONLY ) ) {
            return $this->backend->deleteMulti( $keys, $flags );
        }

        return true;
    }

    public function changeTTLMulti( array $keys, $exptime, $flags = 0 ) {
        $this->procCache->changeTTLMulti( $keys, $exptime, $flags );

        if ( !$this->fieldHasFlags( $flags, self::WRITE_CACHE_ONLY ) ) {
            return $this->backend->changeTTLMulti( $keys, $exptime, $flags );
        }

        return true;
    }

    public function incr( $key, $value = 1, $flags = 0 ) {
        $this->procCache->delete( $key );

        return $this->backend->incr( $key, $value, $flags );
    }

    public function decr( $key, $value = 1, $flags = 0 ) {
        $this->procCache->delete( $key );

        return $this->backend->decr( $key, $value, $flags );
    }

    public function incrWithInit( $key, $exptime, $value = 1, $init = null, $flags = 0 ) {
        $this->procCache->delete( $key );

        return $this->backend->incrWithInit( $key, $exptime, $value, $init, $flags );
    }

    public function addBusyCallback( callable $workCallback ) {
        $this->backend->addBusyCallback( $workCallback );
    }

    public function setMockTime( &$time ) {
        parent::setMockTime( $time );
        $this->procCache->setMockTime( $time );
        $this->backend->setMockTime( $time );
    }

    // @codeCoverageIgnoreEnd
}