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
|
<?php
/**
* The base class for ElggEntity extenders.
*
* Extenders allow you to attach extended information to an
* ElggEntity. Core supports two: ElggAnnotation and ElggMetadata.
*
* Saving the extender data to database is handled by the child class.
*
* @tip Plugin authors would probably want to extend either ElggAnnotation
* or ElggMetadata instead of this class.
*
* @package Elgg.Core
* @subpackage DataModel.Extender
* @link http://docs.elgg.org/DataModel/Extenders
* @see ElggAnnotation
* @see ElggMetadata
*
* @property string $type annotation or metadata (read-only after save)
* @property int $id The unique identifier (read-only)
* @property int $entity_guid The GUID of the entity that this extender describes
* @property int $access_id Specifies the visibility level of this extender
* @property string $name The name of this extender
* @property mixed $value The value of the extender (int or string)
* @property int $time_created A UNIX timestamp of when the extender was created (read-only, set on first save)
*/
abstract class ElggExtender extends ElggData {
/**
* (non-PHPdoc)
*
* @see ElggData::initializeAttributes()
*
* @return void
*/
protected function initializeAttributes() {
parent::initializeAttributes();
$this->attributes['type'] = NULL;
}
/**
* Returns an attribute
*
* @param string $name Name
*
* @return mixed
*/
protected function get($name) {
if (array_key_exists($name, $this->attributes)) {
// Sanitise value if necessary
if ($name == 'value') {
switch ($this->attributes['value_type']) {
case 'integer' :
return (int)$this->attributes['value'];
break;
//case 'tag' :
//case 'file' :
case 'text' :
return ($this->attributes['value']);
break;
default :
$msg = elgg_echo('InstallationException:TypeNotSupported', array(
$this->attributes['value_type']));
throw new InstallationException($msg);
break;
}
}
return $this->attributes[$name];
}
return null;
}
/**
* Set an attribute
*
* @param string $name Name
* @param mixed $value Value
* @param string $value_type Value type
*
* @return boolean
*/
protected function set($name, $value, $value_type = "") {
$this->attributes[$name] = $value;
if ($name == 'value') {
$this->attributes['value_type'] = detect_extender_valuetype($value, $value_type);
}
return true;
}
/**
* Get the GUID of the extender's owner entity.
*
* @return int The owner GUID
*/
public function getOwnerGUID() {
return $this->owner_guid;
}
/**
* Return the guid of the entity's owner.
*
* @return int The owner GUID
* @deprecated 1.8 Use getOwnerGUID
*/
public function getOwner() {
elgg_deprecated_notice("ElggExtender::getOwner deprecated for ElggExtender::getOwnerGUID", 1.8);
return $this->getOwnerGUID();
}
/**
* Get the entity that owns this extender
*
* @return ElggEntity
*/
public function getOwnerEntity() {
return get_entity($this->owner_guid);
}
/**
* Get the entity this describes.
*
* @return ElggEntity The entity
*/
public function getEntity() {
return get_entity($this->entity_guid);
}
/**
* Returns if a user can edit this extended data.
*
* @param int $user_guid The GUID of the user (defaults to currently logged in user)
*
* @return bool
*/
public function canEdit($user_guid = 0) {
return can_edit_extender($this->id, $this->type, $user_guid);
}
/*
* EXPORTABLE INTERFACE
*/
/**
* Return an array of fields which can be exported.
*
* @return array
*/
public function getExportableValues() {
return array(
'id',
'entity_guid',
'name',
'value',
'value_type',
'owner_guid',
'type',
);
}
/**
* Export this object
*
* @return array
*/
public function export() {
$uuid = get_uuid_from_object($this);
$meta = new ODDMetaData($uuid, guid_to_uuid($this->entity_guid), $this->attributes['name'],
$this->attributes['value'], $this->attributes['type'], guid_to_uuid($this->owner_guid));
$meta->setAttribute('published', date("r", $this->time_created));
return $meta;
}
/*
* SYSTEM LOG INTERFACE
*/
/**
* Return an identification for the object for storage in the system log.
* This id must be an integer.
*
* @return int
*/
public function getSystemLogID() {
return $this->id;
}
/**
* Return a type of extension.
*
* @return string
*/
public function getType() {
return $this->type;
}
/**
* Return a subtype. For metadata & annotations this is the 'name' and
* for relationship this is the relationship type.
*
* @return string
*/
public function getSubtype() {
return $this->name;
}
}
|
