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
|
<?php
/**
* ElggWidget
*
* Stores metadata in private settings rather than as ElggMetadata
*
* @package Elgg.Core
* @subpackage Widgets
*/
class ElggWidget extends ElggObject {
/**
* Set subtype to widget.
*
* @deprecated 1.8 use ElggWidget::initializeAttributes()
*
* @return void
*/
protected function initialise_attributes() {
elgg_deprecated_notice('ElggWidget::initialise_attributes() is deprecated by ::initializeAttributes()', 1.8);
return $this->initializeAttributes();
}
/**
* Set subtype to widget.
*
* @return void
*/
protected function initializeAttributes() {
parent::initializeAttributes();
$this->attributes['subtype'] = "widget";
}
/**
* Override entity get and sets in order to save data to private data store.
*
* @param string $name Name
*
* @return mixed
*/
public function get($name) {
// See if its in our base attribute
if (isset($this->attributes[$name])) {
return $this->attributes[$name];
}
// No, so see if its in the private data store.
$meta = get_private_setting($this->guid, $name);
if ($meta) {
return $meta;
}
// Can't find it, so return null
return null;
}
/**
* Override entity get and sets in order to save data to private data store.
*
* @param string $name Name
* @param string $value Value
*
* @return bool
*/
public function set($name, $value) {
if (array_key_exists($name, $this->attributes)) {
// Check that we're not trying to change the guid!
if ((array_key_exists('guid', $this->attributes)) && ($name == 'guid')) {
return false;
}
$this->attributes[$name] = $value;
} else {
return set_private_setting($this->guid, $name, $value);
}
return true;
}
/**
* Set the widget context
*
* @param string $context The widget context
* @return bool
* @since 1.8.0
*/
public function setContext($context) {
return set_private_setting($this->guid, 'context', $context);
}
/**
* Get the widget context
*
* @return string
* @since 1.8.0
*/
public function getContext() {
return get_private_setting($this->guid, 'context');
}
/**
* Get the title of the widget
*
* @return string
* @since 1.8.0
*/
public function getTitle() {
$title = $this->title;
if (!$title) {
global $CONFIG;
$title = $CONFIG->widgets->handlers[$this->handler]->name;
}
return $title;
}
/**
* Move the widget
*
* @param int $column The widget column
* @param int $rank Zero-based rank from the top of the column
* @return void
* @since 1.8.0
*/
public function move($column, $rank) {
$options = array(
'type' => 'object',
'subtype' => 'widget',
'private_setting_name_value_pairs' => array(
array('name' => 'context', 'value' => $this->getContext()),
array('name' => 'column', 'value' => $column)
)
);
$widgets = elgg_get_entities_from_private_settings($options);
if (!$widgets) {
$this->column = $column;
$this->order = 0;
return;
}
usort($widgets, create_function('$a,$b','return (int)$a->order > (int)$b->order;'));
if ($rank == 0) {
// top of the column
$this->order = $widgets[0]->order - 10;
} elseif ($rank == count($widgets)) {
// bottom of the column
$this->order = end($widgets)->order + 10;
} else {
// reorder widgets that are below
$this->order = $widgets[$rank]->order;
for ($index = $rank; $index < count($widgets); $index++) {
if ($widgets[$index]->guid != $this->guid) {
$widgets[$index]-> order += 10;
}
}
}
$this->column = $column;
}
/**
* Saves the widget's settings
*
* Plugins can override the save mechanism using the plugin hook:
* 'widget_settings', <widget handler identifier>. The widget and
* the parameters are passed. The plugin hook handler should return
* true to indicate that it has successfully saved the settings.
*
* @warning The values in the parameter array cannot be arrays
*
* @param array $params An array of name => value parameters
*
* @return bool
* @since 1.8.0
*/
public function saveSettings($params) {
if (!$this->canEdit()) {
return false;
}
// plugin hook handlers should return true to indicate the settings have
// been saved so that default code does not run
$hook_params = array(
'widget' => $this,
'params' => $params
);
if (elgg_trigger_plugin_hook('widget_settings', $this->handler, $hook_params, false) == true) {
return true;
}
if (is_array($params) && count($params) > 0) {
foreach ($params as $name => $value) {
if (is_array($value)) {
// private settings cannot handle arrays
return false;
} else {
$this->$name = $value;
}
}
$this->save();
}
return true;
}
}
|
