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
|
<?php
/**
* Elgg navigation library
* Functions for managing menus and other navigational elements
*
* @package Elgg.Core
* @subpackage Navigation
*/
/**
* Register an item for an Elgg menu
*
* @param string $menu_name The name of the menu: site, page, userhover,
* userprofile, groupprofile, or any custom menu
* @param mixed $menu_item A ElggMenuItem object or an array of options in format:
* name => STR Menu item identifier (required)
* text => STR Menu item display text (required)
* href => STR Menu item URL (required)
* contexts => ARR Page context strings
* section => STR Menu section identifier
* title => STR Menu item tooltip
* selected => BOOL Is this menu item currently selected
* parent_name => STR Identifier of the parent menu item
*
* Custom options can be added as key value pairs.
*
* @return bool
* @since 1.8.0
*/
function elgg_register_menu_item($menu_name, $menu_item) {
global $CONFIG;
if (!isset($CONFIG->menus[$menu_name])) {
$CONFIG->menus[$menu_name] = array();
}
if (is_array($menu_item)) {
$item = ElggMenuItem::factory($menu_item);
if (!$item) {
elgg_log("Unable to add menu item '{$menu_item['name']}' to '$menu_name' menu", 'WARNING');
elgg_log(print_r($menu_item, true), 'DEBUG');
return false;
}
}
$CONFIG->menus[$menu_name][] = $item;
return true;
}
/**
* Remove an item from a menu
*
* @param string $menu_name The name of the menu
* @param string $item_name The unique identifier for this menu item
*
* @return bool
* @since 1.8.0
*/
function elgg_unregister_menu_item($menu_name, $item_name) {
global $CONFIG;
if (!isset($CONFIG->menus[$menu_name])) {
return false;
}
foreach ($CONFIG->menus[$menu_name] as $index => $menu_object) {
if ($menu_object->getName() == $item_name) {
unset($CONFIG->menus[$menu_name][$index]);
return true;
}
}
return false;
}
/**
* Adds a breadcrumb to the breadcrumbs stack.
*
* @param string $title The title to display
* @param string $link Optional. The link for the title.
*
* @return void
* @since 1.8.0
*
* @link http://docs.elgg.org/Tutorials/UI/Breadcrumbs
*/
function elgg_push_breadcrumb($title, $link = NULL) {
global $CONFIG;
if (!is_array($CONFIG->breadcrumbs)) {
$CONFIG->breadcrumbs = array();
}
// avoid key collisions.
$CONFIG->breadcrumbs[] = array('title' => $title, 'link' => $link);
}
/**
* Removes last breadcrumb entry.
*
* @return array popped item.
* @since 1.8.0
* @link http://docs.elgg.org/Tutorials/UI/Breadcrumbs
*/
function elgg_pop_breadcrumb() {
global $CONFIG;
if (is_array($CONFIG->breadcrumbs)) {
array_pop($CONFIG->breadcrumbs);
}
return FALSE;
}
/**
* Returns all breadcrumbs as an array of array('title' => 'Readable Title', 'link' => 'URL')
*
* @return array Breadcrumbs
* @since 1.8.0
* @link http://docs.elgg.org/Tutorials/UI/Breadcrumbs
*/
function elgg_get_breadcrumbs() {
global $CONFIG;
return (is_array($CONFIG->breadcrumbs)) ? $CONFIG->breadcrumbs : array();
}
/**
* Set up the site menu
*
* Handles default, featured, and custom menu items
*
* @param string $hook
* @param string $type
* @param array $return Menu array
* @param array $params
* @return array
*/
function elgg_site_menu_setup($hook, $type, $return, $params) {
$featured_menu_names = elgg_get_config('site_featured_menu_names');
$custom_menu_items = elgg_get_config('site_custom_menu_items');
if ($featured_menu_names || $custom_menu_items) {
// we have featured or custom menu items
$registered = $return['default'];
// set up featured menu items
$featured = array();
foreach ($featured_menu_names as $name) {
foreach ($registered as $index => $item) {
if ($item->getName() == $name) {
$featured[] = $item;
unset($registered[$index]);
}
}
}
// add custom menu items
$n = 1;
foreach ($custom_menu_items as $title => $url) {
$item = new ElggMenuItem("custom$n", $title, $url);
$featured[] = $item;
$n++;
}
$return['default'] = $featured;
$return['more'] = $registered;
} else {
// no featured menu items set
$max_display_items = 5;
// the first n are shown, rest added to more list
$num_menu_items = count($return['default']);
if ($num_menu_items > $max_display_items) {
$return['more'] = array_splice($return['default'], $max_display_items);
}
}
return $return;
}
/**
* Navigation initialization
*/
function elgg_nav_init() {
elgg_register_plugin_hook_handler('prepare', 'menu:site', 'elgg_site_menu_setup');
}
elgg_register_event_handler('init', 'system', 'elgg_nav_init');
|
