includes/objectcache/HashBagOStuff.php

   1 <?php
   2 /**
   3  * Object caching using PHP arrays.
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  * @ingroup Cache
  22  */
  23
  24 /**
  25  * This is a test of the interface, mainly. It stores things in an associative
  26  * array, which is not going to persist between program runs.
  27  *
  28  * @ingroup Cache
  29  */
  30 class HashBagOStuff extends BagOStuff {
  31         /** @var array */
  32         protected $bag;
  33
  34         function __construct( $params = array() ) {
  35                 parent::__construct( $params );
  36                 $this->bag = array();
  37         }
  38
  39         /**
  40          * @param string $key
  41          * @return bool
  42          */
  43         protected function expire( $key ) {
  44                 $et = $this->bag[$key][1];
  45
  46                 if ( ( $et == 0 ) || ( $et > time() ) ) {
  47                         return false;
  48                 }
  49
  50                 $this->delete( $key );
  51
  52                 return true;
  53         }
  54
  55         /**
  56          * @param string $key
  57          * @param mixed $casToken [optional]
  58          * @return bool|mixed
  59          */
  60         function get( $key, &$casToken = null ) {
  61                 if ( !isset( $this->bag[$key] ) ) {
  62                         return false;
  63                 }
  64
  65                 if ( $this->expire( $key ) ) {
  66                         return false;
  67                 }
  68
  69                 $casToken = $this->bag[$key][0];
  70
  71                 return $this->bag[$key][0];
  72         }
  73
  74         /**
  75          * @param string $key
  76          * @param mixed $value
  77          * @param int $exptime
  78          * @return bool
  79          */
  80         function set( $key, $value, $exptime = 0 ) {
  81                 $this->bag[$key] = array( $value, $this->convertExpiry( $exptime ) );
  82                 return true;
  83         }
  84
  85         /**
  86          * @param mixed $casToken
  87          * @param string $key
  88          * @param mixed $value
  89          * @param int $exptime
  90          * @return bool
  91          */
  92         function cas( $casToken, $key, $value, $exptime = 0 ) {
  93                 if ( $this->get( $key ) === $casToken ) {
  94                         return $this->set( $key, $value, $exptime );
  95                 }
  96
  97                 return false;
  98         }
  99
 100         /**
 101          * @param string $key
 102          * @return bool
 103          */
 104         function delete( $key ) {
 105                 if ( !isset( $this->bag[$key] ) ) {
 106                         return false;
 107                 }
 108
 109                 unset( $this->bag[$key] );
 110
 111                 return true;
 112         }
 113 }