PHPXRef 0.7.1 : MediaWiki-1.24.0 : Detail view of MultiWriteBagOStuff.php

[Source view] [Print] [Project Stats]

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.

File Size:	217 lines (5 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

Defines 1 class

MultiWriteBagOStuff:: (16 methods):
  __construct()
  setDebug()
  get()
  cas()
  set()
  delete()
  add()
  incr()
  decr()
  lock()
  unlock()
  merge()
  getLastError()
  clearLastError()
  doWrite()
  deleteObjectsExpiringBefore()

Class: MultiWriteBagOStuff - X-Ref

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.

__construct( $params ) X-Ref

Constructor. Parameters are:

- 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: array $params

setDebug( $debug ) X-Ref

param: bool $debug

get( $key, &$casToken = null ) X-Ref

param: string $key
param: mixed $casToken [optional]
return: bool|mixed

cas( $casToken, $key, $value, $exptime = 0 ) X-Ref

param: mixed $casToken
param: string $key
param: mixed $value
param: mixed $exptime
return: bool

set( $key, $value, $exptime = 0 ) X-Ref

param: string $key
param: mixed $value
param: int $exptime
return: bool

delete( $key, $time = 0 ) X-Ref

param: string $key
param: int $time
return: bool

add( $key, $value, $exptime = 0 ) X-Ref

param: string $key
param: mixed $value
param: int $exptime
return: bool

incr( $key, $value = 1 ) X-Ref

param: string $key
param: int $value
return: bool|null

decr( $key, $value = 1 ) X-Ref

param: string $key
param: int $value
return: bool

lock( $key, $timeout = 0 ) X-Ref

param: string $key
param: int $timeout
return: bool

unlock( $key ) X-Ref

param: string $key
return: bool

merge( $key, Closure $callback, $exptime = 0, $attempts = 10 ) X-Ref

param: string $key
param: Closure $callback Callback method to be executed
param: int $exptime Either an interval in seconds or a unix timestamp for expiry
param: int $attempts The amount of times to attempt a merge in case of failure
return: bool Success

getLastError() X-Ref

No description

clearLastError() X-Ref

No description

doWrite( $method ) X-Ref

param: string $method
return: bool

deleteObjectsExpiringBefore( $date, $progressCallback = false ) X-Ref

Delete objects expiring before a certain date.

Succeed if any of the child caches succeed.
param: string $date
param: bool|callable $progressCallback
return: bool

PHP Cross Reference of MediaWiki-1.24.0

/includes/objectcache/ -> MultiWriteBagOStuff.php (summary)

Defines 1 class