TYPO3\CMS\Core\Routing\SiteRouteResult Class Reference

Inheritance diagram for TYPO3\CMS\Core\Routing\SiteRouteResult:

Public Member Functions
	__construct (UriInterface $uri, SiteInterface $site, SiteLanguage $language=null, string $tail='', array $data=[])
	getUri ()
	getSite ()
	getLanguage ()
	getTail ()
	offsetExists ($offset)
	withLanguage (SiteLanguage $language)
	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 = []
	)

Definition at line 58 of file SiteRouteResult.php.

References TYPO3\CMS\Core\Routing\SiteRouteResult\$data, 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.

Member Function Documentation

getLanguage()

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

(

)

Definition at line 77 of file SiteRouteResult.php.

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

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

(

)

Definition at line 82 of file SiteRouteResult.php.

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

Referenced by TYPO3\CMS\Frontend\Middleware\SiteBaseRedirectResolver\process().

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()

TYPO3\CMS\Core\Routing\SiteRouteResult::offsetGet

(

$offset

)

Parameters

mixed

$offset

Definition at line 106 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

Definition at line 126 of file SiteRouteResult.php.

offsetUnset()

TYPO3\CMS\Core\Routing\SiteRouteResult::offsetUnset

(

$offset

)

Parameters

mixed

$offset

Definition at line 146 of file SiteRouteResult.php.

withLanguage()

TYPO3\CMS\Core\Routing\SiteRouteResult::withLanguage

(

SiteLanguage

$language

)

Definition at line 95 of file SiteRouteResult.php.

References TYPO3\CMS\Core\Routing\SiteRouteResult\$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

SiteLanguage null TYPO3\CMS\Core\Routing\SiteRouteResult::$language

protected

Definition at line 46 of file SiteRouteResult.php.

Referenced by TYPO3\CMS\Core\Routing\SiteRouteResult\__construct(), TYPO3\CMS\Core\Routing\SiteRouteResult\getLanguage(), TYPO3\CMS\Core\Routing\SiteRouteResult\offsetGet(), and TYPO3\CMS\Core\Routing\SiteRouteResult\withLanguage().

$site

SiteInterface TYPO3\CMS\Core\Routing\SiteRouteResult::$site

protected

Definition at line 42 of file SiteRouteResult.php.

Referenced by TYPO3\CMS\Core\Routing\SiteRouteResult\__construct(), TYPO3\CMS\Core\Routing\SiteRouteResult\getSite(), and TYPO3\CMS\Core\Routing\SiteRouteResult\offsetGet().

$tail

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

protected

The leftover string of the path from the uri

Definition at line 56 of file SiteRouteResult.php.

Referenced by TYPO3\CMS\Core\Routing\SiteRouteResult\__construct(), TYPO3\CMS\Core\Routing\SiteRouteResult\getTail(), and TYPO3\CMS\Core\Routing\SiteRouteResult\offsetGet().

$uri

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

protected

Incoming URI which was processed.

Definition at line 38 of file SiteRouteResult.php.

Referenced by TYPO3\CMS\Core\Routing\SiteRouteResult\__construct(), TYPO3\CMS\Core\Routing\SiteRouteResult\getUri(), and TYPO3\CMS\Core\Routing\SiteRouteResult\offsetGet().

$validProperties

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

protected

Definition at line 33 of file SiteRouteResult.php.