ReplicatedBagOStuff.php

Go to the documentation of this file.

<?php
use Wikimedia\ObjectFactory;
 
class ReplicatedBagOStuff extends BagOStuff {
    protected $writeStore;
    protected $readStore;
 
    public function __construct( $params ) {
        parent::__construct( $params );
 
        if ( !isset( $params['writeFactory'] ) ) {
            throw new InvalidArgumentException(
                __METHOD__ . ': the "writeFactory" parameter is required' );
        }
        if ( !isset( $params['readFactory'] ) ) {
            throw new InvalidArgumentException(
                __METHOD__ . ': the "readFactory" parameter is required' );
        }
 
        $opts = [ 'reportDupes' => false ]; // redundant
        $this->writeStore = ( $params['writeFactory'] instanceof BagOStuff )
            ? $params['writeFactory']
            : ObjectFactory::getObjectFromSpec( $opts + $params['writeFactory'] );
        $this->readStore = ( $params['readFactory'] instanceof BagOStuff )
            ? $params['readFactory']
            : ObjectFactory::getObjectFromSpec( $opts + $params['readFactory'] );
        $this->attrMap = $this->mergeFlagMaps( [ $this->readStore, $this->writeStore ] );
    }
 
    public function setDebug( $debug ) {
        $this->writeStore->setDebug( $debug );
        $this->readStore->setDebug( $debug );
    }
 
    public function get( $key, $flags = 0 ) {
        return ( $flags & self::READ_LATEST )
            ? $this->writeStore->get( $key, $flags )
            : $this->readStore->get( $key, $flags );
    }
 
    public function set( $key, $value, $exptime = 0, $flags = 0 ) {
        return $this->writeStore->set( $key, $value, $exptime, $flags );
    }
 
    public function delete( $key, $flags = 0 ) {
        return $this->writeStore->delete( $key, $flags );
    }
 
    public function add( $key, $value, $exptime = 0, $flags = 0 ) {
        return $this->writeStore->add( $key, $value, $exptime, $flags );
    }
 
    public function merge( $key, callable $callback, $exptime = 0, $attempts = 10, $flags = 0 ) {
        return $this->writeStore->merge( $key, $callback, $exptime, $attempts, $flags );
    }
 
    public function changeTTL( $key, $exptime = 0, $flags = 0 ) {
        return $this->writeStore->changeTTL( $key, $exptime, $flags );
    }
 
    public function lock( $key, $timeout = 6, $expiry = 6, $rclass = '' ) {
        return $this->writeStore->lock( $key, $timeout, $expiry, $rclass );
    }
 
    public function unlock( $key ) {
        return $this->writeStore->unlock( $key );
    }
 
    public function deleteObjectsExpiringBefore( $date, $progressCallback = false ) {
        return $this->writeStore->deleteObjectsExpiringBefore( $date, $progressCallback );
    }
 
    public function getMulti( array $keys, $flags = 0 ) {
        return ( ( $flags & self::READ_LATEST ) == self::READ_LATEST )
            ? $this->writeStore->getMulti( $keys, $flags )
            : $this->readStore->getMulti( $keys, $flags );
    }
 
    public function setMulti( array $data, $exptime = 0, $flags = 0 ) {
        return $this->writeStore->setMulti( $data, $exptime, $flags );
    }
 
    public function deleteMulti( array $keys, $flags = 0 ) {
        return $this->writeStore->deleteMulti( $keys, $flags );
    }
 
    public function incr( $key, $value = 1 ) {
        return $this->writeStore->incr( $key, $value );
    }
 
    public function decr( $key, $value = 1 ) {
        return $this->writeStore->decr( $key, $value );
    }
 
    public function incrWithInit( $key, $ttl, $value = 1, $init = 1 ) {
        return $this->writeStore->incrWithInit( $key, $ttl, $value, $init );
    }
 
    public function getLastError() {
        return ( $this->writeStore->getLastError() != self::ERR_NONE )
            ? $this->writeStore->getLastError()
            : $this->readStore->getLastError();
    }
 
    public function clearLastError() {
        $this->writeStore->clearLastError();
        $this->readStore->clearLastError();
    }
 
    public function makeKeyInternal( $keyspace, $args ) {
        return $this->writeStore->makeKeyInternal( ...func_get_args() );
    }
 
    public function makeKey( $class, $component = null ) {
        return $this->writeStore->makeKey( ...func_get_args() );
    }
 
    public function makeGlobalKey( $class, $component = null ) {
        return $this->writeStore->makeGlobalKey( ...func_get_args() );
    }
 
    protected function doGet( $key, $flags = 0, &$casToken = null ) {
        throw new LogicException( __METHOD__ . ': proxy class does not need this method.' );
    }
}