interface TopBarItemManagerInterface

Top bar item plugin manager.

Hierarchy

Expanded class hierarchy of TopBarItemManagerInterface

All classes that implement TopBarItemManagerInterface

2 files declare their use of TopBarItemManagerInterface
TopBar.php in core/modules/navigation/src/Element/TopBar.php
TopBarItemManagerTest.php in core/modules/navigation/tests/src/Unit/TopBarItemManagerTest.php

File

core/modules/navigation/src/TopBarItemManagerInterface.php, line 10

Namespace

Drupal\navigation
View source 
interface TopBarItemManagerInterface {
    
    /**
     * Gets the top bar item plugins by region.
     *
     * @param \Drupal\navigation\TopBarRegion $region
     *   The region.
     *
     * @return array
     *   A list of top bar item plugin definitions.
     */
    public function getDefinitionsByRegion(TopBarRegion $region) : array;
    
    /**
     * Gets the top bar items prepared as render array.
     *
     * @param \Drupal\navigation\TopBarRegion $region
     *   The region.
     *
     * @return array
     *   An array of rendered top bar items, keyed by the plugin ID and sorted by
     *   weight.
     */
    public function getRenderedTopBarItemsByRegion(TopBarRegion $region) : array;

}

Members

Title Modifiers Object type Summary
TopBarItemManagerInterface::getDefinitionsByRegion public function Gets the top bar item plugins by region.
TopBarItemManagerInterface::getRenderedTopBarItemsByRegion public function Gets the top bar items prepared as render array.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.