includes/libs/objectcache/EmptyBagOStuff.php

   1 <?php
   2 /**
   3  * This program is free software; you can redistribute it and/or modify
   4  * it under the terms of the GNU General Public License as published by
   5  * the Free Software Foundation; either version 2 of the License, or
   6  * (at your option) any later version.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License along
  14  * with this program; if not, write to the Free Software Foundation, Inc.,
  15  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  16  * http://www.gnu.org/copyleft/gpl.html
  17  *
  18  * @file
  19  */
  20 namespace Wikimedia\ObjectCache;
  21
  22 /**
  23  * No-op implementation that stores nothing.
  24  *
  25  * Used as placeholder or fallback when disabling caching.
  26  *
  27  * This can be used in configuration via the CACHE_NONE constant.
  28  *
  29  * @ingroup Cache
  30  */
  31 class EmptyBagOStuff extends MediumSpecificBagOStuff {
  32         public function __construct( array $params = [] ) {
  33                 parent::__construct( $params );
  34
  35                 $this->attrMap[self::ATTR_DURABILITY] = self::QOS_DURABILITY_NONE;
  36         }
  37
  38         protected function doGet( $key, $flags = 0, &$casToken = null ) {
  39                 $casToken = null;
  40
  41                 return false;
  42         }
  43
  44         protected function doSet( $key, $value, $exptime = 0, $flags = 0 ) {
  45                 return true;
  46         }
  47
  48         protected function doDelete( $key, $flags = 0 ) {
  49                 return true;
  50         }
  51
  52         protected function doAdd( $key, $value, $exptime = 0, $flags = 0 ) {
  53                 return true;
  54         }
  55
  56         protected function doIncrWithInit( $key, $exptime, $step, $init, $flags ) {
  57                 // faster
  58                 return $init;
  59         }
  60
  61         public function merge( $key, callable $callback, $exptime = 0, $attempts = 10, $flags = 0 ) {
  62                 // faster
  63                 return true;
  64         }
  65 }
  66
  67 /** @deprecated class alias since 1.43 */
  68 class_alias( EmptyBagOStuff::class, 'EmptyBagOStuff' );