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
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
|
<?php
abstract class ElggData implements
Loggable, // Can events related to this object class be logged
Iterator, // Override foreach behaviour
ArrayAccess, // Override for array access
Exportable
{
/**
* The main attributes of an entity.
* Holds attributes to save to database
* This contains the site's main properties (id, etc)
* Blank entries for all database fields should be created by the constructor.
* Subclasses should add to this in their constructors.
* Any field not appearing in this will be viewed as a
*/
protected $attributes = array();
/**
* Initialize the attributes array.
*
* This is vital to distinguish between metadata and base parameters.
*
* @return void
*/
protected function initializeAttributes() {
// Create attributes array if not already created
if (!is_array($this->attributes)) {
$this->attributes = array();
}
$this->attributes['time_created'] = '';
}
/**
* Return an attribute or a piece of metadata.
*
* @param string $name Name
*
* @return mixed
*/
public function __get($name) {
return $this->get($name);
}
/**
* Set an attribute or a piece of metadata.
*
* @param string $name Name
* @param mixed $value Value
*
* @return mixed
*/
public function __set($name, $value) {
return $this->set($name, $value);
}
/**
* Test if property is set either as an attribute or metadata.
*
* @tip Use isset($entity->property)
*
* @param string $name The name of the attribute or metadata.
*
* @return bool
*/
function __isset($name) {
return $this->$name !== NULL;
}
abstract protected function get($name);
abstract protected function set($name, $value);
/**
* Get a URL for this object
*
* @return string
*/
abstract public function getURL();
/**
* Save this data to the appropriate database table.
*
* @return bool
*/
abstract public function save();
/**
* Delete this data.
*
* @return bool
*/
abstract public function delete();
/**
* Return the guid of the entity's owner.
*
* @return int The owner GUID
*/
public function getOwner() {
return $this->owner_guid;
}
/**
* Returns the ElggEntity or child object of the owner of the entity.
*
* @return ElggEntity The owning user
*/
public function getOwnerEntity() {
return get_entity($this->owner_guid);
}
/**
* Returns the UNIX epoch time that this entity was created
*
* @return int UNIX epoch time
*/
public function getTimeCreated() {
return $this->time_created;
}
/*
* SYSTEM LOG INTERFACE
*/
/**
* Return the class name of the object.
*
* @return string
*/
public function getClassName() {
return get_class($this);
}
/**
* Return the GUID of the owner of this object.
*
* @return int
*/
public function getObjectOwnerGUID() {
return $this->owner_guid;
}
/*
* ITERATOR INTERFACE
*/
/*
* This lets an entity's attributes be displayed using foreach as a normal array.
* Example: http://www.sitepoint.com/print/php5-standard-library
*/
protected $valid = FALSE;
/**
* Iterator interface
*
* @see Iterator::rewind()
*
* @return void
*/
public function rewind() {
$this->valid = (FALSE !== reset($this->attributes));
}
/**
* Iterator interface
*
* @see Iterator::current()
*
* @return void
*/
public function current() {
return current($this->attributes);
}
/**
* Iterator interface
*
* @see Iterator::key()
*
* @return void
*/
public function key() {
return key($this->attributes);
}
/**
* Iterator interface
*
* @see Iterator::next()
*
* @return void
*/
public function next() {
$this->valid = (FALSE !== next($this->attributes));
}
/**
* Iterator interface
*
* @see Iterator::valid()
*
* @return void
*/
public function valid() {
return $this->valid;
}
/*
* ARRAY ACCESS INTERFACE
*/
/*
* This lets an entity's attributes be accessed like an associative array.
* Example: http://www.sitepoint.com/print/php5-standard-library
*/
/**
* Array access interface
*
* @see ArrayAccess::offsetSet()
*
* @param mixed $key Name
* @param mixed $value Value
*
* @return void
*/
public function offsetSet($key, $value) {
if (array_key_exists($key, $this->attributes)) {
$this->attributes[$key] = $value;
}
}
/**
* Array access interface
*
* @see ArrayAccess::offsetGet()
*
* @param mixed $key Name
*
* @return void
*/
public function offsetGet($key) {
if (array_key_exists($key, $this->attributes)) {
return $this->attributes[$key];
}
}
/**
* Array access interface
*
* @see ArrayAccess::offsetUnset()
*
* @param mixed $key Name
*
* @return void
*/
public function offsetUnset($key) {
if (array_key_exists($key, $this->attributes)) {
// Full unsetting is dangerous for our objects
$this->attributes[$key] = "";
}
}
/**
* Array access interface
*
* @see ArrayAccess::offsetExists()
*
* @param int $offset Offset
*
* @return int
*/
public function offsetExists($offset) {
return array_key_exists($offset, $this->attributes);
}
}
|
