ProcessCacheLRU.php

Go to the documentation of this file.

<?php
use Wikimedia\Assert\Assert;

class ProcessCacheLRU {
    protected $cache = []; // (key => prop => value)

    protected $cacheTimes = []; // (key => prop => UNIX timestamp)

    protected $maxCacheKeys; // integer; max entries

    public function __construct( $maxKeys ) {
        $this->resize( $maxKeys );
    }

    public function set( $key, $prop, $value ) {
        if ( isset( $this->cache[$key] ) ) {
            $this->ping( $key );
        } elseif ( count( $this->cache ) >= $this->maxCacheKeys ) {
            reset( $this->cache );
            $evictKey = key( $this->cache );
            unset( $this->cache[$evictKey] );
            unset( $this->cacheTimes[$evictKey] );
        }
        $this->cache[$key][$prop] = $value;
        $this->cacheTimes[$key][$prop] = microtime( true );
    }

    public function has( $key, $prop, $maxAge = 0.0 ) {
        if ( isset( $this->cache[$key][$prop] ) ) {
            return ( $maxAge <= 0 ||
                ( microtime( true ) - $this->cacheTimes[$key][$prop] ) <= $maxAge
            );
        }

        return false;
    }

    public function get( $key, $prop ) {
        if ( !isset( $this->cache[$key][$prop] ) ) {
            return null;
        }
        $this->ping( $key );
        return $this->cache[$key][$prop];
    }

    public function clear( $keys = null ) {
        if ( $keys === null ) {
            $this->cache = [];
            $this->cacheTimes = [];
        } else {
            foreach ( (array)$keys as $key ) {
                unset( $this->cache[$key] );
                unset( $this->cacheTimes[$key] );
            }
        }
    }

    public function resize( $maxKeys ) {
        Assert::parameterType( 'integer', $maxKeys, '$maxKeys' );
        Assert::parameter( $maxKeys > 0, '$maxKeys', 'must be above zero' );

        $this->maxCacheKeys = $maxKeys;
        while ( count( $this->cache ) > $this->maxCacheKeys ) {
            reset( $this->cache );
            $evictKey = key( $this->cache );
            unset( $this->cache[$evictKey] );
            unset( $this->cacheTimes[$evictKey] );
        }
    }

    protected function ping( $key ) {
        $item = $this->cache[$key];
        unset( $this->cache[$key] );
        $this->cache[$key] = $item;
    }

    public function getSize() {
        return $this->maxCacheKeys;
    }
}