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
|
<?php
/**
* Elgg Menu Builder
*
* @package Elgg.Core
* @subpackage Navigation
*
* @since 1.8.0
*/
class ElggMenuBuilder {
protected $menu = array();
protected $selected = null;
/**
* ElggMenuBuilder constructor
*
* @param array $menu Array of ElggMenuItem objects
*/
public function __construct(array $menu) {
$this->menu = $menu;
}
/**
* Get a prepared menu array
*
* @param mixed $sort_by Method to sort the menu by. @see ElggMenuBuilder::sort()
* @return array
*/
public function getMenu($sort_by = 'text') {
$this->selectFromContext();
$this->selected = $this->findSelected();
$this->setupSections();
$this->setupTrees();
$this->sort($sort_by);
return $this->menu;
}
/**
* Get the selected menu item
*
* @return ElggMenuItem
*/
public function getSelected() {
return $this->selected;
}
/**
* Select menu items for the current context
*
* @return void
*/
protected function selectFromContext() {
if (!isset($this->menu)) {
$this->menu = array();
return;
}
// get menu items for this context
$selected_menu = array();
foreach ($this->menu as $menu_item) {
if (!is_object($menu_item)) {
elgg_log("A non-object was passed to ElggMenuBuilder", "ERROR");
continue;
}
if ($menu_item->inContext()) {
$selected_menu[] = $menu_item;
}
}
$this->menu = $selected_menu;
}
/**
* Group the menu items into sections
*
* @return void
*/
protected function setupSections() {
$sectioned_menu = array();
foreach ($this->menu as $menu_item) {
if (!isset($sectioned_menu[$menu_item->getSection()])) {
$sectioned_menu[$menu_item->getSection()] = array();
}
$sectioned_menu[$menu_item->getSection()][] = $menu_item;
}
$this->menu = $sectioned_menu;
}
/**
* Create trees for each menu section
*
* @internal The tree is doubly linked (parent and children links)
* @return void
*/
protected function setupTrees() {
$menu_tree = array();
foreach ($this->menu as $key => $section) {
$parents = array();
$children = array();
// divide base nodes from children
foreach ($section as $menu_item) {
$parent_name = $menu_item->getParentName();
if (!$parent_name) {
$parents[$menu_item->getName()] = $menu_item;
} else {
$children[] = $menu_item;
}
}
// attach children to parents
$iteration = 0;
$current_gen = $parents;
while (count($children) && $iteration < 5) {
foreach ($children as $index => $menu_item) {
$parent_name = $menu_item->getParentName();
if (array_key_exists($parent_name, $current_gen)) {
$next_gen[$menu_item->getName()] = $menu_item;
$current_gen[$parent_name]->addChild($menu_item);
$menu_item->setParent($current_gen[$parent_name]);
unset($children[$index]);
}
}
$current_gen = $next_gen;
$iteration += 1;
}
// convert keys to indexes for first level of tree
$parents = array_values($parents);
$menu_tree[$key] = $parents;
}
$this->menu = $menu_tree;
}
/**
* Find the menu item that is currently selected
*
* @return ElggMenuItem
*/
protected function findSelected() {
// do we have a selected menu item already
foreach ($this->menu as $menu_item) {
if ($menu_item->getSelected()) {
return $menu_item;
}
}
// scan looking for a selected item
foreach ($this->menu as $menu_item) {
if ($menu_item->getHref()) {
if (elgg_http_url_is_identical(full_url(), $menu_item->getHref())) {
$menu_item->setSelected(true);
return $menu_item;
}
}
}
return null;
}
/**
* Sort the menu sections and trees
*
* @param mixed $sort_by Sort type as string or php callback
* @return void
*/
protected function sort($sort_by) {
// sort sections
ksort($this->menu);
switch ($sort_by) {
case 'text':
$sort_callback = array('ElggMenuBuilder', 'compareByText');
break;
case 'name':
$sort_callback = array('ElggMenuBuilder', 'compareByName');
break;
case 'priority':
$sort_callback = array('ElggMenuBuilder', 'compareByWeight');
break;
case 'register':
// use registration order - usort breaks this
return;
break;
default:
if (is_callable($sort_by)) {
$sort_callback = $sort_by;
} else {
return;
}
break;
}
// sort each section
foreach ($this->menu as $index => $section) {
usort($section, $sort_callback);
$this->menu[$index] = $section;
// depth first traversal of tree
foreach ($section as $root) {
$stack = array();
array_push($stack, $root);
while (!empty($stack)) {
$node = array_pop($stack);
$node->sortChildren($sort_callback);
$children = $node->getChildren();
if ($children) {
$stack = array_merge($stack, $children);
}
$p = count($stack);
}
}
}
}
/**
* Compare two menu items by their display text
*
* @param ElggMenuItem $a
* @param ElggMenuItem $b
* @return bool
*/
public static function compareByText($a, $b) {
$a = $a->getText();
$b = $b->getText();
return strnatcmp($a, $b);
}
/**
* Compare two menu items by their identifiers
*
* @param ElggMenuItem $a
* @param ElggMenuItem $b
* @return bool
*/
public static function compareByName($a, $b) {
$a = $a->getName();
$b = $b->getName();
return strcmp($a, $b);
}
/**
* Compare two menu items by their priority
*
* @param ElggMenuItem $a
* @param ElggMenuItem $b
* @return bool
*/
public static function compareByWeight($a, $b) {
$a = $a->getWeight();
$b = $b->getWeight();
return $a > $b;
}
}
|
