HelpBreadcrumbBuilder.php

Same filename and directory in other branches
  1. 8.9.x core/modules/help_topics/src/HelpBreadcrumbBuilder.php
  2. 10 core/modules/help_topics/src/HelpBreadcrumbBuilder.php
  3. 10 core/modules/help/src/HelpBreadcrumbBuilder.php
  4. 11.x core/modules/help_topics/src/HelpBreadcrumbBuilder.php
  5. 11.x core/modules/help/src/HelpBreadcrumbBuilder.php

Namespace

Drupal\help_topics

File

core/modules/help_topics/src/HelpBreadcrumbBuilder.php

View source
<?php

namespace Drupal\help_topics;

use Drupal\Core\Breadcrumb\Breadcrumb;
use Drupal\Core\Breadcrumb\BreadcrumbBuilderInterface;
use Drupal\Core\Link;
use Drupal\Core\Routing\RouteMatchInterface;
use Drupal\Core\StringTranslation\StringTranslationTrait;
use Drupal\Core\StringTranslation\TranslationInterface;

/**
 * Provides a breadcrumb builder for help topic pages.
 *
 * @internal
 *   Help Topics is currently experimental and should only be leveraged by
 *   experimental modules and development releases of contributed modules.
 *   See https://www.drupal.org/core/experimental for more information.
 */
class HelpBreadcrumbBuilder implements BreadcrumbBuilderInterface {
    use StringTranslationTrait;
    
    /**
     * Constructs the HelpBreadcrumbBuilder.
     *
     * @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
     *   The translation service.
     */
    public function __construct(TranslationInterface $string_translation) {
        $this->stringTranslation = $string_translation;
    }
    
    /**
     * {@inheritdoc}
     */
    public function applies(RouteMatchInterface $route_match) {
        return $route_match->getRouteName() == 'help.help_topic';
    }
    
    /**
     * {@inheritdoc}
     */
    public function build(RouteMatchInterface $route_match) {
        $breadcrumb = new Breadcrumb();
        $breadcrumb->addCacheContexts([
            'url.path.parent',
        ]);
        $breadcrumb->addLink(Link::createFromRoute($this->t('Home'), '<front>'));
        $breadcrumb->addLink(Link::createFromRoute($this->t('Administration'), 'system.admin'));
        $breadcrumb->addLink(Link::createFromRoute($this->t('Help'), 'help.main'));
        return $breadcrumb;
    }

}

Classes

Title Deprecated Summary
HelpBreadcrumbBuilder Provides a breadcrumb builder for help topic pages.

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