interface BreadcrumbBuilderInterface (View source)

Defines an interface for classes that build breadcrumbs.

Methods

bool
applies(RouteMatchInterface $route_match)

Whether this breadcrumb builder should be used to build the breadcrumb.

build(RouteMatchInterface $route_match)

Builds the breadcrumb.

Details

bool applies(RouteMatchInterface $route_match)

Whether this breadcrumb builder should be used to build the breadcrumb.

Parameters

RouteMatchInterface $route_match

The current route match.

Return Value

bool

TRUE if this builder should be used or FALSE to let other builders decide.

Breadcrumb build(RouteMatchInterface $route_match)

Builds the breadcrumb.

Parameters

RouteMatchInterface $route_match

The current route match.

Return Value

Breadcrumb

A breadcrumb.