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
|
<?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
// Override for array access
ArrayAccess {
/**
* Variables for the cache object.
*
* @var array
*/
private $variables;
/**
* Set the constructor.
*/
function __construct() {
$this->variables = array();
}
/**
* Set a cache variable.
*
* @param string $variable
* @param string $value
*/
public function set_variable($variable, $value) {
if (!is_array($this->variables)) {
$this->variables = array();
}
$this->variables[$variable] = $value;
}
/**
* Get variables for this cache.
*
* @param string $variable
* @return mixed The variable or null;
*/
public function get_variable($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
* @return mixed
*/
function __get($key) {
return $this->load($key);
}
/**
* Class member set overloading, setting a key using $this->save defaults.
*
* @param string $key
* @param mixed $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.
*/
function __unset($key) {
return $this->delete($key);
}
/**
* Save data in a cache.
*
* @param string $key
* @param string $data
* @return bool
*/
abstract public function save($key, $data);
/**
* Load data from the cache using a given key.
*
* @param string $key
* @param int $offset
* @param int $limit
* @return mixed The stored data or false.
*/
abstract public function load($key, $offset = 0, $limit = null);
/**
* Invalidate a key
*
* @param string $key
* @return bool
*/
abstract public function delete($key);
/**
* Clear out all the contents of the cache.
*
*/
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
* @param string $data
* @return bool
*/
public function add($key, $data) {
if (!isset($this[$key])) {
return $this->save($key, $data);
}
return false;
}
// ARRAY ACCESS INTERFACE //////////////////////////////////////////////////////////
function offsetSet($key, $value) {
$this->save($key, $value);
}
function offsetGet($key) {
return $this->load($key);
}
function offsetUnset($key) {
if ( isset($this->key) ) {
unset($this->key);
}
}
function offsetExists($offset) {
return isset($this->$offset);
}
}
|
