MapCacheLRU.php

Go to the documentation of this file.

<?php
use Wikimedia\Assert\Assert;
 
class MapCacheLRU {
    protected $cache = []; // (key => value)
 
    protected $maxCacheKeys; // integer; max entries
 
    public function __construct( $maxKeys ) {
        Assert::parameterType( 'integer', $maxKeys, '$maxKeys' );
        Assert::parameter( $maxKeys > 0, '$maxKeys', 'must be above zero' );
 
        $this->maxCacheKeys = $maxKeys;
    }
 
    public static function newFromArray( array $values, $maxKeys ) {
        $mapCache = new self( $maxKeys );
        $mapCache->cache = ( count( $values ) > $maxKeys )
            ? array_slice( $values, -$maxKeys, null, true )
            : $values;
 
        return $mapCache;
    }
 
    public function toArray() {
        return $this->cache;
    }
 
    public function set( $key, $value, $rank = 1.0 ) {
        if ( $this->has( $key ) ) {
            $this->ping( $key );
        } elseif ( count( $this->cache ) >= $this->maxCacheKeys ) {
            reset( $this->cache );
            $evictKey = key( $this->cache );
            unset( $this->cache[$evictKey] );
        }
 
        if ( $rank < 1.0 && $rank > 0 ) {
            $offset = intval( $rank * count( $this->cache ) );
            $this->cache = array_slice( $this->cache, 0, $offset, true )
                + [ $key => $value ]
                + array_slice( $this->cache, $offset, null, true );
        } else {
            $this->cache[$key] = $value;
        }
    }
 
    public function has( $key ) {
        if ( !is_int( $key ) && !is_string( $key ) ) {
            throw new UnexpectedValueException(
                __METHOD__ . ' called with invalid key. Must be string or integer.' );
        }
        return array_key_exists( $key, $this->cache );
    }
 
    public function get( $key ) {
        if ( !$this->has( $key ) ) {
            return null;
        }
 
        $this->ping( $key );
 
        return $this->cache[$key];
    }
 
    public function getAllKeys() {
        return array_keys( $this->cache );
    }
 
    public function getWithSetCallback( $key, callable $callback, $rank = 1.0 ) {
        if ( $this->has( $key ) ) {
            $value = $this->get( $key );
        } else {
            $value = call_user_func( $callback );
            if ( $value !== false ) {
                $this->set( $key, $value, $rank );
            }
        }
 
        return $value;
    }
 
    public function clear( $keys = null ) {
        if ( $keys === null ) {
            $this->cache = [];
        } else {
            foreach ( (array)$keys as $key ) {
                unset( $this->cache[$key] );
            }
        }
    }
 
    protected function ping( $key ) {
        $item = $this->cache[$key];
        unset( $this->cache[$key] );
        $this->cache[$key] = $item;
    }
}