1. class
  2. Drupal
  3. \
  4. system
  5. \
  6. PathBasedBreadcrumbBuilder

PathBasedBreadcrumbBuilder

class PathBasedBreadcrumbBuilder implements BreadcrumbBuilderInterface (View source)

Class to define the menu_link breadcrumb builder.

Traits

StringTranslationTrait

Wrapper methods for \Drupal\Core\StringTranslation\TranslationInterface.

Properties

protected TranslationInterface $stringTranslation

The string translation service.

 from  StringTranslationTrait
protected RequestContext $context

The router request context.
protected AccessManagerInterface $accessManager

The menu link access service.
protected RequestMatcherInterface $router

The dynamic router service.
protected InboundPathProcessorInterface $pathProcessor

The inbound path processor.
protected Config $config

Site config object.
protected TitleResolverInterface $titleResolver

The title resolver.
protected AccountInterface $currentUser

The current user object.
protected CurrentPathStack $currentPath

The current path service.
protected PathMatcherInterface $pathMatcher

The patch matcher service.

Methods

TranslatableMarkup
t(string $string, array $args = [], array $options = [])

Translates a string to the current language or to a given language.

from  StringTranslationTrait
formatPlural($count, $singular, $plural, array $args = [], array $options = [])

Formats a string containing a count of items.

from  StringTranslationTrait
getNumberOfPlurals($langcode = NULL)

Returns the number of plurals supported by a given language.

from  StringTranslationTrait
TranslationInterface
getStringTranslation()

Gets the string translation service.

from  StringTranslationTrait
$this
setStringTranslation(TranslationInterface $translation)

Sets the string translation service to use.

from  StringTranslationTrait
__construct(RequestContext $context, AccessManagerInterface $access_manager, RequestMatcherInterface $router, InboundPathProcessorInterface $path_processor, ConfigFactoryInterface $config_factory, TitleResolverInterface $title_resolver, AccountInterface $current_user, CurrentPathStack $current_path, PathMatcherInterface $path_matcher = NULL)

Constructs the PathBasedBreadcrumbBuilder.

bool
applies(RouteMatchInterface $route_match)

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

Breadcrumb
build(RouteMatchInterface $route_match)

Builds the breadcrumb.

Request
getRequestForPath(string $path, array $exclude)

Matches a path in the router.

Details

in StringTranslationTrait at line 70
protected TranslatableMarkup t(string $string, array $args = [], array $options = [])

Translates a string to the current language or to a given language.

See \Drupal\Core\StringTranslation\TranslatableMarkup::__construct() for important security information and usage guidelines.

In order for strings to be localized, make them available in one of the ways supported by the

Parameters

string $string

A string containing the English text to translate.
array $args

(optional) An associative array of replacements to make after translation. Based on the first character of the key, the value is escaped and/or themed. See \Drupal\Component\Render\FormattableMarkup::placeholderFormat() for details.
array $options

(optional) An associative array of additional options, with the following elements:

  • 'langcode' (defaults to the current language): A language code, to translate to a language other than what is used to display the page.
  • 'context' (defaults to the empty context): The context the source string belongs to. See the @link i18n Internationalization topic @endlink for more information about string contexts.

Return Value

TranslatableMarkup

An object that, when cast to a string, returns the translated string.

See also

FormattableMarkup::placeholderFormat
TranslatableMarkup::__construct

in StringTranslationTrait at line 79
protected formatPlural($count, $singular, $plural, array $args = [], array $options = [])

Formats a string containing a count of items.

Parameters

$count
$singular
$plural
array $args
array $options

See also

TranslationInterface::formatPlural

in StringTranslationTrait at line 88
protected getNumberOfPlurals($langcode = NULL)

Returns the number of plurals supported by a given language.

Parameters

$langcode

See also

PluralFormulaInterface::getNumberOfPlurals

in StringTranslationTrait at line 102
protected TranslationInterface getStringTranslation()

Gets the string translation service.

Return Value

TranslationInterface

The string translation service.

in StringTranslationTrait at line 118
$this setStringTranslation(TranslationInterface $translation)

Sets the string translation service to use.

Parameters

TranslationInterface $translation

The string translation service.

Return Value

$this

at line 119
__construct(RequestContext $context, AccessManagerInterface $access_manager, RequestMatcherInterface $router, InboundPathProcessorInterface $path_processor, ConfigFactoryInterface $config_factory, TitleResolverInterface $title_resolver, AccountInterface $current_user, CurrentPathStack $current_path, PathMatcherInterface $path_matcher = NULL)

Constructs the PathBasedBreadcrumbBuilder.

Parameters

RequestContext $context

The router request context.
AccessManagerInterface $access_manager

The menu link access service.
RequestMatcherInterface $router

The dynamic router service.
InboundPathProcessorInterface $path_processor

The inbound path processor.
ConfigFactoryInterface $config_factory

The config factory service.
TitleResolverInterface $title_resolver

The title resolver service.
AccountInterface $current_user

The current user object.
CurrentPathStack $current_path

The current path.
PathMatcherInterface $path_matcher

The path matcher service.

at line 134
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.

at line 141
Breadcrumb build(RouteMatchInterface $route_match)

Builds the breadcrumb.

Parameters

RouteMatchInterface $route_match

The current route match.

Return Value

Breadcrumb

A breadcrumb.

at line 206
protected Request getRequestForPath(string $path, array $exclude)

Matches a path in the router.

Parameters

string $path

The request path with a leading slash.
array $exclude

An array of paths or system paths to skip.

Return Value

Request

A populated request object or NULL if the path couldn't be matched.