class MenuViewBuilder in Twig Tweak 3.1.x

Menu view builder.

Hierarchy

• class \Drupal\twig_tweak\View\MenuViewBuilder

1 string reference to 'MenuViewBuilder'

twig_tweak.services.yml in ./twig_tweak.services.yml

twig_tweak.services.yml

1 service uses MenuViewBuilder

twig_tweak.menu_view_builder in ./twig_tweak.services.yml

Drupal\twig_tweak\View\MenuViewBuilder

File

src/View/MenuViewBuilder.php, line 10

Namespace

Drupal\twig_tweak\View

class MenuViewBuilder {

  /**
   * The menu link tree service.
   *
   * @var \Drupal\Core\Menu\MenuLinkTreeInterface
   */
  protected $menuLinkTree;

  /**
   * Constructs a MenuViewBuilder object.
   */
  public function __construct(MenuLinkTreeInterface $menu_link_tree) {
    $this->menuLinkTree = $menu_link_tree;
  }

  /**
   * Returns the render array for a menu.
   *
   * @param string $menu_name
   *   The name of the menu.
   * @param int $level
   *   (optional) Initial menu level.
   * @param int $depth
   *   (optional) Maximum number of menu levels to display.
   * @param bool $expand
   *   (optional) Expand all menu links.
   *
   * @return array
   *   A render array for the menu.
   *
   * @see \Drupal\system\Plugin\Block\SystemMenuBlock::build()
   */
  public function build(string $menu_name, int $level = 1, int $depth = 0, bool $expand = FALSE) : array {
    $parameters = $this->menuLinkTree
      ->getCurrentRouteMenuTreeParameters($menu_name);

    // Adjust the menu tree parameters based on the block's configuration.
    $parameters
      ->setMinDepth($level);

    // When the depth is configured to zero, there is no depth limit. When depth
    // is non-zero, it indicates the number of levels that must be displayed.
    // Hence this is a relative depth that we must convert to an actual
    // (absolute) depth, that may never exceed the maximum depth.
    if ($depth > 0) {
      $parameters
        ->setMaxDepth(min($level + $depth - 1, $this->menuLinkTree
        ->maxDepth()));
    }

    // If expandedParents is empty, the whole menu tree is built.
    if ($expand) {
      $parameters->expandedParents = [];
    }
    $tree = $this->menuLinkTree
      ->load($menu_name, $parameters);
    $manipulators = [
      [
        'callable' => 'menu.default_tree_manipulators:checkAccess',
      ],
      [
        'callable' => 'menu.default_tree_manipulators:generateIndexAndSort',
      ],
    ];
    $tree = $this->menuLinkTree
      ->transform($tree, $manipulators);
    $build = $this->menuLinkTree
      ->build($tree);
    if (!isset($build['#cache']['keys'])) {
      $build['#cache']['keys'] = [
        'twig_tweak_menu',
        $menu_name,
        '[level]=' . $level,
        '[depth]=' . $depth,
        '[expand]=' . (int) $expand,
      ];
    }
    return $build;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
MenuViewBuilder::$menuLinkTree	protected	property	The menu link tree service.
MenuViewBuilder::build	public	function	Returns the render array for a menu.
MenuViewBuilder::__construct	public	function	Constructs a MenuViewBuilder object.