1. 8.5.x core/lib/Drupal/Core/Routing/LinkGeneratorTrait.php LinkGeneratorTrait
  2. 8.0.x core/lib/Drupal/Core/Routing/LinkGeneratorTrait.php LinkGeneratorTrait
  3. 8.1.x core/lib/Drupal/Core/Routing/LinkGeneratorTrait.php LinkGeneratorTrait
  4. 8.2.x core/lib/Drupal/Core/Routing/LinkGeneratorTrait.php LinkGeneratorTrait
  5. 8.3.x core/lib/Drupal/Core/Routing/LinkGeneratorTrait.php LinkGeneratorTrait
  6. 8.4.x core/lib/Drupal/Core/Routing/LinkGeneratorTrait.php LinkGeneratorTrait
  7. 8.6.x core/lib/Drupal/Core/Routing/LinkGeneratorTrait.php LinkGeneratorTrait

Wrapper methods for the Link Generator.

This utility trait should only be used in application-level code, such as classes that would implement ContainerInjectionInterface. Services registered in the Container should not use this trait but inject the appropriate service directly for easier testing.

Hierarchy

Deprecated

in Drupal 8.0.0 and will be removed before Drupal 9.0.0. Use \Drupal\Core\Link instead.

4 files declare their use of LinkGeneratorTrait
ControllerBase.php in core/lib/Drupal/Core/Controller/ControllerBase.php
FormBase.php in core/lib/Drupal/Core/Form/FormBase.php
FormErrorHandler.php in core/modules/inline_form_errors/src/FormErrorHandler.php
Link.php in core/lib/Drupal/Core/Link.php

File

core/lib/Drupal/Core/Routing/LinkGeneratorTrait.php, line 20

Namespace

Drupal\Core\Routing
View source
trait LinkGeneratorTrait {

  /**
   * The link generator.
   *
   * @var \Drupal\Core\Utility\LinkGeneratorInterface
   */
  protected $linkGenerator;

  /**
   * Renders a link to a route given a route name and its parameters.
   *
   * For details on the arguments, usage, and possible exceptions see
   * \Drupal\Core\Utility\LinkGeneratorInterface::generate().
   *
   * @return \Drupal\Core\GeneratedLink
   *   A GeneratedLink object containing a link to the given route and
   *   parameters and bubbleable metadata.
   *
   * @deprecated in Drupal 8.0.0 and will be removed before Drupal 9.0.0.
   *   Use \Drupal\Core\Link instead.
   *
   * @see \Drupal\Core\Utility\LinkGeneratorInterface::generate()
   */
  protected function l($text, Url $url) {
    return $this
      ->getLinkGenerator()
      ->generate($text, $url);
  }

  /**
   * Returns the link generator.
   *
   * @return \Drupal\Core\Utility\LinkGeneratorInterface
   *   The link generator
   */
  protected function getLinkGenerator() {
    if (!isset($this->linkGenerator)) {
      $this->linkGenerator = \Drupal::service('link_generator');
    }
    return $this->linkGenerator;
  }

  /**
   * Sets the link generator service.
   *
   * @param \Drupal\Core\Utility\LinkGeneratorInterface $generator
   *   The link generator service.
   *
   * @return $this
   */
  public function setLinkGenerator(LinkGeneratorInterface $generator) {
    $this->linkGenerator = $generator;
    return $this;
  }

}

Members

Contains filters are case sensitive
Namesort descending Modifiers Type Description Overrides
LinkGeneratorTrait::$linkGenerator protected property The link generator.
LinkGeneratorTrait::getLinkGenerator protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator public function Sets the link generator service.