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
|
<?php
/**
* Elgg Annotations
*
* Annotations allow you to attach bits of information to entities.
* They are essentially the same as metadata, but with additional
* helper functions.
*
* @internal Annotations are stored in the annotations table.
*
* @package Elgg.Core
* @subpackage DataModel.Annotations
* @link http://docs.elgg.org/DataModel/Annotations
*/
class ElggAnnotation extends ElggExtender {
/**
* (non-PHPdoc)
*
* @see ElggData::initializeAttributes()
*
* @return void
*/
protected function initializeAttributes() {
parent::initializeAttributes();
$this->attributes['type'] = 'annotation';
}
/**
* Construct a new annotation object
*
* @param mixed $id The annotation ID or a database row as stdClass object
*/
function __construct($id = null) {
$this->initializeAttributes();
if (!empty($id)) {
// Create from db row
if ($id instanceof stdClass) {
$annotation = $id;
$objarray = (array) $annotation;
foreach ($objarray as $key => $value) {
$this->attributes[$key] = $value;
}
} else {
// get an ElggAnnotation object and copy its attributes
$annotation = elgg_get_annotation_from_id($id);
$this->attributes = $annotation->attributes;
}
}
}
/**
* Save this instance
*
* @return int an object id
*/
function save() {
if ($this->id > 0) {
return update_annotation($this->id, $this->name, $this->value, $this->value_type,
$this->owner_guid, $this->access_id);
} else {
$this->id = create_annotation($this->entity_guid, $this->name, $this->value,
$this->value_type, $this->owner_guid, $this->access_id);
if (!$this->id) {
throw new IOException(elgg_echo('IOException:UnableToSaveNew', array(get_class())));
}
return $this->id;
}
}
/**
* Delete the annotation.
*
* @return bool
*/
function delete() {
remove_from_river_by_annotation($this->id);
return elgg_delete_metastring_based_object_by_id($this->id, 'annotations');
}
/**
* Disable the annotation.
*
* @return bool
* @since 1.8
*/
function disable() {
return elgg_set_metastring_based_object_enabled_by_id($this->id, 'no', 'annotations');
}
/**
* Enable the annotation.
*
* @return bool
* @since 1.8
*/
function enable() {
return elgg_set_metastring_based_object_enabled_by_id($this->id, 'yes', 'annotations');
}
/**
* Get a url for this annotation.
*
* @return string
*/
public function getURL() {
return get_annotation_url($this->id);
}
// SYSTEM LOG INTERFACE
/**
* 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 An annotation ID.
*
* @return ElggAnnotation
*/
public function getObjectFromID($id) {
return elgg_get_annotation_from_id($id);
}
}
|
