aleph1.co.uk Git - yaffs-website/blob - web/core/lib/Drupal/Core/Breadcrumb/BreadcrumbBuilderInterface.php

   1 <?php
   2
   3 namespace Drupal\Core\Breadcrumb;
   4
   5 use Drupal\Core\Routing\RouteMatchInterface;
   6
   7 /**
   8  * Defines an interface for classes that build breadcrumbs.
   9  */
  10 interface BreadcrumbBuilderInterface {
  11
  12   /**
  13    * Whether this breadcrumb builder should be used to build the breadcrumb.
  14    *
  15    * @param \Drupal\Core\Routing\RouteMatchInterface $route_match
  16    *   The current route match.
  17    *
  18    * @return bool
  19    *   TRUE if this builder should be used or FALSE to let other builders
  20    *   decide.
  21    */
  22   public function applies(RouteMatchInterface $route_match);
  23
  24   /**
  25    * Builds the breadcrumb.
  26    *
  27    * @param \Drupal\Core\Routing\RouteMatchInterface $route_match
  28    *   The current route match.
  29    *
  30    * @return \Drupal\Core\Breadcrumb\Breadcrumb
  31    *   A breadcrumb.
  32    */
  33   public function build(RouteMatchInterface $route_match);
  34
  35 }