Linear set of menu items collected from configuration and the "register" event. More...

Public Member Functions
	__construct (array $params, $items)
	Constructor. More...

	setSortBy ($sort_by='text')
	Set how this menu should be sorted. More...

	getSortBy ()
	Get the designated (or default) sort strategy. More...

	getName ()
	Get the menu name. More...

	getItems ()
	Get the menu items. More...

	getParams ()
	Get the menu parameters. More...

Detailed Description

Linear set of menu items collected from configuration and the "register" event.

This also encapsulates parameters to be passed to events and views.

Examples: /root/Elgg/engine/lib/views.php.

Definition at line 12 of file UnpreparedMenu.php.

Constructor & Destructor Documentation

◆ __construct()

Elgg\Menu\UnpreparedMenu::__construct	(	array	$params,
			$items
	)

Constructor.

Parameters

array	$params	Parameters to be passed to the "prepare" event and views. Must include value for "name".
\ElggMenuItem[] \| MenuItems	$items	Menu items

Definition at line 31 of file UnpreparedMenu.php.

Member Function Documentation

◆ getItems()

Elgg\Menu\UnpreparedMenu::getItems ( )

Get the menu items.

Returns: MenuItems

Definition at line 84 of file UnpreparedMenu.php.

◆ getName()

Elgg\Menu\UnpreparedMenu::getName ( )

Get the menu name.

Returns: string

Definition at line 75 of file UnpreparedMenu.php.

◆ getParams()

Elgg\Menu\UnpreparedMenu::getParams ( )

Get the menu parameters.

Returns: array

Definition at line 93 of file UnpreparedMenu.php.

◆ getSortBy()

Elgg\Menu\UnpreparedMenu::getSortBy ( )

Get the designated (or default) sort strategy.

See also: self::setSortBy(); \ElggMenuBuilder::sort()

Returns: string|callable

Definition at line 66 of file UnpreparedMenu.php.

◆ setSortBy()

Elgg\Menu\UnpreparedMenu::setSortBy ( $sort_by = 'text' )

Set how this menu should be sorted.

See also: \ElggMenuBuilder::sort()