class GeneratedLink in Drupal 10

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

• class \Drupal\Core\Cache\CacheableMetadata implements RefinableCacheableDependencyInterface uses RefinableCacheableDependencyTrait
  • class \Drupal\Core\Render\BubbleableMetadata implements AttachmentsInterface uses AttachmentsTrait
    • class \Drupal\Core\GeneratedLink implements \Drupal\Core\Countable, MarkupInterface

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

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}
   */

  #[\ReturnTypeWillChange]
  public function jsonSerialize() {
    return $this
      ->__toString();
  }

  /**
   * {@inheritdoc}
   */

  #[\ReturnTypeWillChange]
  public function count() {
    return mb_strlen($this
      ->__toString());
  }

}

Members

Name	Modifiers	Type	Description	Overrides
GeneratedLink::$generatedLink	protected	property	The HTML string value containing a link.
GeneratedLink::count	public	function
GeneratedLink::getGeneratedLink	public	function	Gets the generated link.
GeneratedLink::jsonSerialize	public	function
GeneratedLink::setGeneratedLink	public	function	Sets the generated link.
GeneratedLink::TAG		constant	HTML tag to use when building the link.	2
GeneratedLink::__toString	public	function