class GeneratedUrl in Drupal 10

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

13 files declare their use of GeneratedUrl

EntityReferenceFieldItemNormalizerTest.php in core/modules/serialization/tests/src/Unit/Normalizer/EntityReferenceFieldItemNormalizerTest.php

EntityUrlTest.php in core/tests/Drupal/Tests/Core/Entity/EntityUrlTest.php

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

LinkTest.php in core/modules/jsonapi/tests/src/Unit/JsonApiResource/LinkTest.php

... See full list

File

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

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
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.