PHP Class Elgg\Menu\Service

Afficher le fichier Open project: elgg/elgg

Méthodes publiques

Méthode 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 méthode

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

combineMenus() public méthode

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)
Résultat UnpreparedMenu

getMenu() public méthode

Parameters are filtered by the "parameters" hook.
public getMenu ( string $name, array $params = [] ) : Menu
$name string Menu name
$params array Hook/view parameters
Résultat Menu

getUnpreparedMenu() public méthode

Build an unprepared menu.
public getUnpreparedMenu ( string $name, array $params = [] ) : UnpreparedMenu
$name string Menu name
$params array Hook/view parameters
Résultat UnpreparedMenu

prepareMenu() public méthode

Split a menu into sections, and pass it through the "prepare" hook
public prepareMenu ( UnpreparedMenu $menu ) : Menu
$menu UnpreparedMenu Menu
Résultat Menu

prepareMenuItems() public méthode

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