ObjectCache.php

Go to the documentation of this file.

<?php
class ObjectCache {
    public static $instances = array();

    static function getInstance( $id ) {
        if ( isset( self::$instances[$id] ) ) {
            return self::$instances[$id];
        }

        $object = self::newFromId( $id );
        self::$instances[$id] = $object;
        return $object;
    }

    static function clear() {
        self::$instances = array();
    }

    static function newFromId( $id ) {
        global $wgObjectCaches;

        if ( !isset( $wgObjectCaches[$id] ) ) {
            throw new MWException( "Invalid object cache type \"$id\" requested. " .
                "It is not present in \$wgObjectCaches." );
        }

        return self::newFromParams( $wgObjectCaches[$id] );
    }

    static function newFromParams( $params ) {
        if ( isset( $params['factory'] ) ) {
            return call_user_func( $params['factory'], $params );
        } elseif ( isset( $params['class'] ) ) {
            $class = $params['class'];
            return new $class( $params );
        } else {
            throw new MWException( "The definition of cache type \""
                . print_r( $params, true ) . "\" lacks both "
                . "factory and class parameters." );
        }
    }

    static function newAnything( $params ) {
        global $wgMainCacheType, $wgMessageCacheType, $wgParserCacheType;
        $candidates = array( $wgMainCacheType, $wgMessageCacheType, $wgParserCacheType );
        foreach ( $candidates as $candidate ) {
            if ( $candidate !== CACHE_NONE && $candidate !== CACHE_ANYTHING ) {
                return self::getInstance( $candidate );
            }
        }
        return self::getInstance( CACHE_DB );
    }

    static function newAccelerator( $params, $fallback = null ) {
        if ( function_exists( 'apc_fetch' ) ) {
            $id = 'apc';
        } elseif ( function_exists( 'xcache_get' ) && wfIniGetBool( 'xcache.var_size' ) ) {
            $id = 'xcache';
        } elseif ( function_exists( 'wincache_ucache_get' ) ) {
            $id = 'wincache';
        } else {
            if ( $fallback ) {
                return self::newFromId( $fallback );
            }
            throw new MWException( "CACHE_ACCEL requested but no suitable object " .
                "cache is present. You may want to install APC." );
        }
        return self::newFromId( $id );
    }

    static function newMemcached( $params ) {
        return new MemcachedPhpBagOStuff( $params );
    }
}