UrlUtil
in package
Table of Contents
Properties
- $requestStack : RequestStack
Methods
- __construct() : mixed
- addQueryStringParameterToUrl() : string
- Add a query string parameter to a URL.
- makeUrlRelative() : string
- Convert an absolute url to a relative url.
- removeQueryStringParameterFromUrl() : string
- Remove query parameters (GET parameter) from a URL.
- getUrlOrDefault() : string
Properties
$requestStack read-only
private
RequestStack
$requestStack
Methods
__construct()
public
__construct(RequestStack $requestStack) : mixed
Parameters
- $requestStack : RequestStack
addQueryStringParameterToUrl()
Add a query string parameter to a URL.
public
addQueryStringParameterToUrl(string|array<string, string> $parameter[, string|null $url = null ]) : string
You can pass a string or an associative array to $parameter. If no url is given, the current request URL is used.
Parameters
- $parameter : string|array<string, string>
-
The query parameters to add.
- $url : string|null = null
-
The URL to which the query parameter(s) should be added. If null, the current request URL is used.
Tags
Return values
string —The concatenated URL.
makeUrlRelative()
Convert an absolute url to a relative url.
public
makeUrlRelative(string $url[, array{removeLeadingSlash?: bool} $options = [] ]) : string
Options:
- removeLeadingSlash: Remove leading slash from path
Parameters
- $url : string
-
The url that should be made relative
- $options : array{removeLeadingSlash?: bool} = []
-
Pass additional options
Tags
Return values
stringremoveQueryStringParameterFromUrl()
Remove query parameters (GET parameter) from a URL.
public
removeQueryStringParameterFromUrl(string|array<string|int, string> $parameter[, string $url = null ]) : string
You can pass a string or an associative array to $parameter. If no URL is given, the current request url is used.
Parameters
- $parameter : string|array<string|int, string>
-
The query parameter names to remove.
- $url : string = null
-
The URL to rid of the given query parameters.
Tags
Return values
string —The URL without the given query parameters.
getUrlOrDefault()
private
getUrlOrDefault([string|null $url = null ]) : string
Parameters
- $url : string|null = null