6555c4953da5cfc52ef0fb49192a56d70eaede79
[core.git] / 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, 2009, 2010 Core Developer Team
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
40         /**
41          * Creates an instance of this class
42          *
43          * @return      $cacheInstance  An instance of this cache class
44          */
45         public static final function createMemoryCache () {
46                 // Get a new instance
47                 $cacheInstance = new MemoryCache();
48
49                 // Initialize the cache
50                 $cacheInstance->initCache();
51
52                 // Return the prepared instance
53                 return $cacheInstance;
54         }
55
56         /**
57          * Initialize this cache by creating an object array
58          *
59          * @return      void
60          */
61         protected function initCache () {
62                 // Now create the "data cache"
63                 $this->dataCache = new FrameworkArrayObject('FakedDataCache');
64         }
65
66         /**
67          * Does the specified offset exist in cache?
68          *
69          * @param       $offset         The offset we are looking for
70          * @return      $exists         Wether the offset exists
71          */
72         public final function offsetExists ($offset) {
73                 $exists = $this->dataCache->offsetExists($offset);
74                 return $exists;
75         }
76
77         /**
78          * Setter for cache offset
79          *
80          * @param       $offset         The offset we shall set
81          * @param       $data           Data to store in cache
82          * @return      void
83          */
84         public final function offsetSet ($offset, $data) {
85                 $this->dataCache->offsetSet($offset, $data);
86         }
87
88         /**
89          * Getter for cache offset or "null" if not found
90          *
91          * @param       $offset         The offset we shall set
92          * @return      $data           Data to store in cache
93          */
94         public final function offsetGet ($offset) {
95                 // Default is offset not found
96                 $data = null;
97
98                 // Is the offset there?
99                 if ($this->offsetExists($offset)) {
100                         // Then get the data from it
101                         $data = $this->dataCache->offsetGet($offset);
102                 }
103
104                 // Return data
105                 return $data;
106         }
107 }
108
109 // [EOF]
110 ?>