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
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
|
<?php
/**
* Elgg widgets library.
* Contains code for handling widgets.
*
* @package Elgg
* @subpackage Core
* @license http://www.gnu.org/licenses/old-licenses/gpl-2.0.html GNU Public License version 2
* @copyright Curverider Ltd 2008
* @link http://elgg.org/
*/
/**
* Register a particular context for use with widgets.
*
* @param string $context The context we wish to enable context for
*/
function use_widgets($context) {
global $CONFIG;
if (!isset($CONFIG->widgets))
$CONFIG->widgets = new stdClass;
if (!isset($CONFIG->widgets->contexts)) {
$CONFIG->widgets->contexts = array();
}
if (!empty($context)) {
$CONFIG->widgets->contexts[] = $context;
}
}
/**
* When given a widget entity and a new requested location, saves the new location
* and also provides a sensible ordering for all widgets in that column
*
* @param ElggObject $widget The widget entity
* @param int $order The order within the column
* @param int $column The column (1 or 2)
* @return true|false Depending on success
*/
function save_widget_location(ElggObject $widget, $order, $column) {
if ($widget instanceof ElggObject) {
if ($widget->subtype == "widget") {
// If you can't move the widget, don't save a new location
if (!$widget->draggable)
return false;
// Sanitise the column value
if ($column != 1 || $column != 2)
$column = 1;
$widget->column = (int) $column;
$ordertmp = array();
if ($entities = get_entities_from_metadata_multi(array(
'context' => $widget->context,
'column' => $column,
),'object','widget')) {
foreach($entities as $entity) {
$entityorder = $entity->order;
if ($entityorder < $order) {
$ordertmp[$entityorder] = $entity;
}
if ($entityorder >= $order) {
$ordertmp[$entityorder + 10000] = $entity;
}
}
}
$ordertmp[$order] = $widget;
ksort($ordertmp);
$orderticker = 10;
foreach($ordertmp as $orderval => $entity) {
$entity->order = $orderticker;
$orderticker += 10;
}
return true;
} else {
register_error($widget->subtype);
}
}
return false;
}
/**
* Get widgets for a particular context and column, in order of display
*
* @param int $user_guid The owner user GUID
* @param string $context The context (profile, dashboard etc)
* @param int $column The column (1 or 2)
* @return array|false An array of widget ElggObjects, or false
*/
function get_widgets($user_guid, $context, $column) {
if ($widgets = get_user_objects_by_metadata($user_guid, "widget", array(
'column' => $column,
'context' => $context,
), 10000)) {
$widgetorder = array();
foreach($widgets as $widget) {
$order = $widget->order;
while(isset($widgetorder[$order])) {
$order++;
}
$widgetorder[$order] = $widget;
}
return $widgetorder;
}
return false;
}
/**
* Displays a particular widget
*
* @param ElggObject $widget The widget to display
* @return string The HTML for the widget, including JavaScript wrapper
*/
function display_widget(ElggObject $widget) {
return elgg_view_entity($widget);
}
/**
* Add a new widget
*
* @param int $user_guid User GUID to associate this widget with
* @param string $handler The handler for this widget
* @param string $context The page context for this widget
* @param int $order The order to display this widget in
* @param int $column The column to display this widget in (1 or 2)
* @return true|false Depending on success
*/
function add_widget($user_guid, $handler, $context, $order = 0, $column = 1) {
if (empty($user_guid) || empty($context) || empty($handler) || !widget_type_exists($handler))
return false;
if ($user = get_user($user_guid)) {
$widget = new ElggObject;
$widget->subtype = "widget";
$widget->handler = $handler;
$widget->context = $context;
$widget->column = $column;
if (!$widget->save())
return false;
save_widget_location($widget, $order, $column);
return true;
}
return false;
}
/**
* Define a new widget type
*
* @param string $handler The identifier for the widget handler
* @param string $name The name of the widget type
* @param string $description A description for the widget type
* @return true|false Depending on success
*/
function add_widget_type($handler, $name, $description) {
if (!empty($handler) && !empty($name)) {
global $CONFIG;
if (!isset($CONFIG->widgets))
$CONFIG->widgets = new stdClass;
if (!isset($CONFIG->widgets->handlers))
$CONFIG->widgets->handlers = array();
$handlerobj = new stdClass;
$handlerobj->name = $name;
$handlerobj->description = $description;
$CONFIG->widgets->handlers[$handler] = $handlerobj;
return true;
}
return false;
}
/**
* Determines whether or not widgets with the specified handler have been defined
*
* @param string $handler The widget handler identifying string
* @return true|false Whether or not those widgets exist
*/
function widget_type_exists($handler) {
global $CONFIG;
if (!empty($CONFIG->widgets)
&& !empty($CONFIG->widgets->handlers)
&& is_array($CONFIG->widgets->handlers)
&& array_key_exists($handler, $CONFIG->widgets->handlers))
return true;
return false;
}
/**
* Returns an array of stdClass objects representing the defined widget types
*
* @return array A list of types defined (if any)
*/
function get_widget_types() {
global $CONFIG;
if (!empty($CONFIG->widgets)
&& !empty($CONFIG->widgets->handlers)
&& is_array($CONFIG->widgets->handlers)) {
return $CONFIG->widgets->handlers;
}
return array();
}
/**
* Saves a widget's settings (by passing an array of (name => value) pairs to save_{$handler}_widget)
*
* @param int $widget_guid The GUID of the widget we're saving to
* @param array $params An array of name => value parameters
*/
function save_widget_info($widget_guid, $params) {
if ($widget = get_entity($widget_guid)) {
$subtype = $widget->getSubtype();
if ($subtype != "widget") return false;
$handler = $widget->handler;
if (empty($handler) || !widget_type_exists($handler)) return false;
if (!$widget->canEdit()) return false;
// Save the params to the widget
if (is_array($params) && sizeof($params) > 0) {
foreach($params as $name => $value) {
if (!empty($name) && !in_array($name,array(
'guid','owner_guid','site_guid'
))) {
$widget->$name = $value;
}
}
$widget->save();
}
$function = "save_{$handler}_widget";
if (is_callable($function)) {
return $function($params);
}
return true;
}
return false;
}
/**
* Function to initialise widgets functionality on Elgg init
*
*/
function widgets_init() {
register_action('widgets/save');
register_action('widgets/add');
}
// Register event
register_elgg_event_handler('init','system','widgets_init');
?>
|
