interface MenuSelectTreeBuilderInterface in Menu Select 2.0.x

An interface for the menu select tree builder service.

Hierarchy

• interface \Drupal\menu_select\MenuSelectTreeBuilderInterface

1 file declares its use of MenuSelectTreeBuilderInterface

MenuSelectAutocompleteController.php in src/Controller/MenuSelectAutocompleteController.php

File

src/MenuSelectTreeBuilderInterface.php, line 8

Namespace

Drupal\menu_select

interface MenuSelectTreeBuilderInterface {

  /**
   * Function to build a menu tree from a menu name.
   *
   * @param string $menu_name
   *   Menu name to use.
   * @param int $max_depth
   *   The maximum depth to traverse.
   *
   * @return \Drupal\Core\Menu\MenuLinkTreeElement[]
   *   Array of the menu tree.
   */
  public function loadMenuTree($menu_name, $max_depth);

  /**
   * Builds a renderable array of the given menu tree.
   *
   * @param array $menu_tree
   *   The menu tree.
   * @param string $menu_id
   *   The machine name of the menu being built.
   * @param string $menu_label
   *   The label of the menu being built.
   * @param string $current_link_id
   *   The current link plugin ID, used for exclusion.
   *
   * @return array
   *   A renderable array.
   */
  public function buildRenderedMenu(array $menu_tree, $menu_id, $menu_label, $current_link_id);

}

Members

Name	Modifiers	Type	Description	Overrides
MenuSelectTreeBuilderInterface::buildRenderedMenu	public	function	Builds a renderable array of the given menu tree.	1
MenuSelectTreeBuilderInterface::loadMenuTree	public	function	Function to build a menu tree from a menu name.	1