summaryrefslogtreecommitdiff
path: root/includes/objectcache/MultiWriteBagOStuff.php
diff options
context:
space:
mode:
Diffstat (limited to 'includes/objectcache/MultiWriteBagOStuff.php')
-rw-r--r--includes/objectcache/MultiWriteBagOStuff.php86
1 files changed, 83 insertions, 3 deletions
diff --git a/includes/objectcache/MultiWriteBagOStuff.php b/includes/objectcache/MultiWriteBagOStuff.php
index 0d95a846..e496ddd8 100644
--- a/includes/objectcache/MultiWriteBagOStuff.php
+++ b/includes/objectcache/MultiWriteBagOStuff.php
@@ -1,9 +1,32 @@
<?php
+/**
+ * Wrapper for object caching in different caches.
+ *
+ * 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
+ */
/**
* A cache class that replicates all writes to multiple child caches. Reads
* are implemented by reading from the caches in the order they are given in
* the configuration until a cache gives a positive result.
+ *
+ * @ingroup Cache
*/
class MultiWriteBagOStuff extends BagOStuff {
var $caches;
@@ -11,11 +34,12 @@ class MultiWriteBagOStuff extends BagOStuff {
/**
* Constructor. Parameters are:
*
- * - caches: This should have a numbered array of cache parameter
+ * - caches: This should have a numbered array of cache parameter
* structures, in the style required by $wgObjectCaches. See
* the documentation of $wgObjectCaches for more detail.
*
* @param $params array
+ * @throws MWException
*/
public function __construct( $params ) {
if ( !isset( $params['caches'] ) ) {
@@ -28,10 +52,17 @@ class MultiWriteBagOStuff extends BagOStuff {
}
}
+ /**
+ * @param $debug bool
+ */
public function setDebug( $debug ) {
$this->doWrite( 'setDebug', $debug );
}
+ /**
+ * @param $key string
+ * @return bool|mixed
+ */
public function get( $key ) {
foreach ( $this->caches as $cache ) {
$value = $cache->get( $key );
@@ -42,30 +73,68 @@ class MultiWriteBagOStuff extends BagOStuff {
return false;
}
+ /**
+ * @param $key string
+ * @param $value mixed
+ * @param $exptime int
+ * @return bool
+ */
public function set( $key, $value, $exptime = 0 ) {
return $this->doWrite( 'set', $key, $value, $exptime );
}
+ /**
+ * @param $key string
+ * @param $time int
+ * @return bool
+ */
public function delete( $key, $time = 0 ) {
return $this->doWrite( 'delete', $key, $time );
}
+ /**
+ * @param $key string
+ * @param $value mixed
+ * @param $exptime int
+ * @return bool
+ */
public function add( $key, $value, $exptime = 0 ) {
return $this->doWrite( 'add', $key, $value, $exptime );
}
+ /**
+ * @param $key string
+ * @param $value mixed
+ * @param $exptime int
+ * @return bool
+ */
public function replace( $key, $value, $exptime = 0 ) {
return $this->doWrite( 'replace', $key, $value, $exptime );
}
+ /**
+ * @param $key string
+ * @param $value int
+ * @return bool|null
+ */
public function incr( $key, $value = 1 ) {
return $this->doWrite( 'incr', $key, $value );
}
+ /**
+ * @param $key string
+ * @param $value int
+ * @return bool
+ */
public function decr( $key, $value = 1 ) {
return $this->doWrite( 'decr', $key, $value );
- }
+ }
+ /**
+ * @param $key string
+ * @param $timeout int
+ * @return bool
+ */
public function lock( $key, $timeout = 0 ) {
// Lock only the first cache, to avoid deadlocks
if ( isset( $this->caches[0] ) ) {
@@ -75,6 +144,10 @@ class MultiWriteBagOStuff extends BagOStuff {
}
}
+ /**
+ * @param $key string
+ * @return bool
+ */
public function unlock( $key ) {
if ( isset( $this->caches[0] ) ) {
return $this->caches[0]->unlock( $key );
@@ -83,6 +156,10 @@ class MultiWriteBagOStuff extends BagOStuff {
}
}
+ /**
+ * @param $method string
+ * @return bool
+ */
protected function doWrite( $method /*, ... */ ) {
$ret = true;
$args = func_get_args();
@@ -97,9 +174,12 @@ class MultiWriteBagOStuff extends BagOStuff {
}
/**
- * Delete objects expiring before a certain date.
+ * Delete objects expiring before a certain date.
*
* Succeed if any of the child caches succeed.
+ * @param $date string
+ * @param $progressCallback bool|callback
+ * @return bool
*/
public function deleteObjectsExpiringBefore( $date, $progressCallback = false ) {
$ret = false;