1 files changed, 44 insertions, 0 deletions
diff --git a/includes/objectcache/HashBagOStuff.php b/includes/objectcache/HashBagOStuff.php
index 36773306..799f26a3 100644
--- a/includes/objectcache/HashBagOStuff.php
+++ b/includes/objectcache/HashBagOStuff.php
@@ -1,4 +1,25 @@
 <?php
+/**
+ * Object caching using PHP arrays.
+ *
+ * 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
+ */
 
 /**
  * This is a test of the interface, mainly. It stores things in an associative
@@ -13,6 +34,10 @@ class HashBagOStuff extends BagOStuff {
 		$this->bag = array();
 	}
 
+	/**
+	 * @param $key string
+	 * @return bool
+	 */
 	protected function expire( $key ) {
 		$et = $this->bag[$key][1];
 
@@ -25,6 +50,10 @@ class HashBagOStuff extends BagOStuff {
 		return true;
 	}
 
+	/**
+	 * @param $key string
+	 * @return bool|mixed
+	 */
 	function get( $key ) {
 		if ( !isset( $this->bag[$key] ) ) {
 			return false;
@@ -37,10 +66,22 @@ class HashBagOStuff extends BagOStuff {
 		return $this->bag[$key][0];
 	}
 
+	/**
+	 * @param $key string
+	 * @param $value mixed
+	 * @param $exptime int
+	 * @return bool
+	 */
 	function set( $key, $value, $exptime = 0 ) {
 		$this->bag[$key] = array( $value, $this->convertExpiry( $exptime ) );
+		return true;
 	}
 
+	/**
+	 * @param $key string
+	 * @param $time int
+	 * @return bool
+	 */
 	function delete( $key, $time = 0 ) {
 		if ( !isset( $this->bag[$key] ) ) {
 			return false;
@@ -51,6 +92,9 @@ class HashBagOStuff extends BagOStuff {
 		return true;
 	}
 
+	/**
+	 * @return array
+	 */
 	function keys() {
 		return array_keys( $this->bag );
 	}