interface BreadcrumbBuilderInterface

Same name in other branches
  1. 9 core/lib/Drupal/Core/Breadcrumb/BreadcrumbBuilderInterface.php \Drupal\Core\Breadcrumb\BreadcrumbBuilderInterface
  2. 10 core/lib/Drupal/Core/Breadcrumb/BreadcrumbBuilderInterface.php \Drupal\Core\Breadcrumb\BreadcrumbBuilderInterface
  3. 11.x core/lib/Drupal/Core/Breadcrumb/BreadcrumbBuilderInterface.php \Drupal\Core\Breadcrumb\BreadcrumbBuilderInterface

Defines an interface for classes that build breadcrumbs.

Hierarchy

Expanded class hierarchy of BreadcrumbBuilderInterface

All classes that implement BreadcrumbBuilderInterface

7 files declare their use of BreadcrumbBuilderInterface
BookBreadcrumbBuilder.php in core/modules/book/src/BookBreadcrumbBuilder.php
CommentBreadcrumbBuilder.php in core/modules/comment/src/CommentBreadcrumbBuilder.php
ForumBreadcrumbBuilderBase.php in core/modules/forum/src/Breadcrumb/ForumBreadcrumbBuilderBase.php
HelpBreadcrumbBuilder.php in core/modules/help_topics/src/HelpBreadcrumbBuilder.php
PathBasedBreadcrumbBuilder.php in core/modules/system/src/PathBasedBreadcrumbBuilder.php

... See full list

File

core/lib/Drupal/Core/Breadcrumb/BreadcrumbBuilderInterface.php, line 10

Namespace

Drupal\Core\Breadcrumb
View source 
interface BreadcrumbBuilderInterface {
    
    /**
     * Whether this breadcrumb builder should be used to build the breadcrumb.
     *
     * @param \Drupal\Core\Routing\RouteMatchInterface $route_match
     *   The current route match.
     *
     * @return bool
     *   TRUE if this builder should be used or FALSE to let other builders
     *   decide.
     */
    public function applies(RouteMatchInterface $route_match);
    
    /**
     * Builds the breadcrumb.
     *
     * @param \Drupal\Core\Routing\RouteMatchInterface $route_match
     *   The current route match.
     *
     * @return \Drupal\Core\Breadcrumb\Breadcrumb
     *   A breadcrumb.
     */
    public function build(RouteMatchInterface $route_match);

}

Members

Title Modifiers Object type Summary Overrides
BreadcrumbBuilderInterface::applies public function Whether this breadcrumb builder should be used to build the breadcrumb. 8
BreadcrumbBuilderInterface::build public function Builds the breadcrumb. 7

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