1. class
  2. Drupal
  3. \
  4. comment
  5. \
  6. CommentLinkBuilder

CommentLinkBuilder

class CommentLinkBuilder implements CommentLinkBuilderInterface (View source)

Defines a class for building markup for comment links on a commented entity.

Comment links include 'log in to post new comment', 'add new comment' etc.

Traits

StringTranslationTrait

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

Properties

protected TranslationInterface $stringTranslation

The string translation service.

 from  StringTranslationTrait
protected AccountInterface $currentUser

Current user.
protected CommentManagerInterface $commentManager

Comment manager service.
protected ModuleHandlerInterface $moduleHandler

Module handler service.
protected EntityTypeManagerInterface $entityTypeManager

The entity type manager 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(AccountInterface $current_user, CommentManagerInterface $comment_manager, ModuleHandlerInterface $module_handler, TranslationInterface $string_translation, EntityTypeManagerInterface $entity_type_manager)

Constructs a new CommentLinkBuilder object.

array
buildCommentedEntityLinks(FieldableEntityInterface $entity, array $context)

Builds links for the given entity.

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 66
__construct(AccountInterface $current_user, CommentManagerInterface $comment_manager, ModuleHandlerInterface $module_handler, TranslationInterface $string_translation, EntityTypeManagerInterface $entity_type_manager)

Constructs a new CommentLinkBuilder object.

Parameters

AccountInterface $current_user

Current user.
CommentManagerInterface $comment_manager

Comment manager service.
ModuleHandlerInterface $module_handler

Module handler service.
TranslationInterface $string_translation

String translation service.
EntityTypeManagerInterface $entity_type_manager

The entity type manager.

Builds links for the given entity.

Parameters

FieldableEntityInterface $entity

Entity for which the links are being built.
array $context

Array of context passed from the entity view builder.

Return Value

array

Array of entity links.