class CommentBreadcrumbBuilder in Drupal 8

Class to define the comment breadcrumb builder.

Hierarchy

• class \Drupal\comment\CommentBreadcrumbBuilder implements BreadcrumbBuilderInterface uses StringTranslationTrait

1 string reference to 'CommentBreadcrumbBuilder'

comment.services.yml in core/modules/comment/comment.services.yml

core/modules/comment/comment.services.yml

1 service uses CommentBreadcrumbBuilder

comment.breadcrumb in core/modules/comment/comment.services.yml

Drupal\comment\CommentBreadcrumbBuilder

File

core/modules/comment/src/CommentBreadcrumbBuilder.php, line 15

Namespace

Drupal\comment

class CommentBreadcrumbBuilder implements BreadcrumbBuilderInterface {
  use StringTranslationTrait;

  /**
   * The comment storage.
   *
   * @var \Drupal\Core\Entity\EntityStorageInterface
   */
  protected $storage;

  /**
   * Constructs the CommentBreadcrumbBuilder.
   *
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   */
  public function __construct(EntityTypeManagerInterface $entity_type_manager) {
    $this->storage = $entity_type_manager
      ->getStorage('comment');
  }

  /**
   * {@inheritdoc}
   */
  public function applies(RouteMatchInterface $route_match) {
    return $route_match
      ->getRouteName() == 'comment.reply' && $route_match
      ->getParameter('entity');
  }

  /**
   * {@inheritdoc}
   */
  public function build(RouteMatchInterface $route_match) {
    $breadcrumb = new Breadcrumb();
    $breadcrumb
      ->addCacheContexts([
      'route',
    ]);
    $breadcrumb
      ->addLink(Link::createFromRoute($this
      ->t('Home'), '<front>'));
    $entity = $route_match
      ->getParameter('entity');
    $breadcrumb
      ->addLink(new Link($entity
      ->label(), $entity
      ->toUrl()));
    $breadcrumb
      ->addCacheableDependency($entity);
    if (($pid = $route_match
      ->getParameter('pid')) && ($comment = $this->storage
      ->load($pid))) {

      /** @var \Drupal\comment\CommentInterface $comment */
      $breadcrumb
        ->addCacheableDependency($comment);

      // Display link to parent comment.
      // @todo Clean-up permalink in https://www.drupal.org/node/2198041
      $breadcrumb
        ->addLink(new Link($comment
        ->getSubject(), $comment
        ->toUrl()));
    }
    return $breadcrumb;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CommentBreadcrumbBuilder::$storage	protected	property	The comment storage.
CommentBreadcrumbBuilder::applies	public	function	Whether this breadcrumb builder should be used to build the breadcrumb. Overrides BreadcrumbBuilderInterface::applies
CommentBreadcrumbBuilder::build	public	function	Builds the breadcrumb. Overrides BreadcrumbBuilderInterface::build
CommentBreadcrumbBuilder::__construct	public	function	Constructs the CommentBreadcrumbBuilder.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.