class GeneratedUrl in Zircon Profile 8.0

Used to return generated URLs, along with associated bubbleable metadata.

Note: not to be confused with \Drupal\Core\Url, which is for passing around ungenerated URLs (typically 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\GeneratedUrl

10 files declare their use of GeneratedUrl

FieldPluginBaseTest.php in core/modules/views/tests/src/Unit/Plugin/field/FieldPluginBaseTest.php

Contains \Drupal\Tests\views\Unit\Plugin\field\FieldPluginBaseTest.

LinkGeneratorTest.php in core/tests/Drupal/Tests/Core/Utility/LinkGeneratorTest.php

Contains \Drupal\Tests\Core\Utility\LinkGeneratorTest.

MetadataBubblingUrlGenerator.php in core/lib/Drupal/Core/Render/MetadataBubblingUrlGenerator.php

Contains \Drupal\Core\Render\MetadataBubblingUrlGenerator.

RenderElementTest.php in core/tests/Drupal/Tests/Core/Render/Element/RenderElementTest.php

Contains \Drupal\Tests\Core\Render\Element\RenderElementTest.

RouteNoneTest.php in core/modules/system/src/Tests/RouteProcessor/RouteNoneTest.php

Contains \Drupal\system\Tests\RouteProcessor\RouteNoneTest.

... See full list

File

core/lib/Drupal/Core/GeneratedUrl.php, line 18

Contains \Drupal\Core\GeneratedUrl.

Namespace

Drupal\Core

class GeneratedUrl extends BubbleableMetadata {

  /**
   * The string value of the URL.
   *
   * @var string
   */
  protected $generatedUrl = '';

  /**
   * Gets the generated URL.
   *
   * @return string
   */
  public function getGeneratedUrl() {
    return $this->generatedUrl;
  }

  /**
   * Sets the generated URL.
   *
   * @param string $generated_url
   *   The generated URL.
   *
   * @return $this
   */
  public function setGeneratedUrl($generated_url) {
    $this->generatedUrl = $generated_url;
    return $this;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AttachmentsTrait::$attachments	protected	property	The attachments for this response.
AttachmentsTrait::addAttachments	public	function
AttachmentsTrait::getAttachments	public	function
AttachmentsTrait::setAttachments	public	function
BubbleableMetadata::addCacheableDependency	public	function	Overrides RefinableCacheableDependencyTrait::addCacheableDependency
BubbleableMetadata::applyTo	public	function	Applies the values of this bubbleable metadata object to a render array. Overrides CacheableMetadata::applyTo
BubbleableMetadata::createFromObject	public static	function	Creates a bubbleable metadata object from a depended object. Overrides CacheableMetadata::createFromObject
BubbleableMetadata::createFromRenderArray	public static	function	Creates a bubbleable metadata object with values taken from a render array. Overrides CacheableMetadata::createFromRenderArray
BubbleableMetadata::merge	public	function	Merges the values of another bubbleable metadata object with this one. Overrides CacheableMetadata::merge
BubbleableMetadata::mergeAttachments	public static	function	Merges two attachments arrays (which live under the '#attached' key).
CacheableMetadata::getCacheContexts	public	function	The cache contexts associated with this object. Overrides RefinableCacheableDependencyTrait::getCacheContexts
CacheableMetadata::getCacheMaxAge	public	function	The maximum age for which this object may be cached. Overrides RefinableCacheableDependencyTrait::getCacheMaxAge
CacheableMetadata::getCacheTags	public	function	The cache tags associated with this object. Overrides RefinableCacheableDependencyTrait::getCacheTags
CacheableMetadata::setCacheContexts	public	function	Sets cache contexts.
CacheableMetadata::setCacheMaxAge	public	function	Sets the maximum age (in seconds).
CacheableMetadata::setCacheTags	public	function	Sets cache tags.
GeneratedUrl::$generatedUrl	protected	property	The string value of the URL.
GeneratedUrl::getGeneratedUrl	public	function	Gets the generated URL.
GeneratedUrl::setGeneratedUrl	public	function	Sets the generated URL.
RefinableCacheableDependencyTrait::$cacheContexts	protected	property	Cache contexts.
RefinableCacheableDependencyTrait::$cacheMaxAge	protected	property	Cache max-age.
RefinableCacheableDependencyTrait::$cacheTags	protected	property	Cache tags.
RefinableCacheableDependencyTrait::addCacheContexts	public	function
RefinableCacheableDependencyTrait::addCacheTags	public	function
RefinableCacheableDependencyTrait::mergeCacheMaxAge	public	function