summaryrefslogtreecommitdiff
path: root/framework/DataAccess/SQLMap/DataMapper/TSqlMapCache.php
blob: 4d3198691de0a2a72637ddb8fc19864b775e6ccd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
<?php
/**
 * TSqlMapCache class file contains FIFO, LRU, and GLOBAL cache implementations.
 *
 * @author Wei Zhuo <weizhuo[at]gmail[dot]com>
 * @link http://www.pradosoft.com/
 * @copyright Copyright &copy; 2005 PradoSoft
 * @license http://www.pradosoft.com/license/
 * @version $Id$
 * @package System.DataAccess.SQLMap
 */

interface ISqLMapCache
{
	public function remove($key);

	public function flush();

	public function get($key);

	public function set($key, $value);

	public function configure($model, $properties);
}

/**
 * Allow different implementation of caching strategy. See <tt>TSqlMapFifoCache</tt>
 * for a first-in-first-out implementation. See <tt>TSqlMapLruCache</tt> for
 * a least-recently-used cache implementation.
 *
 * @author Wei Zhuo <weizhuo[at]gmail[dot]com>
 * @version $Id$
 * @package System.DataAccess.SQLMap
 * @since 3.0
 */
abstract class TSqlMapCache implements ISqlMapCache
{
	protected $_keyList;
	protected $_cache;
	protected $_cacheSize = 100;

	/**
	 * Create a new cache with limited cache size.
	 * @param integer maxium number of items to cache.
	 */
	public function __construct($cacheSize=100)
	{
		$this->_cache = new TMap;
		$this->_cacheSize = intval($cacheSize);
		$this->_keyList = new TList;
	}

	/**
	 * Configures the Cache Size.
	 * @param array list of properties
	 */
	public function configure($model, $properties)
	{
		if(isset($properties['size']))
			$this->_cacheSize = intval($properties['size']);
	}

	/**
	 * @return object the object removed if exists, null otherwise.
	 */
	public function remove($key)
	{
		$object = $this->get($key);
		$this->_cache->remove($key);
		$this->_keyList->remove($key);
		return $object;
	}

	/**
	 * Clears the cache.
	 */
	public function flush()
	{
		$this->_keyList->clear();
		$this->_cache->clear();
	}

}

/**
 * First-in-First-out cache implementation, removes
 * object that was first added when the cache is full.
 *
 * @author Wei Zhuo <weizhuo[at]gmail[dot]com>
 * @version $Id$
 * @package System.DataAccess.SQLMap
 * @since 3.0
 */
class TSqlMapFifoCache extends TSqlMapCache
{
	/**
	 * @return mixed Gets a cached object with the specified key.
	 */
	public function get($key)
	{
		return $this->_cache->itemAt($key);
	}

	/**
	 * Adds an item with the specified key and value into cached data.
	 * @param string cache key
	 * @param mixed value to cache.
	 */
	public function set($key, $value)
	{
		$this->_cache->add($key, $value);
		$this->_keyList->add($key);
		if($this->_keyList->getCount() > $this->_cacheSize)
		{
			$oldestKey = $this->_keyList->removeAt(0);
			$this->_cache->remove($oldestKey);
		}
	}
}

/**
 * Least recently used cache implementation, removes
 * object that was accessed last when the cache is full.
 *
 * @author Wei Zhuo <weizhuo[at]gmail[dot]com>
 * @version $Id$
 * @package System.DataAccess.SQLMap
 * @since 3.0
 */
class TSqlMapLruCache extends TSqlMapCache
{
	/**
	 * @return mixed Gets a cached object with the specified key.
	 */
	public function get($key)
	{
		if($this->_keyList->contains($key))
		{
			$this->_keyList->remove($key);
			$this->_keyList->add($key);
			return $this->_cache->itemAt($key);
		}
		else
			return null;
	}

	/**
	 * Adds an item with the specified key and value into cached data.
	 * @param string cache key
	 * @param mixed value to cache.
	 */
	public function set($key, $value)
	{
		$this->_cache->add($key, $value);
		$this->_keyList->add($key);
		if($this->_keyList->getCount() > $this->_cacheSize)
		{
			$oldestKey = $this->_keyList->removeAt(0);
			$this->_cache->remove($oldestKey);
		}
	}
}

class TSqlMapApplicationCache implements ISqlMapCache
{ 
	private $_cache;
	private $_expiry=0;
	private $_property=array();	
	private $_cacheModelID;
	
	public function __sleep()
	{
		$this->_cache = null;
		return array_keys(get_object_vars($this));
	}
				
	public function remove($key)
	{
		$this->getCache()->delete($key);
	}

	public function flush()
	{
		$this->getCache()->flush();
	}

	public function get($key)
	{
		$result = $this->getCache()->get($key);
		return $result === false ? null : $result;			
	}

	public function set($key, $value)
	{
		$this->getCache()->set($key, $value, $this->_expiry);
	}

	public function configure($model, $properties)
	{
		$this->_property = $properties;
		$this->_cacheModelID = $model->getID();
	}		
	
	protected function getCache()
	{
		if(is_null($this->_cache))
			$this->initialize();
		return $this->_cache;
	}
	
	protected function initialize()
	{
		if(isset($this->_property['expiry']))
			$this->_expiry = intval($this->_property['expiry']);
			
		if(isset($this->_property['cacheModule']))
		{
			$id = $this->_property['cacheModule'];
			$this->_cache = Prado::getApplication()->getModule($id);
		}	
		else
		{
			$this->_cache = Prado::getApplication()->getCache();
		}
			
		if(!($this->_cache instanceof ICache))
			throw new TSqlMapConfigurationException(
				'sqlmap_invalid_prado_cache', $this->_cacheModelID);			
	}
}

?>