5 * Main functions of the module.
8 use Drupal\Core\Routing\RouteMatchInterface;
9 use Drupal\tour\Entity\Tour;
12 * Implements hook_help().
14 function tour_help($route_name, RouteMatchInterface $route_match) {
15 switch ($route_name) {
16 case 'help.page.tour':
18 $output .= '<h3>' . t('About') . '</h3>';
19 $output .= '<p>' . t("The Tour module provides users with guided tours of the site interface. Each tour consists of several tips that highlight elements of the user interface, guide the user through a workflow, or explain key concepts of the website. For more information, see the <a href=':tour'>online documentation for the Tour module</a>.", [':tour' => 'https://www.drupal.org/documentation/modules/tour']) . '</p>';
20 $output .= '<h3>' . t('Uses') . '</h3>';
22 $output .= '<dt>' . t('Viewing tours') . '</dt>';
23 $output .= '<dd>' . t("If a tour is available on a page, a <em>Tour</em> button will be visible in the toolbar. If you click this button the first tip of the tour will appear. The tour continues after clicking the <em>Next</em> button in the tip. To see a tour users must have the permission <em>Access tour</em> and JavaScript must be enabled in the browser") . '</dd>';
24 $output .= '<dt>' . t('Creating tours') . '</dt>';
25 $output .= '<dd>' . t("Tours can be written as YAML-documents with a text editor, or using the contributed <a href=':tour_ui'>Tour UI</a> module. For more information, see <a href=':doc_url'>the online documentation for writing tours</a>.", [':doc_url' => 'https://www.drupal.org/developing/api/tour', ':tour_ui' => 'https://www.drupal.org/project/tour_ui']) . '</dd>';
32 * Implements hook_toolbar().
34 function tour_toolbar() {
44 if (!\Drupal::currentUser()->hasPermission('access tour')) {
49 '#type' => 'toolbar_item',
51 '#type' => 'html_tag',
53 '#value' => t('Tour'),
55 'class' => ['toolbar-icon', 'toolbar-icon-help'],
56 'aria-pressed' => 'false',
60 '#wrapper_attributes' => [
61 'class' => ['tour-toolbar-tab', 'hidden'],
62 'id' => 'toolbar-tab-tour',
75 * Implements hook_page_bottom().
77 function tour_page_bottom(array &$page_bottom) {
78 if (!\Drupal::currentUser()->hasPermission('access tour')) {
82 // Load all of the items and match on route name.
83 $route_match = \Drupal::routeMatch();
84 $route_name = $route_match->getRouteName();
86 $results = \Drupal::entityQuery('tour')
87 ->condition('routes.*.route_name', $route_name)
89 if (!empty($results) && $tours = Tour::loadMultiple(array_keys($results))) {
90 foreach ($tours as $id => $tour) {
92 if (!$tour->hasMatchingRoute($route_name, $route_match->getRawParameters()->all())) {
97 $page_bottom['tour'] = entity_view_multiple($tours, 'full');
103 * Implements hook_ENTITY_TYPE_insert() for tour entities.
105 function tour_tour_insert($entity) {
106 \Drupal::service('plugin.manager.tour.tip')->clearCachedDefinitions();
110 * Implements hook_ENTITY_TYPE_update() for tour entities.
112 function tour_tour_update($entity) {
113 \Drupal::service('plugin.manager.tour.tip')->clearCachedDefinitions();