Url
in package
FinalYes
An internal CMSimple_XH URL
This class is not meant to be instantiated on its own;
instances should only be accessed via Request::url()
.
Since Plib_XH 1.4, the plugin generates
clean URLs,
if that is enabled in the hidden configuration
(plugin_cf['plib']['clean_urls']="true"
).
Table of Contents
Methods
- absolute() : string
- page() : self
- Allows to refer to another page
- path() : self
- Builds URL from a $pth element
- relative() : string
- with() : self
- without() : self
Methods
absolute()
public
absolute() : string
Return values
stringpage()
Allows to refer to another page
public
page(string $page) : self
This is occassionally useful to provide a link to another page of the Website. Since it usually does not make sense to keep existing query parameters in this case, they are removed.
Parameters
- $page : string
Return values
selfpath()
Builds URL from a $pth element
public
path(string $path) : self
This allows to build, for instance, a URL for an image using
$pth["folder"]["images"]
from the Request::url()
.
Since page and params are usually meaningless in this context,
they are removed.
Parameters
- $path : string
Tags
Return values
selfrelative()
public
relative() : string
Return values
stringwith()
public
with(string $name[, string $value = "" ]) : self
Parameters
- $name : string
- $value : string = ""
Return values
selfwithout()
public
without(string $name) : self
Parameters
- $name : string