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
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
|
<?php
/**
* ElggCache The elgg cache superclass.
* This defines the interface for a cache (wherever that cache is stored).
*
* @package Elgg.Core
* @subpackage Cache
*/
abstract class ElggCache implements ArrayAccess {
/**
* Variables for the cache object.
*
* @var array
*/
private $variables;
/**
* Set the constructor.
*/
function __construct() {
$this->variables = array();
}
// @codingStandardsIgnoreStart
/**
* Set a cache variable.
*
* @param string $variable Name
* @param string $value Value
*
* @return void
*
* @deprecated 1.8 Use ElggCache:setVariable()
*/
public function set_variable($variable, $value) {
elgg_deprecated_notice('ElggCache::set_variable() is deprecated by ElggCache::setVariable()', 1.8);
$this->setVariable($variable, $value);
}
// @codingStandardsIgnoreEnd
/**
* Set a cache variable.
*
* @param string $variable Name
* @param string $value Value
*
* @return void
*/
public function setVariable($variable, $value) {
if (!is_array($this->variables)) {
$this->variables = array();
}
$this->variables[$variable] = $value;
}
// @codingStandardsIgnoreStart
/**
* Get variables for this cache.
*
* @param string $variable Name
*
* @return mixed The value or null;
*
* @deprecated 1.8 Use ElggCache::getVariable()
*/
public function get_variable($variable) {
elgg_deprecated_notice('ElggCache::get_variable() is deprecated by ElggCache::getVariable()', 1.8);
return $this->getVariable($variable);
}
// @codingStandardsIgnoreEnd
/**
* Get variables for this cache.
*
* @param string $variable Name
*
* @return mixed The variable or null;
*/
public function getVariable($variable) {
if (isset($this->variables[$variable])) {
return $this->variables[$variable];
}
return null;
}
/**
* Class member get overloading, returning key using $this->load defaults.
*
* @param string $key Name
*
* @return mixed
*/
function __get($key) {
return $this->load($key);
}
/**
* Class member set overloading, setting a key using $this->save defaults.
*
* @param string $key Name
* @param mixed $value Value
*
* @return mixed
*/
function __set($key, $value) {
return $this->save($key, $value);
}
/**
* Supporting isset, using $this->load() with default values.
*
* @param string $key The name of the attribute or metadata.
*
* @return bool
*/
function __isset($key) {
return (bool)$this->load($key);
}
/**
* Supporting unsetting of magic attributes.
*
* @param string $key The name of the attribute or metadata.
*
* @return bool
*/
function __unset($key) {
return $this->delete($key);
}
/**
* Save data in a cache.
*
* @param string $key Name
* @param string $data Value
*
* @return bool
*/
abstract public function save($key, $data);
/**
* Load data from the cache using a given key.
*
* @todo $offset is a horrible variable name because it creates confusion
* with the ArrayAccess methods
*
* @param string $key Name
* @param int $offset Offset
* @param int $limit Limit
*
* @return mixed The stored data or false.
*/
abstract public function load($key, $offset = 0, $limit = null);
/**
* Invalidate a key
*
* @param string $key Name
*
* @return bool
*/
abstract public function delete($key);
/**
* Clear out all the contents of the cache.
*
* @return bool
*/
abstract public function clear();
/**
* Add a key only if it doesn't already exist.
* Implemented simply here, if you extend this class and your caching engine
* provides a better way then override this accordingly.
*
* @param string $key Name
* @param string $data Value
*
* @return bool
*/
public function add($key, $data) {
if (!isset($this[$key])) {
return $this->save($key, $data);
}
return false;
}
// ARRAY ACCESS INTERFACE //////////////////////////////////////////////////////////
/**
* Assigns a value for the specified key
*
* @see ArrayAccess::offsetSet()
*
* @param mixed $key The key (offset) to assign the value to.
* @param mixed $value The value to set.
*
* @return void
*/
function offsetSet($key, $value) {
$this->save($key, $value);
}
/**
* Get the value for specified key
*
* @see ArrayAccess::offsetGet()
*
* @param mixed $key The key (offset) to retrieve.
*
* @return mixed
*/
function offsetGet($key) {
return $this->load($key);
}
/**
* Unsets a key.
*
* @see ArrayAccess::offsetUnset()
*
* @param mixed $key The key (offset) to unset.
*
* @return void
*/
function offsetUnset($key) {
if (isset($this->$key)) {
unset($this->$key);
}
}
/**
* Does key exist
*
* @see ArrayAccess::offsetExists()
*
* @param mixed $key A key (offset) to check for.
*
* @return bool
*/
function offsetExists($key) {
return isset($this->$key);
}
}
|
