1. class
  2. Drupal
  3. \
  4. help_topics
  5. \
  6. HelpTwigExtension

HelpTwigExtension

class HelpTwigExtension extends AbstractExtension (View source)

Defines and registers Drupal Twig extensions for rendering help topics.

Traits

StringTranslationTrait

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

Properties

protected TranslationInterface $stringTranslation

The string translation service.

 from  StringTranslationTrait
protected AccessManagerInterface $accessManager

The access manager.
protected HelpTopicPluginManagerInterface $pluginManager

The help topic plugin manager.

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(AccessManagerInterface $access_manager, HelpTopicPluginManagerInterface $plugin_manager, TranslationInterface $string_translation)

Constructs a \Drupal\help_topics\HelpTwigExtension.

getFunctions()

{@inheritdoc}

array
getRouteLink(string $text, string $route, array $parameters = [], array $options = [])

Returns a link or plain text, given text, route name, and parameters.

array
getTopicLink(string $topic_id)

Returns a link to a help topic, or the title of the topic.

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 48
__construct(AccessManagerInterface $access_manager, HelpTopicPluginManagerInterface $plugin_manager, TranslationInterface $string_translation)

Constructs a \Drupal\help_topics\HelpTwigExtension.

Parameters

AccessManagerInterface $access_manager

The access manager.
HelpTopicPluginManagerInterface $plugin_manager

The help topic plugin manager service.
TranslationInterface $string_translation

The string translation service.

at line 57
getFunctions()

{@inheritdoc}

Returns a link or plain text, given text, route name, and parameters.

Parameters

string $text

The link text.
string $route

The name of the route.
array $parameters

(optional) An associative array of route parameter names and values.
array $options

(optional) An associative array of additional options. The 'absolute' option is forced to be TRUE.

Return Value

array

A render array with a generated absolute link to the given route. If the user does not have permission for the route, or an exception occurs, such as a missing route or missing parameters, the render array is for the link text as a plain string instead.

See also

TwigExtension::getUrl

Returns a link to a help topic, or the title of the topic.

Parameters

string $topic_id

The help topic ID.

Return Value

array

A render array with a generated absolute link to the given topic. If the user does not have permission to view the topic, or an exception occurs, such as the topic not being defined due to a module not being installed, a default string is returned.

See also

TwigExtension::getUrl