W3cubDocs

/Drupal 8

class Url

Defines an object that holds information about a URL.

Hierarchy

File

core/lib/Drupal/Core/Url.php, line 17

Namespace

Drupal\Core

Members

Name Modifiers Type Description
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function
DependencySerializationTrait::__wakeup public function
Url::$accessManager protected property The access manager
Url::$external protected property Indicates whether this object contains an external URL.
Url::$internalPath protected property Stores the internal path, if already requested by getInternalPath().
Url::$options protected property The URL options.
Url::$routeName protected property The route name.
Url::$routeParameters protected property The route parameters.
Url::$unrouted protected property Indicates whether this URL is for a URI without a Drupal route.
Url::$uri protected property The non-route URI.
Url::$urlAssembler protected property The unrouted URL assembler.
Url::$urlGenerator protected property The URL generator.
Url::access public function Checks this Url object against applicable access check services.
Url::accessManager protected function
Url::createFromRequest public static function Returns the Url object matching a request.
Url::fromEntityUri protected static function Create a new Url object for entity URIs.
Url::fromInternalUri protected static function Creates a new Url object for 'internal:' URIs.
Url::fromRoute public static function Creates a new Url object for a URL that has a Drupal route.
Url::fromRouteMatch public static function Creates a new URL object from a route match.
Url::fromRouteUri protected static function Creates a new Url object for 'route:' URIs.
Url::fromUri public static function Creates a new Url object from a URI.
Url::fromUserInput public static function Creates a Url object for a relative URI reference submitted by user input.
Url::getInternalPath public function Returns the internal path (system path) for this route.
Url::getOption public function Gets a specific option.
Url::getOptions public function Returns the URL options.
Url::getRouteName public function Returns the route name.
Url::getRouteParameters public function Returns the route parameters.
Url::getUri public function Returns the URI value for this Url object.
Url::isExternal public function Indicates if this Url is external.
Url::isRouted public function Indicates if this Url has a Drupal route.
Url::renderAccess public static function Checks a Url render element against applicable access check services.
Url::setAbsolute public function Sets the value of the absolute option for this Url.
Url::setOption public function Sets a specific option.
Url::setOptions public function Sets the URL options.
Url::setRouteParameter public function Sets a specific route parameter.
Url::setRouteParameters public function Sets the route parameters.
Url::setUnrouted protected function Sets this Url to encapsulate an unrouted URI.
Url::setUnroutedUrlAssembler public function Sets the unrouted URL assembler.
Url::setUrlGenerator public function Sets the URL generator.
Url::toRenderArray public function Returns the route information for a render array.
Url::toString public function Generates the string URL representation for this Url object.
Url::toUriString public function Generates a URI string that represents the data in the Url object.
Url::unroutedUrlAssembler protected function Gets the unrouted URL assembler for non-Drupal URLs.
Url::urlGenerator protected function Gets the URL generator.
Url::__construct public function Constructs a new Url object.

© 2001–2016 by the original authors
Licensed under the GNU General Public License, version 2 and later.
Drupal is a registered trademark of Dries Buytaert.
https://api.drupal.org/api/drupal/core!lib!Drupal!Core!Url.php/class/Url/8.1.x