From: Aaron Schulz <aschulz@wikimedia.org>
Date: Mon, 10 Nov 2014 17:32:46 +0000 (-0800)
Subject: Moved MapCacheLRU to libs/
X-Git-Tag: 1.31.0-rc.0~13329
X-Git-Url: https://git.cyclocoop.org/%27.WWW_URL.%27admin/?a=commitdiff_plain;h=93d2167ca60d620eb1325be04e7a3d8a885f5587;p=lhc%2Fweb%2Fwiklou.git

Moved MapCacheLRU to libs/

Change-Id: Icb820787afe7298dd3124f5168d3efff19e53ab6
---

diff --git a/includes/AutoLoader.php b/includes/AutoLoader.php
index 9f9deb7557..af86c99f4e 100644
--- a/includes/AutoLoader.php
+++ b/includes/AutoLoader.php
@@ -346,7 +346,7 @@ $wgAutoloadLocalClasses = array(
 	'LinkCache' => 'includes/cache/LinkCache.php',
 	'LocalisationCache' => 'includes/cache/LocalisationCache.php',
 	'LocalisationCacheBulkLoad' => 'includes/cache/LocalisationCache.php',
-	'MapCacheLRU' => 'includes/cache/MapCacheLRU.php',
+	'MapCacheLRU' => 'includes/libs/MapCacheLRU.php',
 	'MessageCache' => 'includes/cache/MessageCache.php',
 	'ObjectFileCache' => 'includes/cache/ObjectFileCache.php',
 	'ResourceFileCache' => 'includes/cache/ResourceFileCache.php',
diff --git a/includes/cache/MapCacheLRU.php b/includes/cache/MapCacheLRU.php
deleted file mode 100644
index 95e3af769e..0000000000
--- a/includes/cache/MapCacheLRU.php
+++ /dev/null
@@ -1,123 +0,0 @@
-<?php
-/**
- * Per-process memory cache for storing items.
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License along
- * with this program; if not, write to the Free Software Foundation, Inc.,
- * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
- * http://www.gnu.org/copyleft/gpl.html
- *
- * @file
- * @ingroup Cache
- */
-
-/**
- * Handles a simple LRU key/value map with a maximum number of entries
- *
- * Use ProcessCacheLRU if hierarchical purging is needed or objects can become stale
- *
- * @see ProcessCacheLRU
- * @ingroup Cache
- * @since 1.23
- */
-class MapCacheLRU {
-	/** @var array */
-	protected $cache = array(); // (key => value)
-
-	protected $maxCacheKeys; // integer; max entries
-
-	/**
-	 * @param int $maxKeys Maximum number of entries allowed (min 1).
-	 * @throws MWException When $maxCacheKeys is not an int or =< 0.
-	 */
-	public function __construct( $maxKeys ) {
-		if ( !is_int( $maxKeys ) || $maxKeys < 1 ) {
-			throw new MWException( __METHOD__ . " must be given an integer and >= 1" );
-		}
-		$this->maxCacheKeys = $maxKeys;
-	}
-
-	/**
-	 * Set a key/value pair.
-	 * This will prune the cache if it gets too large based on LRU.
-	 * If the item is already set, it will be pushed to the top of the cache.
-	 *
-	 * @param string $key
-	 * @param mixed $value
-	 * @return void
-	 */
-	public function set( $key, $value ) {
-		if ( array_key_exists( $key, $this->cache ) ) {
-			$this->ping( $key ); // push to top
-		} elseif ( count( $this->cache ) >= $this->maxCacheKeys ) {
-			reset( $this->cache );
-			$evictKey = key( $this->cache );
-			unset( $this->cache[$evictKey] );
-		}
-		$this->cache[$key] = $value;
-	}
-
-	/**
-	 * Check if a key exists
-	 *
-	 * @param string $key
-	 * @return bool
-	 */
-	public function has( $key ) {
-		return array_key_exists( $key, $this->cache );
-	}
-
-	/**
-	 * Get the value for a key.
-	 * This returns null if the key is not set.
-	 * If the item is already set, it will be pushed to the top of the cache.
-	 *
-	 * @param string $key
-	 * @return mixed
-	 */
-	public function get( $key ) {
-		if ( array_key_exists( $key, $this->cache ) ) {
-			$this->ping( $key ); // push to top
-			return $this->cache[$key];
-		} else {
-			return null;
-		}
-	}
-
-	/**
-	 * Clear one or several cache entries, or all cache entries
-	 *
-	 * @param string|array $keys
-	 * @return void
-	 */
-	public function clear( $keys = null ) {
-		if ( $keys === null ) {
-			$this->cache = array();
-		} else {
-			foreach ( (array)$keys as $key ) {
-				unset( $this->cache[$key] );
-			}
-		}
-	}
-
-	/**
-	 * Push an entry to the top of the cache
-	 *
-	 * @param string $key
-	 */
-	protected function ping( $key ) {
-		$item = $this->cache[$key];
-		unset( $this->cache[$key] );
-		$this->cache[$key] = $item;
-	}
-}
diff --git a/includes/libs/MapCacheLRU.php b/includes/libs/MapCacheLRU.php
new file mode 100644
index 0000000000..2a7ee2a671
--- /dev/null
+++ b/includes/libs/MapCacheLRU.php
@@ -0,0 +1,123 @@
+<?php
+/**
+ * Per-process memory cache for storing items.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
+ * @ingroup Cache
+ */
+
+/**
+ * Handles a simple LRU key/value map with a maximum number of entries
+ *
+ * Use ProcessCacheLRU if hierarchical purging is needed or objects can become stale
+ *
+ * @see ProcessCacheLRU
+ * @ingroup Cache
+ * @since 1.23
+ */
+class MapCacheLRU {
+	/** @var array */
+	protected $cache = array(); // (key => value)
+
+	protected $maxCacheKeys; // integer; max entries
+
+	/**
+	 * @param int $maxKeys Maximum number of entries allowed (min 1).
+	 * @throws Exception When $maxCacheKeys is not an int or =< 0.
+	 */
+	public function __construct( $maxKeys ) {
+		if ( !is_int( $maxKeys ) || $maxKeys < 1 ) {
+			throw new Exception( __METHOD__ . " must be given an integer and >= 1" );
+		}
+		$this->maxCacheKeys = $maxKeys;
+	}
+
+	/**
+	 * Set a key/value pair.
+	 * This will prune the cache if it gets too large based on LRU.
+	 * If the item is already set, it will be pushed to the top of the cache.
+	 *
+	 * @param string $key
+	 * @param mixed $value
+	 * @return void
+	 */
+	public function set( $key, $value ) {
+		if ( array_key_exists( $key, $this->cache ) ) {
+			$this->ping( $key ); // push to top
+		} elseif ( count( $this->cache ) >= $this->maxCacheKeys ) {
+			reset( $this->cache );
+			$evictKey = key( $this->cache );
+			unset( $this->cache[$evictKey] );
+		}
+		$this->cache[$key] = $value;
+	}
+
+	/**
+	 * Check if a key exists
+	 *
+	 * @param string $key
+	 * @return bool
+	 */
+	public function has( $key ) {
+		return array_key_exists( $key, $this->cache );
+	}
+
+	/**
+	 * Get the value for a key.
+	 * This returns null if the key is not set.
+	 * If the item is already set, it will be pushed to the top of the cache.
+	 *
+	 * @param string $key
+	 * @return mixed
+	 */
+	public function get( $key ) {
+		if ( array_key_exists( $key, $this->cache ) ) {
+			$this->ping( $key ); // push to top
+			return $this->cache[$key];
+		} else {
+			return null;
+		}
+	}
+
+	/**
+	 * Clear one or several cache entries, or all cache entries
+	 *
+	 * @param string|array $keys
+	 * @return void
+	 */
+	public function clear( $keys = null ) {
+		if ( $keys === null ) {
+			$this->cache = array();
+		} else {
+			foreach ( (array)$keys as $key ) {
+				unset( $this->cache[$key] );
+			}
+		}
+	}
+
+	/**
+	 * Push an entry to the top of the cache
+	 *
+	 * @param string $key
+	 */
+	protected function ping( $key ) {
+		$item = $this->cache[$key];
+		unset( $this->cache[$key] );
+		$this->cache[$key] = $item;
+	}
+}