SiteRouteResult implements RouteResultInterface
Class, usually available within request attribute "routing" containing all the findings of the Routers.
When doing page-based routing the SiteRouteResult will get replaced with the PageArguments object.
Table of Contents
Interfaces
- RouteResultInterface
- An object that is usually returned by a Router to contain all results.
Properties
- $data : array<string|int, mixed>
- data bag with additional attributes
- $language : SiteLanguage|null
- $site : SiteInterface
- $tail : string
- The leftover string of the path from the uri
- $uri : UriInterface
- Incoming URI which was processed.
- $validProperties : array<string|int, mixed>
Methods
- __construct() : mixed
- getLanguage() : SiteLanguage|null
- getSite() : SiteInterface
- getTail() : string
- getUri() : UriInterface
- offsetExists() : bool
- offsetGet() : mixed|UriInterface|string|SiteInterface|SiteLanguage
- offsetSet() : mixed
- offsetUnset() : mixed
- withLanguage() : self
Properties
$data
data bag with additional attributes
protected
array<string|int, mixed>
$data
$language
protected
SiteLanguage|null
$language
$site
protected
SiteInterface
$site
$tail
The leftover string of the path from the uri
protected
string
$tail
$uri
Incoming URI which was processed.
protected
UriInterface
$uri
$validProperties
protected
array<string|int, mixed>
$validProperties
= ['uri', 'site', 'language', 'tail']
Methods
__construct()
public
__construct(UriInterface $uri, SiteInterface $site[, SiteLanguage|null $language = null ][, string $tail = '' ][, array<string|int, mixed> $data = [] ]) : mixed
Parameters
- $uri : UriInterface
- $site : SiteInterface
- $language : SiteLanguage|null = null
- $tail : string = ''
- $data : array<string|int, mixed> = []
getLanguage()
public
getLanguage() : SiteLanguage|null
Return values
SiteLanguage|nullgetSite()
public
getSite() : SiteInterface
Return values
SiteInterfacegetTail()
public
getTail() : string
Return values
stringgetUri()
public
getUri() : UriInterface
Return values
UriInterfaceoffsetExists()
public
offsetExists(mixed $offset) : bool
Parameters
- $offset : mixed
Return values
booloffsetGet()
public
offsetGet(mixed $offset) : mixed|UriInterface|string|SiteInterface|SiteLanguage
Parameters
- $offset : mixed
Tags
Attributes
- #[ReturnTypeWillChange]
Return values
mixed|UriInterface|string|SiteInterface|SiteLanguageoffsetSet()
public
offsetSet(mixed $offset, mixed $value) : mixed
Parameters
- $offset : mixed
- $value : mixed
Tags
Attributes
- #[ReturnTypeWillChange]
offsetUnset()
public
offsetUnset(mixed $offset) : mixed
Parameters
- $offset : mixed
Tags
Attributes
- #[ReturnTypeWillChange]
withLanguage()
public
withLanguage(SiteLanguage $language) : self
Parameters
- $language : SiteLanguage