engine/lib/navigation.php File Reference

Go to the source code of this file.

Namespaces
namespace	Elgg::Core
	Activate a plugin or plugins.
Functions
	elgg_register_menu_item ($menu_name, $menu_item)
	Register an item for an Elgg menu.
	elgg_unregister_menu_item ($menu_name, $item_name)
	Remove an item from a menu.
	elgg_is_menu_item_registered ($menu_name, $item_name)
	Check if a menu item has been registered.
	elgg_register_title_button ($handler=null, $name= 'add')
	Convenience function for registering a button to title menu.
	elgg_push_breadcrumb ($title, $link=NULL)
	Adds a breadcrumb to the breadcrumbs stack.
	elgg_pop_breadcrumb ()
	Removes last breadcrumb entry.
	elgg_get_breadcrumbs ()
	Returns all breadcrumbs as an array of array('title' => 'Readable Title', 'link' => 'URL').
	elgg_site_menu_setup ($hook, $type, $return, $params)
	Set up the site menu.
	elgg_river_menu_setup ($hook, $type, $return, $params)
	Add the comment and like links to river actions menu private.
	elgg_entity_menu_setup ($hook, $type, $return, $params)
	Entity menu is list of links and info on any entity private.
	elgg_widget_menu_setup ($hook, $type, $return, $params)
	Widget menu is a set of widget controls private.
	elgg_annotation_menu_setup ($hook, $type, $return, $params)
	Adds a delete link to "generic_comment" annotations private.
	elgg_nav_init ()
	Navigation initialization private.

---

Function Documentation

elgg_annotation_menu_setup	(	$	hook,
		$	type,
		$	return,
		$	params
	)

Adds a delete link to "generic_comment" annotations private.

Definition at line 487 of file navigation.php.

elgg_entity_menu_setup	(	$	hook,
		$	type,
		$	return,
		$	params
	)

Entity menu is list of links and info on any entity private.

Definition at line 388 of file navigation.php.

elgg_get_breadcrumbs

(

)

Returns all breadcrumbs as an array of array('title' => 'Readable Title', 'link' => 'URL').

Returns:

array Breadcrumbs

Since:

1.8.0 http://docs.elgg.org/Tutorials/UI/Breadcrumbs

Definition at line 248 of file navigation.php.

elgg_is_menu_item_registered	(	$	menu_name,
		$	item_name
	)

Check if a menu item has been registered.

Parameters:

	string	$menu_name The name of the menu
	string	$item_name The unique identifier for this menu item

Returns:

bool

Since:

1.8.0

Definition at line 148 of file navigation.php.

elgg_nav_init

(

)

Navigation initialization private.

Definition at line 514 of file navigation.php.

elgg_pop_breadcrumb

(

)

Removes last breadcrumb entry.

Returns:

array popped item.

Since:

1.8.0 http://docs.elgg.org/Tutorials/UI/Breadcrumbs

Definition at line 231 of file navigation.php.

elgg_push_breadcrumb	(	$	title,
		$	link = NULL
	)

Adds a breadcrumb to the breadcrumbs stack.

Parameters:

	string	$title The title to display
	string	$link Optional. The link for the title.

Returns:

void

Since:

1.8.0

http://docs.elgg.org/Tutorials/UI/Breadcrumbs

Definition at line 214 of file navigation.php.

elgg_register_menu_item	(	$	menu_name,
		$	menu_item
	)

Register an item for an Elgg menu.

Warning:

Generally you should not use this in response to the plugin hook: 'register', 'menu:<menu_name>'. If you do, you may end up with many incorrect links on a dynamic menu.

A menu item's name must be unique per menu. If more than one menu item with the same name are registered, the last menu item takes priority.

See also:

elgg_view_menu() for the plugin hooks available for modifying a menu as it is being rendered.

Parameters:

	string	$menu_name The name of the menu: site, page, userhover, userprofile, groupprofile, or any custom menu
	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) (false for non-links.

Warning:

If you disable the href the tag will not appear, so the link_class will not apply. If you put tags in manually through the 'text' option the default CSS selector .elgg-menu-$menu > li > a may affect formatting. Wrap in a if it does.) 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 link_class => STR A class or classes for the tag item_class => STR A class or classes for the tag

Additional options that the view output/url takes can be passed in the array. If the 'confirm' key is passed, the menu link uses the 'output/confirmlink' view. Custom options can be added by using the 'data' key with the value being an associative array.

Returns:

bool

Since:

1.8.0

Definition at line 90 of file navigation.php.

elgg_register_title_button	(	$	handler = null,
		$	name = 'add'
	)

Convenience function for registering a button to title menu.

The URL must be $handler/$name/$guid where $guid is the guid of the page owner. The label of the button is "$handler:$name" so that must be defined in a language file.

This is used primarily to support adding an add content button

Parameters:

	string	$handler The handler to use or null to autodetect from context
	string	$name Name of the button

Returns:

void

Since:

1.8.0

Definition at line 179 of file navigation.php.

elgg_river_menu_setup	(	$	hook,
		$	type,
		$	return,
		$	params
	)

Add the comment and like links to river actions menu private.

Definition at line 347 of file navigation.php.

elgg_site_menu_setup	(	$	hook,
		$	type,
		$	return,
		$	params
	)

Set up the site menu.

Handles default, featured, and custom menu items

Parameters:

	string	$hook
	string	$type
	array	$return Menu array
	array	$params

Returns:

array private

Definition at line 270 of file navigation.php.

elgg_unregister_menu_item	(	$	menu_name,
		$	item_name
	)

Remove an item from a menu.

Parameters:

	string	$menu_name The name of the menu
	string	$item_name The unique identifier for this menu item

Returns:

bool

Since:

1.8.0

Definition at line 121 of file navigation.php.

elgg_widget_menu_setup	(	$	hook,
		$	type,
		$	return,
		$	params
	)

Widget menu is a set of widget controls private.

Definition at line 437 of file navigation.php.