class Toolbar
Same name in other branches
- 9 core/modules/toolbar/src/Element/Toolbar.php \Drupal\toolbar\Element\Toolbar
- 8.9.x core/modules/toolbar/src/Element/Toolbar.php \Drupal\toolbar\Element\Toolbar
- 11.x core/modules/toolbar/src/Element/Toolbar.php \Drupal\toolbar\Element\Toolbar
Provides a render element for the default Drupal toolbar.
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
- class \Drupal\Core\Render\Element\RenderElementBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Render\Element\ElementInterface
- class \Drupal\toolbar\Element\Toolbar extends \Drupal\Core\Render\Element\RenderElementBase
- class \Drupal\Core\Render\Element\RenderElementBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Render\Element\ElementInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
Expanded class hierarchy of Toolbar
25 string references to 'Toolbar'
- CKEditor5::validateConfigurationForm in core/
modules/ ckeditor5/ src/ Plugin/ Editor/ CKEditor5.php - Form validation handler.
- claro_system_module_invoked_library_info_alter in core/
themes/ claro/ claro.theme - Called by system.module via its hook_library_info_alter().
- claro_system_module_invoked_theme_registry_alter in core/
themes/ claro/ claro.theme - Called by system.module via its hook_theme_registry_alter().
- ContextualLinksTest::testContextualLinksClick in core/
modules/ contextual/ tests/ src/ FunctionalJavascript/ ContextualLinksTest.php - Tests clicking contextual links.
- contextual_help in core/
modules/ contextual/ contextual.module - Implements hook_help().
File
-
core/
modules/ toolbar/ src/ Element/ Toolbar.php, line 13
Namespace
Drupal\toolbar\ElementView source
class Toolbar extends RenderElementBase {
/**
* {@inheritdoc}
*/
public function getInfo() {
$class = static::class;
return [
'#pre_render' => [
[
$class,
'preRenderToolbar',
],
],
'#theme' => 'toolbar',
'#attached' => [
'library' => [
'toolbar/toolbar',
],
],
// Metadata for the toolbar wrapping element.
'#attributes' => [
'id' => 'toolbar-administration',
'role' => 'group',
'aria-label' => $this->t('Site administration toolbar'),
],
// Metadata for the administration bar.
'#bar' => [
'#heading' => $this->t('Toolbar items'),
'#attributes' => [
'id' => 'toolbar-bar',
'role' => 'navigation',
'aria-label' => $this->t('Toolbar items'),
],
],
];
}
/**
* Builds the Toolbar as a structured array ready for rendering.
*
* Since building the toolbar takes some time, it is done just prior to
* rendering to ensure that it is built only if it will be displayed.
*
* @param array $element
* A renderable array.
*
* @return array
* A renderable array.
*
* @see toolbar_page_top()
*/
public static function preRenderToolbar($element) {
// Get the configured breakpoints to switch from vertical to horizontal
// toolbar presentation.
$breakpoints = static::breakpointManager()->getBreakpointsByGroup('toolbar');
if (!empty($breakpoints)) {
$media_queries = [];
foreach ($breakpoints as $id => $breakpoint) {
$media_queries[$id] = $breakpoint->getMediaQuery();
}
$element['#attached']['drupalSettings']['toolbar']['breakpoints'] = $media_queries;
}
$module_handler = static::moduleHandler();
// Get toolbar items from all modules that implement hook_toolbar().
$items = $module_handler->invokeAll('toolbar');
// Allow for altering of hook_toolbar().
$module_handler->alter('toolbar', $items);
// Sort the children.
uasort($items, [
'\\Drupal\\Component\\Utility\\SortArray',
'sortByWeightProperty',
]);
// Merge in the original toolbar values.
$element = array_merge($element, $items);
// Assign each item a unique ID, based on its key.
foreach (Element::children($element) as $key) {
$element[$key]['#id'] = Html::getId('toolbar-item-' . $key);
}
return $element;
}
/**
* Wraps the breakpoint manager.
*
* @return \Drupal\breakpoint\BreakpointManagerInterface
*/
protected static function breakpointManager() {
return \Drupal::service('breakpoint.manager');
}
/**
* Wraps the module handler.
*
* @return \Drupal\Core\Extension\ModuleHandlerInterface
*/
protected static function moduleHandler() {
return \Drupal::moduleHandler();
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
PluginInspectionInterface::getPluginDefinition | public | function | Gets the definition of the plugin implementation. | 6 | |
PluginInspectionInterface::getPluginId | public | function | Gets the plugin_id of the plugin instance. | 2 | |
RenderElementBase::preRenderAjaxForm | public static | function | Adds Ajax information about an element to communicate with JavaScript. | 2 | |
RenderElementBase::preRenderGroup | public static | function | Adds members of this group as actual elements for rendering. | 2 | |
RenderElementBase::processAjaxForm | public static | function | Form element processing handler for the #ajax form property. | 3 | |
RenderElementBase::processGroup | public static | function | Arranges elements into groups. | 2 | |
RenderElementBase::setAttributes | public static | function | Sets a form element's class attribute. | Overrides ElementInterface::setAttributes | 2 |
Toolbar::breakpointManager | protected static | function | Wraps the breakpoint manager. | ||
Toolbar::getInfo | public | function | Returns the element properties for this element. | Overrides ElementInterface::getInfo | |
Toolbar::moduleHandler | protected static | function | Wraps the module handler. | ||
Toolbar::preRenderToolbar | public static | function | Builds the Toolbar as a structured array ready for rendering. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.