class HelpTwigExtension in Drupal 9

Defines and registers Drupal Twig extensions for rendering help topics.

Hierarchy

• class \Drupal\help_topics\HelpTwigExtension extends \Twig\Extension\AbstractExtension uses StringTranslationTrait

1 string reference to 'HelpTwigExtension'

help_topics.services.yml in core/modules/help_topics/help_topics.services.yml

core/modules/help_topics/help_topics.services.yml

1 service uses HelpTwigExtension

help_twig.extension in core/modules/help_topics/help_topics.services.yml

Drupal\help_topics\HelpTwigExtension

File

core/modules/help_topics/src/HelpTwigExtension.php, line 20

Namespace

Drupal\help_topics

class HelpTwigExtension extends AbstractExtension {
  use StringTranslationTrait;

  /**
   * The access manager.
   *
   * @var \Drupal\Core\Access\AccessManagerInterface
   */
  protected $accessManager;

  /**
   * The help topic plugin manager.
   *
   * @var \Drupal\help_topics\HelpTopicPluginManagerInterface
   */
  protected $pluginManager;

  /**
   * Constructs a \Drupal\help_topics\HelpTwigExtension.
   *
   * @param \Drupal\Core\Access\AccessManagerInterface $access_manager
   *   The access manager.
   * @param \Drupal\help_topics\HelpTopicPluginManagerInterface $plugin_manager
   *   The help topic plugin manager service.
   * @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
   *   The string translation service.
   */
  public function __construct(AccessManagerInterface $access_manager, HelpTopicPluginManagerInterface $plugin_manager, TranslationInterface $string_translation) {
    $this->accessManager = $access_manager;
    $this->pluginManager = $plugin_manager;
    $this->stringTranslation = $string_translation;
  }

  /**
   * {@inheritdoc}
   */
  public function getFunctions() {
    return [
      new TwigFunction('help_route_link', [
        $this,
        'getRouteLink',
      ]),
      new TwigFunction('help_topic_link', [
        $this,
        'getTopicLink',
      ]),
    ];
  }

  /**
   * Returns a link or plain text, given text, route name, and parameters.
   *
   * @param string $text
   *   The link text.
   * @param string $route
   *   The name of the route.
   * @param array $parameters
   *   (optional) An associative array of route parameter names and values.
   * @param array $options
   *   (optional) An associative array of additional options. The 'absolute'
   *   option is forced to be TRUE.
   *
   * @return 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 \Drupal\Core\Template\TwigExtension::getUrl()
   */
  public function getRouteLink(string $text, string $route, array $parameters = [], array $options = []) : array {
    assert($this->accessManager instanceof AccessManagerInterface, "The access manager hasn't been set up. Any configuration YAML file with a service directive dealing with the Twig configuration can cause this, most likely found in a recently installed or changed module.");
    $bubbles = new BubbleableMetadata();
    $bubbles
      ->addCacheTags([
      'route_match',
    ]);
    try {
      $access_object = $this->accessManager
        ->checkNamedRoute($route, $parameters, NULL, TRUE);
      $bubbles
        ->addCacheableDependency($access_object);
      if ($access_object
        ->isAllowed()) {
        $options['absolute'] = TRUE;
        $url = Url::fromRoute($route, $parameters, $options);

        // Generate the URL to check for parameter problems and collect
        // cache metadata.
        $generated = $url
          ->toString(TRUE);
        $bubbles
          ->addCacheableDependency($generated);
        $build = [
          '#title' => $text,
          '#type' => 'link',
          '#url' => $url,
        ];
      }
      else {

        // If the user doesn't have access, return the link text.
        $build = [
          '#markup' => $text,
        ];
      }
    } catch (RouteNotFoundException|MissingMandatoryParametersException|InvalidParameterException $e) {

      // If the route had one of these exceptions, return the link text.
      $build = [
        '#markup' => $text,
      ];
    }
    $bubbles
      ->applyTo($build);
    return $build;
  }

  /**
   * Returns a link to a help topic, or the title of the topic.
   *
   * @param string $topic_id
   *   The help topic ID.
   *
   * @return 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 \Drupal\Core\Template\TwigExtension::getUrl()
   */
  public function getTopicLink(string $topic_id) : array {
    assert($this->pluginManager instanceof HelpTopicPluginManagerInterface, "The plugin manager hasn't been set up. Any configuration YAML file with a service directive dealing with the Twig configuration can cause this, most likely found in a recently installed or changed module.");
    $bubbles = new BubbleableMetadata();
    $bubbles
      ->addCacheableDependency($this->pluginManager);
    try {
      $plugin = $this->pluginManager
        ->createInstance($topic_id);
    } catch (PluginNotFoundException $e) {

      // Not a topic.
      $plugin = FALSE;
    }
    if ($plugin) {
      $parameters = [
        'id' => $topic_id,
      ];
      $route = 'help.help_topic';
      $build = $this
        ->getRouteLink($plugin
        ->getLabel(), $route, $parameters);
      $bubbles
        ->addCacheableDependency($plugin);
    }
    else {
      $build = [
        '#markup' => $this
          ->t('Missing help topic %topic', [
          '%topic' => $topic_id,
        ]),
      ];
    }
    $bubbles
      ->applyTo($build);
    return $build;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
HelpTwigExtension::$accessManager	protected	property	The access manager.
HelpTwigExtension::$pluginManager	protected	property	The help topic plugin manager.
HelpTwigExtension::getFunctions	public	function
HelpTwigExtension::getRouteLink	public	function	Returns a link or plain text, given text, route name, and parameters.
HelpTwigExtension::getTopicLink	public	function	Returns a link to a help topic, or the title of the topic.
HelpTwigExtension::__construct	public	function	Constructs a \Drupal\help_topics\HelpTwigExtension.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	4
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.