GeneratedUrl.php

Same filename in other branches
  1. 9 core/lib/Drupal/Core/GeneratedUrl.php
  2. 8.9.x core/lib/Drupal/Core/GeneratedUrl.php
  3. 11.x core/lib/Drupal/Core/GeneratedUrl.php

Namespace

Drupal\Core

File

core/lib/Drupal/Core/GeneratedUrl.php

View source
<?php

namespace Drupal\Core;

use Drupal\Core\Render\BubbleableMetadata;

/**
 * Used to return generated URLs, along with associated bubbleable metadata.
 *
 * Note: not to be confused with \Drupal\Core\Url, which is for passing around
 *   URLs that are not generated (typically route name + route parameters).
 */
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;
    }

}

Classes

Title Deprecated Summary
GeneratedUrl Used to return generated URLs, along with associated bubbleable metadata.

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