wiki.techinc.nl/includes/libs/objectcache/EmptyBagOStuff.php
Aaron Schulz 5c335f9d77 objectcache: make BagOStuff key encoding more consistent
Add "generic" key methods for quickly deriving keys from
key component lists in a bijective manor. This is useful
for BagOStuff classes that wrap other BagOStuff instances
or for parsing keys to get stats.

Make the proxy BagOStuff classes (ReplicatedBagOStuff,
MultiWriteBagOStuff, CachedBagOStuff) use "generic" keys
so that they can convert to appropriate keys when making
backing cache instance method calls.

Make EmptyBagOStuff, HashBagOStuff, APCUBagOStuff,
RedisBagOStuff, and RESTBagOStuff use "generic" keys rather
than those of MediumSpecificBagOStuff::makeKeyInternal().
This lets proxy BagOStuff classes bypass key conversions
when used with instances of these classes as backing stores.

Also:
* Fix missing incr(), incrWithInit(), and decr() return
  values in MultiWriteBagOStuff.
* Make MultiWriteBagOfStuff, ReplicatedBagOStuff, and
  CachedBagOStuff use similar backend method forwarding
  styles by using a new BagOStuff method.
* Improved various related bits of documentation.

Bug: T250239
Bug: T235705
Change-Id: I1eb897c2cea3f5b756dd1e3c457b7cbd817599f5
2020-12-02 20:20:42 -08:00

77 lines
2.1 KiB
PHP

<?php
/**
* Dummy object caching.
*
* 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 BagOStuff object with no objects in it. Used to provide a no-op object to calling code.
*
* @ingroup Cache
*/
class EmptyBagOStuff extends MediumSpecificBagOStuff {
public function __construct( array $params = [] ) {
parent::__construct( $params );
$this->attrMap[self::ATTR_DURABILITY] = self::QOS_DURABILITY_NONE;
}
protected function doGet( $key, $flags = 0, &$casToken = null ) {
$casToken = null;
return false;
}
protected function doSet( $key, $value, $exptime = 0, $flags = 0 ) {
return true;
}
protected function doDelete( $key, $flags = 0 ) {
return true;
}
protected function doAdd( $key, $value, $exptime = 0, $flags = 0 ) {
return true;
}
public function incr( $key, $value = 1, $flags = 0 ) {
return false;
}
public function decr( $key, $value = 1, $flags = 0 ) {
return false;
}
public function incrWithInit( $key, $exptime, $value = 1, $init = null, $flags = 0 ) {
return false; // faster
}
public function merge( $key, callable $callback, $exptime = 0, $attempts = 10, $flags = 0 ) {
return true; // faster
}
public function makeKeyInternal( $keyspace, $components ) {
return $this->genericKeyFromComponents( $keyspace, ...$components );
}
protected function convertGenericKey( $key ) {
return $key; // short-circuit; already uses "generic" keys
}
}