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 $bag;
  32
  33         function __construct() {
  34                 $this->bag = array();
  35         }
  36
  37         /**
  38          * @param $key string
  39          * @return bool
  40          */
  41         protected function expire( $key ) {
  42                 $et = $this->bag[$key][1];
  43
  44                 if ( ( $et == 0 ) || ( $et > time() ) ) {
  45                         return false;
  46                 }
  47
  48                 $this->delete( $key );
  49
  50                 return true;
  51         }
  52
  53         /**
  54          * @param $key string
  55          * @param $casToken[optional] mixed
  56          * @return bool|mixed
  57          */
  58         function get( $key, &$casToken = null ) {
  59                 if ( !isset( $this->bag[$key] ) ) {
  60                         return false;
  61                 }
  62
  63                 if ( $this->expire( $key ) ) {
  64                         return false;
  65                 }
  66
  67                 $casToken = $this->bag[$key][0];
  68
  69                 return $this->bag[$key][0];
  70         }
  71
  72         /**
  73          * @param $key string
  74          * @param $value mixed
  75          * @param $exptime int
  76          * @return bool
  77          */
  78         function set( $key, $value, $exptime = 0 ) {
  79                 $this->bag[$key] = array( $value, $this->convertExpiry( $exptime ) );
  80                 return true;
  81         }
  82
  83         /**
  84          * @param $casToken mixed
  85          * @param $key string
  86          * @param $value mixed
  87          * @param $exptime int
  88          * @return bool
  89          */
  90         function cas( $casToken, $key, $value, $exptime = 0 ) {
  91                 if ( $this->get( $key ) === $casToken ) {
  92                         return $this->set( $key, $value, $exptime );
  93                 }
  94
  95                 return false;
  96         }
  97
  98         /**
  99          * @param $key string
 100          * @param $time int
 101          * @return bool
 102          */
 103         function delete( $key, $time = 0 ) {
 104                 if ( !isset( $this->bag[$key] ) ) {
 105                         return false;
 106                 }
 107
 108                 unset( $this->bag[$key] );
 109
 110                 return true;
 111         }
 112 }
 113