inc/classes/main/cache/class_MemoryCache.php

   1 <?php
   2 /**
   3  * A simple memory cache (similar to a registry)
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, this is free software
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.ship-simu.org
  10  *
  11  * This program is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation, either version 3 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  23  */
  24 class MemoryCache extends BaseFrameworkSystem implements Cacheable {
  25         /**
  26          * The "memory cache" is simply a wrapped object array
  27          */
  28         private $dataCache = null;
  29
  30         /**
  31          * Protected constructor
  32          *
  33          * @return      void
  34          */
  35         protected function __construct () {
  36                 // Call parent constructor
  37                 parent::__construct(__CLASS__);
  38
  39                 // Clean up a little
  40                 $this->removeNumberFormaters();
  41                 $this->removeSystemArray();
  42         }
  43
  44         /**
  45          * Creates an instance of this class
  46          *
  47          * @return      $cacheInstance  An instance of this cache class
  48          */
  49         public final static function createMemoryCache () {
  50                 // Get a new instance
  51                 $cacheInstance = new MemoryCache();
  52
  53                 // Initialize the cache
  54                 $cacheInstance->initCache();
  55
  56                 // Return the prepared instance
  57                 return $cacheInstance;
  58         }
  59
  60         /**
  61          * Initialize this cache by creating an object array
  62          *
  63          * @return      void
  64          */
  65         protected function initCache () {
  66                 // Now create the "data cache"
  67                 $this->dataCache = new FrameworkArrayObject('FakedDataCache');
  68         }
  69
  70         /**
  71          * Does the specified offset exist in cache?
  72          *
  73          * @param       $offset         The offset we are looking for
  74          * @return      $exists         Wether the offset exists
  75          */
  76         public final function offsetExists ($offset) {
  77                 $exists = $this->dataCache->offsetExists($offset);
  78                 return $exists;
  79         }
  80
  81         /**
  82          * Setter for cache offset
  83          *
  84          * @param       $offset         The offset we shall set
  85          * @param       $data           Data to store in the cache
  86          * @return      void
  87          */
  88         public final function offsetSet ($offset, $data) {
  89                 $this->dataCache->offsetSet($offset, $data);
  90         }
  91
  92         /**
  93          * Getter for cache offset or "null" if not found
  94          *
  95          * @param       $offset         The offset we shall set
  96          * @return      $data           Data to store in the cache
  97          */
  98         public final function offsetGet ($offset) {
  99                 // Default is offset not found
 100                 $data = null;
 101
 102                 // Is the offset there?
 103                 if ($this->offsetExists($offset)) {
 104                         // Then get the data from it
 105                         $data = $this->dataCache->offsetGet($offset);
 106                 }
 107
 108                 // Return data
 109                 return $data;
 110         }
 111 }
 112
 113 // [EOF]
 114 ?>