1. class
  2. Drupal
  3. \
  4. taxonomy
  5. \
  6. TermBreadcrumbBuilder

TermBreadcrumbBuilder

class TermBreadcrumbBuilder implements BreadcrumbBuilderInterface (View source)

Provides a custom taxonomy breadcrumb builder that uses the term hierarchy.

Traits

StringTranslationTrait

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

DeprecatedServicePropertyTrait

Provides a standard way to announce deprecated properties.

Properties

protected TranslationInterface $stringTranslation

The string translation service.

 from  StringTranslationTrait
protected $deprecatedProperties {@inheritdoc}
protected EntityRepositoryInterface $entityRepository

The entity repository manager.
protected EntityTypeManagerInterface $entityTypeManager

The entity type manager.
protected TermStorageInterface $termStorage

The taxonomy storage.

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
__get($name)

Allows to access deprecated/removed properties.

from  DeprecatedServicePropertyTrait
__construct(EntityTypeManagerInterface $entity_type_manager, EntityRepositoryInterface $entity_repository = NULL)

Constructs the TermBreadcrumbBuilder.

bool
applies(RouteMatchInterface $route_match)

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

Breadcrumb
build(RouteMatchInterface $route_match)

Builds the breadcrumb.

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

in DeprecatedServicePropertyTrait at line 15
__get($name)

Allows to access deprecated/removed properties.

This method must be public.

Parameters

$name

at line 55
__construct(EntityTypeManagerInterface $entity_type_manager, EntityRepositoryInterface $entity_repository = NULL)

Constructs the TermBreadcrumbBuilder.

Parameters

EntityTypeManagerInterface $entity_type_manager

The entity type manager.
EntityRepositoryInterface $entity_repository

The entity repository.

at line 68
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 76
Breadcrumb build(RouteMatchInterface $route_match)

Builds the breadcrumb.

Parameters

RouteMatchInterface $route_match

The current route match.

Return Value

Breadcrumb

A breadcrumb.