MediaWiki 1.14.0

[autoinstallsdev/mediawiki.git] / includes / ObjectCache.php

diff --git a/includes/ObjectCache.php b/includes/ObjectCache.php
index 7d9caf8a8313a4799a44e14316f2d6a345751ec8..6cfb2340f4f7c16f890cdd511f0a57627e6c4595 100644 (file)
--- a/includes/ObjectCache.php
+++ b/includes/ObjectCache.php
@@ -1,6 +1,7 @@
 <?php
 /**
- * @addtogroup Cache
+ * @file
+ * @ingroup Cache
  */
 
 /**
@@ -8,7 +9,7 @@
  * It acts as a memcached server with no RAM, that is, all objects are
  * cleared the moment they are set. All set operations succeed and all
  * get operations return null.
- * @addtogroup Cache
+ * @ingroup Cache
  */
 class FakeMemCachedClient {
        function add ($key, $val, $exp = 0) { return true; }
@@ -31,7 +32,10 @@ class FakeMemCachedClient {
 global $wgCaches;
 $wgCaches = array();
 
-/** @todo document */
+/**
+ * Get a cache object.
+ * @param int $inputType cache type, one the the CACHE_* constants. 
+ */
 function &wfGetCache( $inputType ) {
        global $wgCaches, $wgMemCachedServers, $wgMemCachedDebug, $wgMemCachedPersistent;
        $cache = false;
@@ -47,23 +51,20 @@ function &wfGetCache( $inputType ) {
        }
 
        if ( $type == CACHE_MEMCACHED ) {
-               if ( !array_key_exists( CACHE_MEMCACHED, $wgCaches ) ){
-                       require_once( 'memcached-client.php' );
-
-                       if (!class_exists("MemcachedClientforWiki")) {
+               if ( !array_key_exists( CACHE_MEMCACHED, $wgCaches ) ) {
+                       if ( !class_exists( 'MemcachedClientforWiki' ) ) {
                                class MemCachedClientforWiki extends memcached {
                                        function _debugprint( $text ) {
-                                               wfDebug( "memcached: $text\n" );
+                                               wfDebug( "memcached: $text" );
                                        }
                                }
                        }
-
-                       $wgCaches[CACHE_DB] = new MemCachedClientforWiki(
+                       $wgCaches[CACHE_MEMCACHED] = new MemCachedClientforWiki(
                                array('persistant' => $wgMemCachedPersistent, 'compress_threshold' => 1500 ) );
-                       $cache =& $wgCaches[CACHE_DB];
-                       $cache->set_servers( $wgMemCachedServers );
-                       $cache->set_debug( $wgMemCachedDebug );
+                       $wgCaches[CACHE_MEMCACHED]->set_servers( $wgMemCachedServers );
+                       $wgCaches[CACHE_MEMCACHED]->set_debug( $wgMemCachedDebug );
                }
+               $cache =& $wgCaches[CACHE_MEMCACHED];
        } elseif ( $type == CACHE_ACCEL ) {
                if ( !array_key_exists( CACHE_ACCEL, $wgCaches ) ) {
                        if ( function_exists( 'eaccelerator_get' ) ) {
@@ -87,7 +88,7 @@ function &wfGetCache( $inputType ) {
                }
                $cache =& $wgCaches[CACHE_DBA];
        }
-       
+
        if ( $type == CACHE_DB || ( $inputType == CACHE_ANYTHING && $cache === false ) ) {
                if ( !array_key_exists( CACHE_DB, $wgCaches ) ) {
                        $wgCaches[CACHE_DB] = new MediaWikiBagOStuff('objectcache');
@@ -105,22 +106,23 @@ 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 );
        return $ret;
 }
-
-