MediaWiki REL1_31
ReplicatedBagOStuff.php
Go to the documentation of this file.
1<?php
21use Wikimedia\ObjectFactory;
22
36 protected $writeStore;
38 protected $readStore;
39
50 public function __construct( $params ) {
51 parent::__construct( $params );
52
53 if ( !isset( $params['writeFactory'] ) ) {
54 throw new InvalidArgumentException(
55 __METHOD__ . ': the "writeFactory" parameter is required' );
56 }
57 if ( !isset( $params['readFactory'] ) ) {
58 throw new InvalidArgumentException(
59 __METHOD__ . ': the "readFactory" parameter is required' );
60 }
61
62 $opts = [ 'reportDupes' => false ]; // redundant
63 $this->writeStore = ( $params['writeFactory'] instanceof BagOStuff )
64 ? $params['writeFactory']
65 : ObjectFactory::getObjectFromSpec( $opts + $params['writeFactory'] );
66 $this->readStore = ( $params['readFactory'] instanceof BagOStuff )
67 ? $params['readFactory']
68 : ObjectFactory::getObjectFromSpec( $opts + $params['readFactory'] );
69 $this->attrMap = $this->mergeFlagMaps( [ $this->readStore, $this->writeStore ] );
70 }
71
72 public function setDebug( $debug ) {
73 $this->writeStore->setDebug( $debug );
74 $this->readStore->setDebug( $debug );
75 }
76
77 protected function doGet( $key, $flags = 0 ) {
78 return ( $flags & self::READ_LATEST )
79 ? $this->writeStore->get( $key, $flags )
80 : $this->readStore->get( $key, $flags );
81 }
82
83 public function getMulti( array $keys, $flags = 0 ) {
84 return ( $flags & self::READ_LATEST )
85 ? $this->writeStore->getMulti( $keys, $flags )
86 : $this->readStore->getMulti( $keys, $flags );
87 }
88
89 public function set( $key, $value, $exptime = 0, $flags = 0 ) {
90 return $this->writeStore->set( $key, $value, $exptime, $flags );
91 }
92
93 public function delete( $key ) {
94 return $this->writeStore->delete( $key );
95 }
96
97 public function add( $key, $value, $exptime = 0 ) {
98 return $this->writeStore->add( $key, $value, $exptime );
99 }
100
101 public function incr( $key, $value = 1 ) {
102 return $this->writeStore->incr( $key, $value );
103 }
104
105 public function decr( $key, $value = 1 ) {
106 return $this->writeStore->decr( $key, $value );
107 }
108
109 public function lock( $key, $timeout = 6, $expiry = 6, $rclass = '' ) {
110 return $this->writeStore->lock( $key, $timeout, $expiry, $rclass );
111 }
112
113 public function unlock( $key ) {
114 return $this->writeStore->unlock( $key );
115 }
116
117 public function merge( $key, callable $callback, $exptime = 0, $attempts = 10, $flags = 0 ) {
118 return $this->writeStore->merge( $key, $callback, $exptime, $attempts, $flags );
119 }
120
121 public function getLastError() {
122 return ( $this->writeStore->getLastError() != self::ERR_NONE )
123 ? $this->writeStore->getLastError()
124 : $this->readStore->getLastError();
125 }
126
127 public function clearLastError() {
128 $this->writeStore->clearLastError();
129 $this->readStore->clearLastError();
130 }
131}
interface is intended to be more or less compatible with the PHP memcached client.
Definition BagOStuff.php:47
mergeFlagMaps(array $bags)
Merge the flag maps of one or more BagOStuff objects into a "lowest common denominator" map.
A cache class that directs writes to one set of servers and reads to another.
__construct( $params)
Constructor.
decr( $key, $value=1)
Decrease stored value of $key by $value while preserving its TTL.
add( $key, $value, $exptime=0)
clearLastError()
Clear the "last error" registry.
incr( $key, $value=1)
Increase stored value of $key by $value while preserving its TTL.
lock( $key, $timeout=6, $expiry=6, $rclass='')
Acquire an advisory lock on a key string.
getLastError()
Get the "last error" registered; clearLastError() should be called manually.
getMulti(array $keys, $flags=0)
Get an associative array containing the item for each of the keys that have items.
merge( $key, callable $callback, $exptime=0, $attempts=10, $flags=0)
Merge changes into the existing cache value (possibly creating a new one)
unlock( $key)
Release an advisory lock on a key string.
processing should stop and the error should be shown to the user * false
Definition hooks.txt:187
$debug
Definition mcc.php:31
$params