class GeneratedLink

Same name and namespace in other branches
  1. 11.x core/lib/Drupal/Core/GeneratedLink.php \Drupal\Core\GeneratedLink
  2. 10 core/lib/Drupal/Core/GeneratedLink.php \Drupal\Core\GeneratedLink
  3. 8.9.x core/lib/Drupal/Core/GeneratedLink.php \Drupal\Core\GeneratedLink

Used to return generated links, along with associated cacheability metadata.

Note: not to be confused with \Drupal\Core\Link, which is for passing around ungenerated links (typically link text + route name + route parameters).

Hierarchy

Expanded class hierarchy of GeneratedLink

4 files declare their use of GeneratedLink
LinkGenerator.php in core/lib/Drupal/Core/Utility/LinkGenerator.php
ThemeRenderAndAutoescapeTest.php in core/tests/Drupal/KernelTests/Core/Theme/ThemeRenderAndAutoescapeTest.php
Contains \Drupal\KernelTests\Core\Theme\ThemeRenderAndAutoescapeTest.
TwigExtensionTest.php in core/tests/Drupal/Tests/Core/Template/TwigExtensionTest.php
TwigMarkupInterfaceTest.php in core/tests/Drupal/KernelTests/Core/Theme/TwigMarkupInterfaceTest.php
Contains \Drupal\KernelTests\Core\Theme\TwigMarkupInterfaceTest.

File

core/lib/Drupal/Core/GeneratedLink.php, line 14

Namespace

Drupal\Core
View source
class GeneratedLink extends BubbleableMetadata implements MarkupInterface, \Countable {
  
  /**
   * HTML tag to use when building the link.
   */
  const TAG = 'a';
  
  /**
   * The HTML string value containing a link.
   *
   * @var string
   */
  protected $generatedLink = '';
  
  /**
   * Gets the generated link.
   *
   * @return string
   */
  public function getGeneratedLink() {
    return $this->generatedLink;
  }
  
  /**
   * Sets the generated link.
   *
   * @param string $generated_link
   *   The generated link.
   *
   * @return $this
   */
  public function setGeneratedLink($generated_link) {
    $this->generatedLink = $generated_link;
    return $this;
  }
  
  /**
   * {@inheritdoc}
   */
  public function __toString() {
    return (string) $this->generatedLink;
  }
  
  /**
   * {@inheritdoc}
   */
  public function jsonSerialize() {
    return $this->__toString();
  }
  
  /**
   * {@inheritdoc}
   */
  public function count() {
    return mb_strlen($this->__toString());
  }

}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.