annotate core/lib/Drupal/Core/Breadcrumb/BreadcrumbBuilderInterface.php @ 19:fa3358dc1485 tip

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