PHP Class Elgg\Menu\Service

Public Methods

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

Method Details

__construct() public method

Constructor

public __construct ( PluginHooksService $hooks, Config $config )
$hooks	Elgg\PluginHooksService	Plugin hooks
$config	Elgg\Config	Elgg config

combineMenus() public method

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.

public combineMenus ( array $names = [], array $params = [], string $new_name = '' ) : UnpreparedMenu
$names	array	Menu names
$params	array	Menu params
$new_name	string	Combined menu name (used for the prepare hook)
return	UnpreparedMenu

getMenu() public method

Parameters are filtered by the "parameters" hook.

public getMenu ( string $name, array $params = [] ) : Menu
$name	string	Menu name
$params	array	Hook/view parameters
return	Menu

getUnpreparedMenu() public method

Build an unprepared menu.

public getUnpreparedMenu ( string $name, array $params = [] ) : UnpreparedMenu
$name	string	Menu name
$params	array	Hook/view parameters
return	UnpreparedMenu

prepareMenu() public method

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

public prepareMenu ( UnpreparedMenu $menu ) : Menu
$menu	UnpreparedMenu	Menu
return	Menu

prepareMenuItems() public method

Prepare menu items

public prepareMenuItems ( array $items = [] ) : ElggMenuItem[]
$items	array	An array of ElggMenuItem instances or menu item factory options
return	ElggMenuItem[]