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()  : void
offsetUnset()  : void
withLanguage()  : self

Properties

$data

data bag with additional attributes

protected array<string|int, mixed> $data

$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> = []

getTail()

public getTail() : string
Return values
string

getUri()

public getUri() : UriInterface
Return values
UriInterface

offsetExists()

public offsetExists(mixed $offset) : bool
Parameters
$offset : mixed
Return values
bool

offsetSet()

public offsetSet(mixed $offset, mixed $value) : void
Parameters
$offset : mixed
$value : mixed

offsetUnset()

public offsetUnset(mixed $offset) : void
Parameters
$offset : mixed 

        

        
    




    

    

                            

            

                            
    

        On this page

        
    


            

                    

        

    

        

            
Search results