Elgg\Menu\Service Class Reference

Methods to construct and prepare menus for rendering. More...

Public Member Functions
	__construct (PluginHooksService $hooks, Config $config)
	Constructor. More...
	getMenu ($name, array $params=[])
	Build a full menu, pulling items from configuration and the "register" menu hooks. More...
	getUnpreparedMenu ($name, array $params=[])
	Build an unprepared menu. More...
	prepareMenu (UnpreparedMenu $menu)
	Split a menu into sections, and pass it through the "prepare" hook. More...
	combineMenus (array $names=[], array $params=[], $new_name= '')
	Combine several menus into one. More...
	prepareMenuItems ($items=[])
	Prepare menu items. More...

Protected Member Functions
	prepareVerticalMenu (PreparedMenu $menu, array $params)
	Prepares a vertical menu by setting the display child menu option to "toggle" if not set. More...
	prepareSelectedParents (PreparedMenu $menu, array $params)
	Marks parents of selected items also as selected. More...
	prepareDropdownMenu (PreparedMenu $menu, array $params)
	Prepares a dropdown menu. More...
	prepareItemContentsView (PreparedMenu $menu, array $params)
	Set a content view for each menu item based on the default for the menu. More...

Detailed Description

Methods to construct and prepare menus for rendering.

Definition at line 13 of file Service.php.

Constructor & Destructor Documentation

Elgg\Menu\Service::__construct	(	PluginHooksService	$hooks,
		Config	$config
	)

Constructor.

Parameters

PluginHooksService	$hooks	Plugin hooks
Config	$config	Elgg config

Definition at line 31 of file Service.php.

Member Function Documentation

Elgg\Menu\Service::combineMenus	(	array	$names = [],
		array	$params = [],
			$new_name = ''
	)

Combine several menus into one.

Unprepared menus will be built separately, then combined, with items reassigned to sections named after their origin menu. The returned menu must be prepared before display.

Parameters

	string[]	$names Menu names
array	$params	Menu params
string	$new_name	Combined menu name (used for the prepare hook)

Returns

UnpreparedMenu

Definition at line 289 of file Service.php.

Elgg\Menu\Service::getMenu	(		$name,
		array	$params = []
	)

Build a full menu, pulling items from configuration and the "register" menu hooks.

Parameters are filtered by the "parameters" hook.

Parameters

string	$name	Menu name
array	$params	Hook/view parameters

Returns

Menu

Definition at line 46 of file Service.php.

Elgg\Menu\Service::getUnpreparedMenu	(		$name,
		array	$params = []
	)

Build an unprepared menu.

Parameters

string	$name	Menu name
array	$params	Hook/view parameters

Returns

UnpreparedMenu

Definition at line 58 of file Service.php.

Elgg\Menu\Service::prepareDropdownMenu ( PreparedMenu  $menu, array  $params  )

protected

Prepares a dropdown menu.

Parameters

PreparedMenu	$menu	the current prepared menu
array	$params	the menu params

Returns

Definition at line 211 of file Service.php.

Elgg\Menu\Service::prepareItemContentsView ( PreparedMenu  $menu, array  $params  )

protected

Set a content view for each menu item based on the default for the menu.

Parameters

PreparedMenu	$menu	the current prepared menu
array	$params	the menu params

Returns

PreparedMenu

Since

4.2

Definition at line 253 of file Service.php.

Elgg\Menu\Service::prepareMenu

(

UnpreparedMenu

$menu

)

Split a menu into sections, and pass it through the "prepare" hook.

Parameters

UnpreparedMenu

$menu

Menu

Returns

Menu

Definition at line 104 of file Service.php.

Elgg\Menu\Service::prepareMenuItems

(

$items = []

)

Prepare menu items.

Parameters

array

$items

An array of ElggMenuItem instances or menu item factory options

Returns

MenuItems

Definition at line 323 of file Service.php.

Elgg\Menu\Service::prepareSelectedParents ( PreparedMenu  $menu, array  $params  )

protected

Marks parents of selected items also as selected.

Parameters

PreparedMenu	$menu	the current prepared menu
array	$params	the menu params

Returns

Definition at line 187 of file Service.php.

Elgg\Menu\Service::prepareVerticalMenu ( PreparedMenu  $menu, array  $params  )

protected

Prepares a vertical menu by setting the display child menu option to "toggle" if not set.

Parameters

PreparedMenu	$menu	the current prepared menu
array	$params	the menu params

Returns

Definition at line 151 of file Service.php.

---

The documentation for this class was generated from the following file:

• engine/classes/Elgg/Menu/Service.php