TYPO3\CMS\Core\Routing\PageArguments Class Reference

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

Public Member Functions
	__construct (int $pageId, string $pageType, array $routeArguments, array $staticArguments=[], array $remainingArguments=[])
	areDirty ()
	getPageId ()
	getPageType ()
	offsetExists (mixed $offset)
string array< string, offsetGet(mixed $offset):mixed { if( $offset==='pageId') { return $this->	getPageId ()
	offsetSet (mixed $offset, mixed $value)
	offsetUnset (mixed $offset)

Public Attributes
array< string, function getRouteArguments():array { return $this->	routeArguments
string array< string, function get(string $name):mixed { return $this-> arguments[ $name]	null
array< string, function getArguments():array { return $this->	arguments
array< string, function getStaticArguments():array { return $this->	staticArguments
array< string, function getDynamicArguments():array { return $this->	dynamicArguments
array< string, function getQueryArguments():array { return $this->	queryArguments
if($offset==='pageType') return $this arguments[ $offset]	null

Protected Member Functions
	updateQueryArguments (array $queryArguments)
	updateDynamicArguments ()
	clean (array $array)
	sort (array $array)
	diff (array $first, array $second)

Protected Attributes
int	$pageId
string	$pageType
bool	$dirty = false
array	$arguments
array	$staticArguments
array	$dynamicArguments
array	$routeArguments
array	$queryArguments = []

Detailed Description

Contains all resolved parameters when a page is resolved from a page path segment plus all fragments.

Definition at line 25 of file PageArguments.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Core\Routing\PageArguments::__construct	(	int	$pageId,
		string	$pageType,
		array	$routeArguments,
		array	$staticArguments = [],
		array	$remainingArguments = []
	)

Definition at line 69 of file PageArguments.php.

References TYPO3\CMS\Core\Routing\PageArguments\$pageId, TYPO3\CMS\Core\Routing\PageArguments\$pageType, TYPO3\CMS\Core\Routing\PageArguments\$routeArguments, TYPO3\CMS\Core\Routing\PageArguments\arguments, TYPO3\CMS\Core\Routing\PageArguments\routeArguments, TYPO3\CMS\Core\Routing\PageArguments\sort(), TYPO3\CMS\Core\Routing\PageArguments\staticArguments, TYPO3\CMS\Core\Routing\PageArguments\updateDynamicArguments(), and TYPO3\CMS\Core\Routing\PageArguments\updateQueryArguments().

Member Function Documentation

areDirty()

TYPO3\CMS\Core\Routing\PageArguments::areDirty

(

)

Definition at line 82 of file PageArguments.php.

References TYPO3\CMS\Core\Routing\PageArguments\$dirty.

clean()

TYPO3\CMS\Core\Routing\PageArguments::clean ( array  $array )

protected

Cleans empty array recursively.

Parameters

array<string,string|array>

‪$array

Definition at line 181 of file PageArguments.php.

Referenced by TYPO3\CMS\Core\Routing\PageArguments\sort().

diff()

TYPO3\CMS\Core\Routing\PageArguments::diff ( array  $first, array  $second  )

protected

Removes keys that are defined in $second from $first recursively.

Parameters

array<string,string|array>	‪$first
array<string,string|array>	‪$second

Definition at line 215 of file PageArguments.php.

Referenced by TYPO3\CMS\Core\Routing\PageArguments\updateDynamicArguments(), and TYPO3\CMS\Core\Routing\PageArguments\updateQueryArguments().

getPageId() [1/2]

TYPO3\CMS\Core\Routing\PageArguments::getPageId

(

)

Definition at line 95 of file PageArguments.php.

References TYPO3\CMS\Core\Routing\PageArguments\$pageId.

getPageId() [2/2]

string array<string, offsetGet(mixed $offset): mixed { if ($offset === 'pageId') { return $this-> TYPO3\CMS\Core\Routing\PageArguments::getPageId

(

)

Returns

‪string|array<string, string|array>|null

getPageType()

TYPO3\CMS\Core\Routing\PageArguments::getPageType

(

)

Definition at line 100 of file PageArguments.php.

References TYPO3\CMS\Core\Routing\PageArguments\$pageType.

offsetExists()

TYPO3\CMS\Core\Routing\PageArguments::offsetExists

(

mixed

$offset

)

Definition at line 220 of file PageArguments.php.

References TYPO3\CMS\Core\Routing\PageArguments\arguments.

offsetSet()

TYPO3\CMS\Core\Routing\PageArguments::offsetSet	(	mixed	$offset,
		mixed	$value
	)

Definition at line 239 of file PageArguments.php.

offsetUnset()

TYPO3\CMS\Core\Routing\PageArguments::offsetUnset

(

mixed

$offset

)

Definition at line 244 of file PageArguments.php.

sort()

TYPO3\CMS\Core\Routing\PageArguments::sort ( array  $array )

protected

Sorts array keys recursively.

Parameters

array<string,string|array>

‪$array

Definition at line 202 of file PageArguments.php.

References TYPO3\CMS\Core\Routing\PageArguments\clean().

Referenced by TYPO3\CMS\Core\Routing\PageArguments\__construct(), and TYPO3\CMS\Core\Routing\PageArguments\updateQueryArguments().

updateDynamicArguments()

TYPO3\CMS\Core\Routing\PageArguments::updateDynamicArguments ( )

protected

Updates dynamic arguments based on definitions for static arguments.

Definition at line 168 of file PageArguments.php.

References TYPO3\CMS\Core\Routing\PageArguments\arguments, TYPO3\CMS\Core\Routing\PageArguments\diff(), TYPO3\CMS\Core\Routing\PageArguments\dynamicArguments, and TYPO3\CMS\Core\Routing\PageArguments\staticArguments.

Referenced by TYPO3\CMS\Core\Routing\PageArguments\__construct(), and TYPO3\CMS\Core\Routing\PageArguments\updateQueryArguments().

updateQueryArguments()

TYPO3\CMS\Core\Routing\PageArguments::updateQueryArguments ( array  $queryArguments )

protected

Parameters

array<string,string|array>

‪$queryArguments

Definition at line 148 of file PageArguments.php.

References TYPO3\CMS\Core\Routing\PageArguments\$dirty, TYPO3\CMS\Core\Routing\PageArguments\$queryArguments, TYPO3\CMS\Core\Routing\PageArguments\arguments, TYPO3\CMS\Core\Routing\PageArguments\diff(), TYPO3\CMS\Core\Routing\PageArguments\queryArguments, TYPO3\CMS\Core\Routing\PageArguments\routeArguments, TYPO3\CMS\Core\Routing\PageArguments\sort(), and TYPO3\CMS\Core\Routing\PageArguments\updateDynamicArguments().

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

Member Data Documentation

$arguments

array TYPO3\CMS\Core\Routing\PageArguments::$arguments

protected

Definition at line 36 of file PageArguments.php.

$dirty

bool TYPO3\CMS\Core\Routing\PageArguments::$dirty = false

protected

Definition at line 29 of file PageArguments.php.

Referenced by TYPO3\CMS\Core\Routing\PageArguments\areDirty(), and TYPO3\CMS\Core\Routing\PageArguments\updateQueryArguments().

$dynamicArguments

array TYPO3\CMS\Core\Routing\PageArguments::$dynamicArguments

protected

Definition at line 53 of file PageArguments.php.

$pageId

int TYPO3\CMS\Core\Routing\PageArguments::$pageId

protected

Definition at line 27 of file PageArguments.php.

Referenced by TYPO3\CMS\Core\Routing\PageArguments\__construct(), and TYPO3\CMS\Core\Routing\PageArguments\getPageId().

$pageType

string TYPO3\CMS\Core\Routing\PageArguments::$pageType

protected

Definition at line 28 of file PageArguments.php.

Referenced by TYPO3\CMS\Core\Routing\PageArguments\__construct(), and TYPO3\CMS\Core\Routing\PageArguments\getPageType().

$queryArguments

array TYPO3\CMS\Core\Routing\PageArguments::$queryArguments = []

protected

Definition at line 67 of file PageArguments.php.

Referenced by TYPO3\CMS\Core\Routing\PageArguments\updateQueryArguments().

$routeArguments

array TYPO3\CMS\Core\Routing\PageArguments::$routeArguments

protected

Definition at line 60 of file PageArguments.php.

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

$staticArguments

array TYPO3\CMS\Core\Routing\PageArguments::$staticArguments

protected

Definition at line 45 of file PageArguments.php.

arguments

array<string, function getArguments(): array { return $this-> TYPO3\CMS\Core\Routing\PageArguments::arguments

Returns

‪array<string, string|array>

Definition at line 118 of file PageArguments.php.

Referenced by TYPO3\CMS\Core\Routing\PageArguments\__construct(), TYPO3\CMS\Core\Routing\PageArguments\offsetExists(), TYPO3\CMS\Core\Routing\PageArguments\updateDynamicArguments(), and TYPO3\CMS\Core\Routing\PageArguments\updateQueryArguments().

dynamicArguments

array<string, function getDynamicArguments(): array { return $this-> TYPO3\CMS\Core\Routing\PageArguments::dynamicArguments

Returns

‪array<string, string|array>

Definition at line 134 of file PageArguments.php.

Referenced by TYPO3\CMS\Core\Routing\PageArguments\updateDynamicArguments().

null [1/2]

string array<string, function get(string $name): mixed { return $this-> arguments [$name] TYPO3\CMS\Core\Routing\PageArguments::null

Returns

‪string|array<string, string|array>|null

Definition at line 110 of file PageArguments.php.

null [2/2]

if ( $offset==='pageType') return $this arguments [$offset] TYPO3\CMS\Core\Routing\PageArguments::null

Definition at line 236 of file PageArguments.php.

queryArguments

array<string, function getQueryArguments(): array { return $this-> TYPO3\CMS\Core\Routing\PageArguments::queryArguments

Returns

‪array<string, string|array>

Definition at line 142 of file PageArguments.php.

Referenced by TYPO3\CMS\Core\Routing\PageArguments\updateQueryArguments().

routeArguments

array<string, function getRouteArguments(): array { return $this-> TYPO3\CMS\Core\Routing\PageArguments::routeArguments

Returns

‪array<string, string|array>

Definition at line 92 of file PageArguments.php.

Referenced by TYPO3\CMS\Core\Routing\PageArguments\__construct(), and TYPO3\CMS\Core\Routing\PageArguments\updateQueryArguments().

staticArguments

array<string, function getStaticArguments(): array { return $this-> TYPO3\CMS\Core\Routing\PageArguments::staticArguments

Returns

‪array<string, string|array>

Definition at line 126 of file PageArguments.php.

Referenced by TYPO3\CMS\Core\Routing\PageArguments\__construct(), and TYPO3\CMS\Core\Routing\PageArguments\updateDynamicArguments().