123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327 |
- <?php
- /**
- * @file
- * Administration toolbar for quick access to top level administration items.
- */
- use Drupal\Core\Cache\CacheableMetadata;
- use Drupal\Core\Render\Element;
- use Drupal\Core\Routing\RouteMatchInterface;
- use Drupal\Core\Template\Attribute;
- use Drupal\Component\Utility\Crypt;
- use Drupal\Core\Url;
- use Drupal\toolbar\Controller\ToolbarController;
- /**
- * Implements hook_help().
- */
- function toolbar_help($route_name, RouteMatchInterface $route_match) {
- switch ($route_name) {
- case 'help.page.toolbar':
- $output = '<h3>' . t('About') . '</h3>';
- $output .= '<p>' . t('The Toolbar module provides a toolbar for site administrators, which displays tabs and trays provided by the Toolbar module itself and other modules. For more information, see the <a href=":toolbar_docs">online documentation for the Toolbar module</a>.', [':toolbar_docs' => 'https://www.drupal.org/documentation/modules/toolbar']) . '</p>';
- $output .= '<h4>' . t('Terminology') . '</h4>';
- $output .= '<dl>';
- $output .= '<dt>' . t('Tabs') . '</dt>';
- $output .= '<dd>' . t('Tabs are buttons, displayed in a bar across the top of the screen. Some tabs execute an action (such as starting Edit mode), while other tabs toggle which tray is open.') . '</dd>';
- $output .= '<dt>' . t('Trays') . '</dt>';
- $output .= '<dd>' . t('Trays are usually lists of links, which can be hierarchical like a menu. If a tray has been toggled open, it is displayed either vertically or horizontally below the tab bar, depending on the browser width. Only one tray may be open at a time. If you click another tab, that tray will replace the tray being displayed. In wide browser widths, the user has the ability to toggle from vertical to horizontal, using a link at the bottom or right of the tray. Hierarchical menus only have open/close behavior in vertical mode; if you display a tray containing a hierarchical menu horizontally, only the top-level links will be available.') . '</dd>';
- $output .= '</dl>';
- return $output;
- }
- }
- /**
- * Implements hook_theme().
- */
- function toolbar_theme($existing, $type, $theme, $path) {
- $items['toolbar'] = [
- 'render element' => 'element',
- ];
- $items['menu__toolbar'] = [
- 'base hook' => 'menu',
- 'variables' => ['items' => [], 'attributes' => []],
- ];
- return $items;
- }
- /**
- * Implements hook_page_top().
- *
- * Add admin toolbar to the top of the page automatically.
- */
- function toolbar_page_top(array &$page_top) {
- $page_top['toolbar'] = [
- '#type' => 'toolbar',
- '#access' => \Drupal::currentUser()->hasPermission('access toolbar'),
- '#cache' => [
- 'keys' => ['toolbar'],
- 'contexts' => ['user.permissions'],
- ],
- ];
- }
- /**
- * Prepares variables for administration toolbar templates.
- *
- * Default template: toolbar.html.twig.
- *
- * @param array $variables
- * An associative array containing:
- * - element: An associative array containing the properties and children of
- * the tray. Properties used: #children, #attributes and #bar.
- */
- function template_preprocess_toolbar(&$variables) {
- $element = $variables['element'];
- // Prepare the toolbar attributes.
- $variables['attributes'] = $element['#attributes'];
- $variables['toolbar_attributes'] = new Attribute($element['#bar']['#attributes']);
- $variables['toolbar_heading'] = $element['#bar']['#heading'];
- // Prepare the trays and tabs for each toolbar item as well as the remainder
- // variable that will hold any non-tray, non-tab elements.
- $variables['trays'] = [];
- $variables['tabs'] = [];
- $variables['remainder'] = [];
- foreach (Element::children($element) as $key) {
- // Early rendering to collect the wrapper attributes from
- // ToolbarItem elements.
- if (!empty($element[$key])) {
- Drupal::service('renderer')->render($element[$key]);
- }
- // Add the tray.
- if (isset($element[$key]['tray'])) {
- $attributes = [];
- if (!empty($element[$key]['tray']['#wrapper_attributes'])) {
- $attributes = $element[$key]['tray']['#wrapper_attributes'];
- }
- $variables['trays'][$key] = [
- 'links' => $element[$key]['tray'],
- 'attributes' => new Attribute($attributes),
- ];
- if (array_key_exists('#heading', $element[$key]['tray'])) {
- $variables['trays'][$key]['label'] = $element[$key]['tray']['#heading'];
- }
- }
- // Add the tab.
- if (isset($element[$key]['tab'])) {
- $attributes = [];
- // Pass the wrapper attributes along.
- if (!empty($element[$key]['#wrapper_attributes'])) {
- $attributes = $element[$key]['#wrapper_attributes'];
- }
- $variables['tabs'][$key] = [
- 'link' => $element[$key]['tab'],
- 'attributes' => new Attribute($attributes),
- ];
- }
- // Add other non-tray, non-tab child elements to the remainder variable for
- // later rendering.
- foreach (Element::children($element[$key]) as $child_key) {
- if (!in_array($child_key, ['tray', 'tab'])) {
- $variables['remainder'][$key][$child_key] = $element[$key][$child_key];
- }
- }
- }
- }
- /**
- * Implements hook_toolbar().
- */
- function toolbar_toolbar() {
- // The 'Home' tab is a simple link, with no corresponding tray.
- $items['home'] = [
- '#type' => 'toolbar_item',
- 'tab' => [
- '#type' => 'link',
- '#title' => t('Back to site'),
- '#url' => Url::fromRoute('<front>'),
- '#attributes' => [
- 'title' => t('Return to site content'),
- 'class' => ['toolbar-icon', 'toolbar-icon-escape-admin'],
- 'data-toolbar-escape-admin' => TRUE,
- ],
- ],
- '#wrapper_attributes' => [
- 'class' => ['home-toolbar-tab'],
- ],
- '#attached' => [
- 'library' => [
- 'toolbar/toolbar.escapeAdmin',
- ],
- ],
- '#weight' => -20,
- ];
- // To conserve bandwidth, we only include the top-level links in the HTML.
- // The subtrees are fetched through a JSONP script that is generated at the
- // toolbar_subtrees route. We provide the JavaScript requesting that JSONP
- // script here with the hash parameter that is needed for that route.
- // @see toolbar_subtrees_jsonp()
- list($hash, $hash_cacheability) = _toolbar_get_subtrees_hash();
- $subtrees_attached['drupalSettings']['toolbar'] = [
- 'subtreesHash' => $hash,
- ];
- // The administration element has a link that is themed to correspond to
- // a toolbar tray. The tray contains the full administrative menu of the site.
- $items['administration'] = [
- '#type' => 'toolbar_item',
- 'tab' => [
- '#type' => 'link',
- '#title' => t('Manage'),
- '#url' => Url::fromRoute('system.admin'),
- '#attributes' => [
- 'title' => t('Admin menu'),
- 'class' => ['toolbar-icon', 'toolbar-icon-menu'],
- // A data attribute that indicates to the client to defer loading of
- // the admin menu subtrees until this tab is activated. Admin menu
- // subtrees will not render to the DOM if this attribute is removed.
- // The value of the attribute is intentionally left blank. Only the
- // presence of the attribute is necessary.
- 'data-drupal-subtrees' => '',
- ],
- ],
- 'tray' => [
- '#heading' => t('Administration menu'),
- '#attached' => $subtrees_attached,
- 'toolbar_administration' => [
- '#pre_render' => [[ToolbarController::class, 'preRenderAdministrationTray']],
- '#type' => 'container',
- '#attributes' => [
- 'class' => ['toolbar-menu-administration'],
- ],
- ],
- ],
- '#weight' => -15,
- ];
- $hash_cacheability->applyTo($items['administration']);
- return $items;
- }
- /**
- * Renders the toolbar's administration tray.
- *
- * @param array $element
- * A renderable array.
- *
- * @return array
- * The updated renderable array.
- *
- * @deprecated in drupal:8.8.0 and is removed from drupal:9.0.0. Use
- * \Drupal\toolbar\Controller\ToolbarController::preRenderAdministrationTray()
- * instead.
- *
- * @see https://www.drupal.org/node/2966725
- * @see \Drupal\Core\Render\RendererInterface::render()
- */
- function toolbar_prerender_toolbar_administration_tray(array $element) {
- @trigger_error('toolbar_prerender_toolbar_administration_tray() is deprecated in Drupal 8.8.0 and will be removed before Drupal 9.0.0. Use \Drupal\toolbar\Controller\ToolbarController::preRenderAdministrationTray() instead. See https://www.drupal.org/node/2966725', E_USER_DEPRECATED);
- return ToolbarController::preRenderAdministrationTray($element);
- }
- /**
- * Adds toolbar-specific attributes to the menu link tree.
- *
- * @param \Drupal\Core\Menu\MenuLinkTreeElement[] $tree
- * The menu link tree to manipulate.
- *
- * @return \Drupal\Core\Menu\MenuLinkTreeElement[]
- * The manipulated menu link tree.
- */
- function toolbar_menu_navigation_links(array $tree) {
- foreach ($tree as $element) {
- if ($element->subtree) {
- toolbar_menu_navigation_links($element->subtree);
- }
- // Make sure we have a path specific ID in place, so we can attach icons
- // and behaviors to the menu links.
- $link = $element->link;
- $url = $link->getUrlObject();
- if (!$url->isRouted()) {
- // This is an unusual case, so just get a distinct, safe string.
- $id = substr(Crypt::hashBase64($url->getUri()), 0, 16);
- }
- else {
- $id = str_replace(['.', '<', '>'], ['-', '', ''], $url->getRouteName());
- }
- // Get the non-localized title to make the icon class.
- $definition = $link->getPluginDefinition();
- $element->options['attributes']['id'] = 'toolbar-link-' . $id;
- $element->options['attributes']['class'][] = 'toolbar-icon';
- $element->options['attributes']['class'][] = 'toolbar-icon-' . strtolower(str_replace(['.', ' ', '_'], ['-', '-', '-'], $definition['id']));
- $element->options['attributes']['title'] = $link->getDescription();
- }
- return $tree;
- }
- /**
- * Implements hook_preprocess_HOOK() for HTML document templates.
- */
- function toolbar_preprocess_html(&$variables) {
- if (!\Drupal::currentUser()->hasPermission('access toolbar')) {
- return;
- }
- $variables['attributes']['class'][] = 'toolbar-tray-open';
- $variables['attributes']['class'][] = 'toolbar-horizontal';
- $variables['attributes']['class'][] = 'toolbar-fixed';
- $variables['attributes']['class'][] = 'toolbar-loading';
- }
- /**
- * Returns the rendered subtree of each top-level toolbar link.
- *
- * @return array
- * An array with the following key-value pairs:
- * - 'subtrees': the rendered subtrees
- * - 'cacheability: the associated cacheability.
- */
- function toolbar_get_rendered_subtrees() {
- $data = [
- '#pre_render' => [[ToolbarController::class, 'preRenderGetRenderedSubtrees']],
- '#cache' => [
- 'keys' => [
- 'toolbar_rendered_subtrees',
- ],
- ],
- '#cache_properties' => ['#subtrees'],
- ];
- \Drupal::service('renderer')->renderPlain($data);
- return [$data['#subtrees'], CacheableMetadata::createFromRenderArray($data)];
- }
- /**
- * #pre_render callback for toolbar_get_rendered_subtrees().
- *
- * @deprecated in drupal:8.8.0 and is removed from drupal:9.0.0. Use
- * \Drupal\toolbar\Controller\ToolbarController::preRenderGetRenderedSubtrees()
- * instead.
- *
- * @see https://www.drupal.org/node/2966725
- */
- function _toolbar_do_get_rendered_subtrees(array $data) {
- @trigger_error('_toolbar_do_get_rendered_subtrees() is deprecated in Drupal 8.8.0 and will be removed before Drupal 9.0.0. Use Drupal\toolbar\Controller\ToolbarController::preRenderGetRenderedSubtrees() instead. See https://www.drupal.org/node/2966725', E_USER_DEPRECATED);
- return ToolbarController::preRenderGetRenderedSubtrees($data);
- }
- /**
- * Returns the hash of the per-user rendered toolbar subtrees.
- *
- * @return string
- * The hash of the admin_menu subtrees.
- */
- function _toolbar_get_subtrees_hash() {
- list($subtrees, $cacheability) = toolbar_get_rendered_subtrees();
- $hash = Crypt::hashBase64(serialize($subtrees));
- return [$hash, $cacheability];
- }
|