‪TYPO3CMS  11.5
TYPO3\CMS\Core\Routing\SiteRouteResult Class Reference
Inheritance diagram for TYPO3\CMS\Core\Routing\SiteRouteResult:
TYPO3\CMS\Core\Routing\RouteResultInterface

Public Member Functions

 __construct (UriInterface $uri, SiteInterface $site, ?SiteLanguage $language=null, string $tail='', array $data=[])
 
 getUri ()
 
 getSite ()
 
 getLanguage ()
 
 getTail ()
 
 offsetExists ($offset)
 
 withLanguage (SiteLanguage $language)
 
mixed UriInterface string SiteInterface SiteLanguage offsetGet ($offset)
 
 offsetSet ($offset, $value)
 
 offsetUnset ($offset)
 

Protected Attributes

array $validProperties = array( 'uri', 'site', 'language', 'tail' )
 
UriInterface $uri
 
SiteInterface $site
 
SiteLanguage null $language
 
array $data
 
string $tail
 

Detailed Description

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.

Definition at line 29 of file SiteRouteResult.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Core\Routing\SiteRouteResult::__construct ( UriInterface  $uri,
SiteInterface  $site,
?SiteLanguage  $language = null,
string  $tail = '',
array  $data = [] 
)

Member Function Documentation

◆ getLanguage()

TYPO3\CMS\Core\Routing\SiteRouteResult::getLanguage ( )

◆ getSite()

TYPO3\CMS\Core\Routing\SiteRouteResult::getSite ( )

Definition at line 72 of file SiteRouteResult.php.

References TYPO3\CMS\Core\Routing\SiteRouteResult\$site.

◆ getTail()

TYPO3\CMS\Core\Routing\SiteRouteResult::getTail ( )

◆ getUri()

TYPO3\CMS\Core\Routing\SiteRouteResult::getUri ( )

Definition at line 67 of file SiteRouteResult.php.

References TYPO3\CMS\Core\Routing\SiteRouteResult\$uri.

◆ offsetExists()

TYPO3\CMS\Core\Routing\SiteRouteResult::offsetExists (   $offset)

Definition at line 87 of file SiteRouteResult.php.

◆ offsetGet()

mixed UriInterface string SiteInterface SiteLanguage TYPO3\CMS\Core\Routing\SiteRouteResult::offsetGet (   $offset)
Parameters
mixed$offset
Returns
‪mixed|UriInterface|string|SiteInterface|SiteLanguage
Todo:

Set parameter type for $offset to mixed as breaking change in v12.

Set return type to mixed as breaking change in v12 and remove #[\ReturnTypeWillChange].

Definition at line 110 of file SiteRouteResult.php.

References TYPO3\CMS\Core\Routing\SiteRouteResult\$language, TYPO3\CMS\Core\Routing\SiteRouteResult\$site, TYPO3\CMS\Core\Routing\SiteRouteResult\$tail, and TYPO3\CMS\Core\Routing\SiteRouteResult\$uri.

◆ offsetSet()

TYPO3\CMS\Core\Routing\SiteRouteResult::offsetSet (   $offset,
  $value 
)
Parameters
mixed$offset
mixed$value
Todo:

Set parameter type for $offset and $value to mixed as breaking change in v12.

Set return type to mixed as breaking change in v12 and remove #[\ReturnTypeWillChange].

Definition at line 133 of file SiteRouteResult.php.

◆ offsetUnset()

TYPO3\CMS\Core\Routing\SiteRouteResult::offsetUnset (   $offset)
Parameters
mixed$offset
Todo:

Set parameter type for $offset to mixed as breaking change in v12.

Set return type to void as breaking change in v12 and remove #[\ReturnTypeWillChange].

Definition at line 156 of file SiteRouteResult.php.

◆ withLanguage()

TYPO3\CMS\Core\Routing\SiteRouteResult::withLanguage ( SiteLanguage  $language)

Member Data Documentation

◆ $data

array TYPO3\CMS\Core\Routing\SiteRouteResult::$data
protected

data bag with additional attributes

Definition at line 51 of file SiteRouteResult.php.

Referenced by TYPO3\CMS\Core\Routing\SiteRouteResult\__construct().

◆ $language

◆ $site

◆ $tail

string TYPO3\CMS\Core\Routing\SiteRouteResult::$tail
protected

◆ $uri

UriInterface TYPO3\CMS\Core\Routing\SiteRouteResult::$uri
protected

◆ $validProperties

array TYPO3\CMS\Core\Routing\SiteRouteResult::$validProperties = array( 'uri', 'site', 'language', 'tail' )
protected

Definition at line 33 of file SiteRouteResult.php.