Chris@0: <?php
Chris@0: 
Chris@0: /**
Chris@0:  * @file
Chris@0:  * Hooks provided by the toolbar module.
Chris@0:  */
Chris@0: 
Chris@0: use Drupal\Core\Url;
Chris@0: 
Chris@0: /**
Chris@0:  * @addtogroup hooks
Chris@0:  * @{
Chris@0:  */
Chris@0: 
Chris@0: /**
Chris@0:  * Add items to the toolbar menu.
Chris@0:  *
Chris@0:  * The toolbar is a container for administrative and site-global interactive
Chris@0:  * components.
Chris@0:  *
Chris@0:  * The toolbar provides a common styling for items denoted by the
Chris@0:  * .toolbar-tab class.
Chris@0:  *
Chris@0:  * The toolbar provides a construct called a 'tray'. The tray is a container
Chris@0:  * for content. The tray may be associated with a toggle in the administration
Chris@0:  * bar. The toggle shows or hides the tray and is optimized for small and
Chris@0:  * large screens. To create this association, hook_toolbar() returns one or
Chris@0:  * more render elements of type 'toolbar_item', containing the toggle and tray
Chris@0:  * elements in its 'tab' and 'tray' properties.
Chris@0:  *
Chris@0:  * The following properties are available:
Chris@0:  *   - 'tab': A renderable array.
Chris@0:  *   - 'tray': Optional. A renderable array.
Chris@0:  *   - '#weight': Optional. Integer weight used for sorting toolbar items in
Chris@0:  *     administration bar area.
Chris@0:  *
Chris@0:  * This hook is invoked in toolbar_pre_render().
Chris@0:  *
Chris@0:  * @return
Chris@0:  *   An array of toolbar items, keyed by unique identifiers such as 'home' or
Chris@0:  *   'administration', or the short name of the module implementing the hook.
Chris@0:  *   The corresponding value is a render element of type 'toolbar_item'.
Chris@0:  *
Chris@0:  * @see toolbar_pre_render()
Chris@0:  * @ingroup toolbar_tabs
Chris@0:  */
Chris@0: function hook_toolbar() {
Chris@0:   $items = [];
Chris@0: 
Chris@0:   // Add a search field to the toolbar. The search field employs no toolbar
Chris@0:   // module theming functions.
Chris@0:   $items['global_search'] = [
Chris@0:     '#type' => 'toolbar_item',
Chris@0:     'tab' => [
Chris@0:       '#type' => 'search',
Chris@0:       '#attributes' => [
Chris@0:         'placeholder' => t('Search the site'),
Chris@0:         'class' => ['search-global'],
Chris@0:       ],
Chris@0:     ],
Chris@0:     '#weight' => 200,
Chris@0:     // Custom CSS, JS or a library can be associated with the toolbar item.
Chris@0:     '#attached' => [
Chris@0:       'library' => [
Chris@0:         'search/global',
Chris@0:       ],
Chris@0:     ],
Chris@0:   ];
Chris@0: 
Chris@0:   // The 'Home' tab is a simple link, which is wrapped in markup associated
Chris@0:   // with a visual tab styling.
Chris@0:   $items['home'] = [
Chris@0:     '#type' => 'toolbar_item',
Chris@0:     'tab' => [
Chris@0:       '#type' => 'link',
Chris@0:       '#title' => t('Home'),
Chris@0:       '#url' => Url::fromRoute('<front>'),
Chris@0:       '#options' => [
Chris@0:         'attributes' => [
Chris@0:           'title' => t('Home page'),
Chris@0:           'class' => ['toolbar-icon', 'toolbar-icon-home'],
Chris@0:         ],
Chris@0:       ],
Chris@0:     ],
Chris@0:     '#weight' => -20,
Chris@0:   ];
Chris@0: 
Chris@0:   // A tray may be associated with a tab.
Chris@0:   //
Chris@0:   // When the tab is activated, the tray will become visible, either in a
Chris@0:   // horizontal or vertical orientation on the screen.
Chris@0:   //
Chris@0:   // The tray should contain a renderable array. An optional #heading property
Chris@0:   // can be passed. This text is written to a heading tag in the tray as a
Chris@0:   // landmark for accessibility.
Chris@0:   $items['commerce'] = [
Chris@0:     '#type' => 'toolbar_item',
Chris@0:     'tab' => [
Chris@0:       '#type' => 'link',
Chris@0:       '#title' => t('Shopping cart'),
Chris@0:       '#url' => Url::fromRoute('cart'),
Chris@0:       '#options' => [
Chris@0:         'attributes' => [
Chris@0:           'title' => t('Shopping cart'),
Chris@0:         ],
Chris@0:       ],
Chris@0:     ],
Chris@0:     'tray' => [
Chris@0:       '#heading' => t('Shopping cart actions'),
Chris@0:       'shopping_cart' => [
Chris@0:         '#theme' => 'item_list',
Chris@0:         '#items' => [/* An item list renderable array */],
Chris@0:       ],
Chris@0:     ],
Chris@0:     '#weight' => 150,
Chris@0:   ];
Chris@0: 
Chris@0:   // The tray can be used to render arbitrary content.
Chris@0:   //
Chris@0:   // A renderable array passed to the 'tray' property will be rendered outside
Chris@0:   // the administration bar but within the containing toolbar element.
Chris@0:   //
Chris@0:   // If the default behavior and styling of a toolbar tray is not desired, one
Chris@0:   // can render content to the toolbar element and apply custom theming and
Chris@0:   // behaviors.
Chris@0:   $items['user_messages'] = [
Chris@0:     // Include the toolbar_tab_wrapper to style the link like a toolbar tab.
Chris@0:     // Exclude the theme wrapper if custom styling is desired.
Chris@0:     '#type' => 'toolbar_item',
Chris@0:     'tab' => [
Chris@0:       '#type' => 'link',
Chris@0:       '#theme' => 'user_message_toolbar_tab',
Chris@0:       '#theme_wrappers' => [],
Chris@0:       '#title' => t('Messages'),
Chris@0:       '#url' => Url::fromRoute('user.message'),
Chris@0:       '#options' => [
Chris@0:         'attributes' => [
Chris@0:           'title' => t('Messages'),
Chris@0:         ],
Chris@0:       ],
Chris@0:     ],
Chris@0:     'tray' => [
Chris@0:       '#heading' => t('User messages'),
Chris@0:       'messages' => [/* renderable content */],
Chris@0:     ],
Chris@0:     '#weight' => 125,
Chris@0:   ];
Chris@0: 
Chris@0:   return $items;
Chris@0: }
Chris@0: 
Chris@0: /**
Chris@0:  * Alter the toolbar menu after hook_toolbar() is invoked.
Chris@0:  *
Chris@12:  * This hook is invoked by Toolbar::preRenderToolbar() immediately after
Chris@12:  * hook_toolbar(). The toolbar definitions are passed in by reference. Each
Chris@12:  * element of the $items array is one item returned by a module from
Chris@12:  * hook_toolbar(). Additional items may be added, or existing items altered.
Chris@0:  *
Chris@0:  * @param $items
Chris@0:  *   Associative array of toolbar menu definitions returned from hook_toolbar().
Chris@0:  */
Chris@0: function hook_toolbar_alter(&$items) {
Chris@0:   // Move the User tab to the right.
Chris@0:   $items['commerce']['#weight'] = 5;
Chris@0: }
Chris@0: 
Chris@0: /**
Chris@0:  * @} End of "addtogroup hooks".
Chris@0:  */