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
|
<?php
/**
* Relationship class.
*
* @package Elgg.Core
* @subpackage Core
*
* @property int $id The unique identifier (read-only)
* @property int $guid_one The GUID of the subject of the relationship
* @property string $relationship The name of the relationship
* @property int $guid_two The GUID of the object of the relationship
* @property int $time_created A UNIX timestamp of when the relationship was created (read-only, set on first save)
*/
class ElggRelationship extends ElggData implements
Importable
{
/**
* Create a relationship object, optionally from a given id value or row.
*
* @param mixed $id ElggRelationship id, database row, or null for new relationship
*/
function __construct($id = null) {
$this->initializeAttributes();
if (!empty($id)) {
if ($id instanceof stdClass) {
$relationship = $id; // Create from db row
} else {
$relationship = get_relationship($id);
}
if ($relationship) {
$objarray = (array) $relationship;
foreach ($objarray as $key => $value) {
$this->attributes[$key] = $value;
}
}
}
}
/**
* Class member get overloading
*
* @param string $name Name
*
* @return mixed
*/
function get($name) {
if (array_key_exists($name, $this->attributes)) {
return $this->attributes[$name];
}
return null;
}
/**
* Class member set overloading
*
* @param string $name Name
* @param mixed $value Value
*
* @return mixed
*/
function set($name, $value) {
$this->attributes[$name] = $value;
return true;
}
/**
* Save the relationship
*
* @return int the relationship id
* @throws IOException
*/
public function save() {
if ($this->id > 0) {
delete_relationship($this->id);
}
$this->id = add_entity_relationship($this->guid_one, $this->relationship, $this->guid_two);
if (!$this->id) {
throw new IOException(elgg_echo('IOException:UnableToSaveNew', array(get_class())));
}
return $this->id;
}
/**
* Delete a given relationship.
*
* @return bool
*/
public function delete() {
return delete_relationship($this->id);
}
/**
* Get a URL for this relationship.
*
* @return string
*/
public function getURL() {
return get_relationship_url($this->id);
}
// EXPORTABLE INTERFACE ////////////////////////////////////////////////////////////
/**
* Return an array of fields which can be exported.
*
* @return array
*/
public function getExportableValues() {
return array(
'id',
'guid_one',
'relationship',
'guid_two'
);
}
/**
* Export this relationship
*
* @return array
*/
public function export() {
$uuid = get_uuid_from_object($this);
$relationship = new ODDRelationship(
guid_to_uuid($this->guid_one),
$this->relationship,
guid_to_uuid($this->guid_two)
);
$relationship->setAttribute('uuid', $uuid);
return $relationship;
}
// IMPORTABLE INTERFACE ////////////////////////////////////////////////////////////
/**
* Import a relationship
*
* @param ODD $data ODD data
* @return bool
* @throws ImportException|InvalidParameterException
*/
public function import(ODD $data) {
if (!($data instanceof ODDRelationship)) {
throw new InvalidParameterException(elgg_echo('InvalidParameterException:UnexpectedODDClass'));
}
$uuid_one = $data->getAttribute('uuid1');
$uuid_two = $data->getAttribute('uuid2');
// See if this entity has already been imported, if so then we need to link to it
$entity1 = get_entity_from_uuid($uuid_one);
$entity2 = get_entity_from_uuid($uuid_two);
if (($entity1) && ($entity2)) {
// Set the item ID
$this->attributes['guid_one'] = $entity1->getGUID();
$this->attributes['guid_two'] = $entity2->getGUID();
// Map verb to relationship
//$verb = $data->getAttribute('verb');
//$relationship = get_relationship_from_verb($verb);
$relationship = $data->getAttribute('type');
if ($relationship) {
$this->attributes['relationship'] = $relationship;
// save
$result = $this->save();
if (!$result) {
throw new ImportException(elgg_echo('ImportException:ProblemSaving', array(get_class())));
}
return true;
}
}
return false;
}
// 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;
}
/**
* For a given ID, return the object associated with it.
* This is used by the river functionality primarily.
* This is useful for checking access permissions etc on objects.
*
* @param int $id ID
*
* @return ElggRelationship
*/
public function getObjectFromID($id) {
return get_relationship($id);
}
/**
* Return a type of the object - eg. object, group, user, relationship, metadata, annotation etc
*
* @return string 'relationship'
*/
public function getType() {
return 'relationship';
}
/**
* 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->relationship;
}
}
|
