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
|
<?php
/**
* ElggMetadata
* This class describes metadata that can be attached to ElggEntities.
*
* @package Elgg.Core
* @subpackage Metadata
*/
class ElggMetadata extends ElggExtender {
/**
* (non-PHPdoc)
*
* @see ElggData::initializeAttributes()
*
* @return void
*/
protected function initializeAttributes() {
parent::initializeAttributes();
$this->attributes['type'] = "metadata";
}
/**
* Construct a metadata object
*
* @param mixed $id ID of metadata or a database row as stdClass object
*/
function __construct($id = null) {
$this->initializeAttributes();
if (!empty($id)) {
// Create from db row
if ($id instanceof stdClass) {
$metadata = $id;
$objarray = (array) $metadata;
foreach ($objarray as $key => $value) {
$this->attributes[$key] = $value;
}
} else {
// get an ElggMetadata object and copy its attributes
$metadata = elgg_get_metadata_from_id($id);
$this->attributes = $metadata->attributes;
}
}
}
/**
* Determines whether or not the user can edit this piece of metadata
*
* @param int $user_guid The GUID of the user (defaults to currently logged in user)
*
* @return bool Depending on permissions
*/
function canEdit($user_guid = 0) {
if ($entity = get_entity($this->get('entity_guid'))) {
return $entity->canEditMetadata($this, $user_guid);
}
return false;
}
/**
* Save metadata object
*
* @return int|bool the metadata object id or true if updated
*
* @throws IOException
*/
function save() {
if ($this->id > 0) {
return update_metadata($this->id, $this->name, $this->value,
$this->value_type, $this->owner_guid, $this->access_id);
} else {
$this->id = create_metadata($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 metadata
*
* @return bool
*/
function delete() {
$success = elgg_delete_metastring_based_object_by_id($this->id, 'metadata');
if ($success) {
// we mark unknown here because this deletes only one value
// under this name, and there may be others remaining.
elgg_get_metadata_cache()->markUnknown($this->entity_guid, $this->name);
}
return $success;
}
/**
* Disable the metadata
*
* @return bool
* @since 1.8
*/
function disable() {
$success = elgg_set_metastring_based_object_enabled_by_id($this->id, 'no', 'metadata');
if ($success) {
// we mark unknown here because this disables only one value
// under this name, and there may be others remaining.
elgg_get_metadata_cache()->markUnknown($this->entity_guid, $this->name);
}
return $success;
}
/**
* Enable the metadata
*
* @return bool
* @since 1.8
*/
function enable() {
$success = elgg_set_metastring_based_object_enabled_by_id($this->id, 'yes', 'metadata');
if ($success) {
elgg_get_metadata_cache()->markUnknown($this->entity_guid, $this->name);
}
return $success;
}
/**
* Get a url for this item of metadata.
*
* @return string
*/
public function getURL() {
return get_metadata_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 Metadata ID
*
* @return ElggMetadata
*/
public function getObjectFromID($id) {
return elgg_get_metadata_from_id($id);
}
}
|
