Documentation addition/tweaks
[lhc/web/wiklou.git] / includes / ObjectCache.php
index 07525ac..db22c07 100644 (file)
@@ -1,5 +1,7 @@
 <?php
 /**
+ * Functions to get cache objects
+ *
  * @file
  * @ingroup Cache
  */
@@ -32,7 +34,10 @@ class FakeMemCachedClient {
 global $wgCaches;
 $wgCaches = array();
 
-/** @todo document */
+/**
+ * Get a cache object.
+ * @param $inputType Integer: cache type, one the the CACHE_* constants. 
+ */
 function &wfGetCache( $inputType ) {
        global $wgCaches, $wgMemCachedServers, $wgMemCachedDebug, $wgMemCachedPersistent;
        $cache = false;
@@ -49,14 +54,6 @@ function &wfGetCache( $inputType ) {
 
        if ( $type == CACHE_MEMCACHED ) {
                if ( !array_key_exists( CACHE_MEMCACHED, $wgCaches ) ) {
-                       require_once( 'memcached-client.php' );
-                       if ( !class_exists("MemcachedClientforWiki") ) {
-                               class MemCachedClientforWiki extends memcached {
-                                       function _debugprint( $text ) {
-                                               wfDebug( "memcached: $text" );
-                                       }
-                               }
-                       }
                        $wgCaches[CACHE_MEMCACHED] = new MemCachedClientforWiki(
                                array('persistant' => $wgMemCachedPersistent, 'compress_threshold' => 1500 ) );
                        $wgCaches[CACHE_MEMCACHED]->set_servers( $wgMemCachedServers );
@@ -71,8 +68,8 @@ function &wfGetCache( $inputType ) {
                                $wgCaches[CACHE_ACCEL] = new APCBagOStuff;
                        } elseif( function_exists( 'xcache_get' ) ) {
                                $wgCaches[CACHE_ACCEL] = new XCacheBagOStuff();
-                       } elseif ( function_exists( 'mmcache_get' ) ) {
-                               $wgCaches[CACHE_ACCEL] = new TurckBagOStuff;
+                       } elseif( function_exists( 'wincache_ucache_get' ) ) {
+                               $wgCaches[CACHE_ACCEL] = new WinCacheBagOStuff();
                        } else {
                                $wgCaches[CACHE_ACCEL] = false;
                        }
@@ -89,7 +86,7 @@ function &wfGetCache( $inputType ) {
 
        if ( $type == CACHE_DB || ( $inputType == CACHE_ANYTHING && $cache === false ) ) {
                if ( !array_key_exists( CACHE_DB, $wgCaches ) ) {
-                       $wgCaches[CACHE_DB] = new MediaWikiBagOStuff('objectcache');
+                       $wgCaches[CACHE_DB] = new SqlBagOStuff('objectcache');
                }
                $cache =& $wgCaches[CACHE_DB];
        }
@@ -104,18 +101,21 @@ function &wfGetCache( $inputType ) {
        return $cache;
 }
 
+/** Get the main cache object */
 function &wfGetMainCache() {
        global $wgMainCacheType;
        $ret =& wfGetCache( $wgMainCacheType );
        return $ret;
 }
 
+/** Get the cache object used by the message cache */
 function &wfGetMessageCacheStorage() {
        global $wgMessageCacheType;
        $ret =& wfGetCache( $wgMessageCacheType );
        return $ret;
 }
 
+/** Get the cache object used by the parser cache */
 function &wfGetParserCacheStorage() {
        global $wgParserCacheType;
        $ret =& wfGetCache( $wgParserCacheType );