‪TYPO3CMS  10.4
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
TYPO3\CMS\Core\Routing\PageArguments Class Reference
Inheritance diagram for TYPO3\CMS\Core\Routing\PageArguments:
TYPO3\CMS\Core\Routing\RouteResultInterface

Public Member Functions

if(!empty($remainingArguments)) bool areDirty ()
 
int getPageId ()
 
string getPageType ()
 
bool offsetExists ($offset)
 
string array< string, offsetGet( $offset) { if( $offset==='pageId') { return $this-> getPageId ()
 
 offsetSet ($offset, $value)
 
 offsetUnset ($offset)
 

Public Attributes

$this arguments = $this->routeArguments
 
array< string, function getRouteArguments():array { return $this-> routeArguments
 
string array< string, function get(string $name) { 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 ()
 
array clean (array $array)
 
array sort (array $array)
 
array diff (array $first, array $second)
 

Protected Attributes

int $pageId
 
string $pageType
 
array< string, $arguments;protected array< string, $staticArguments;protected array< string, $dynamicArguments;protected array< string, $routeArguments;protected array< string, $queryArguments=array();protected bool $dirty=false;public function __construct(int $pageId, string $pageType, array $routeArguments, array $staticArguments=[], array $remainingArguments=[]) { $this->pageId=$pageId;$this->pageType=$pageType;$this->routeArguments=$this->sort( $routeArguments);$this-> staticArguments = $this->sort($staticArguments)
 

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.

Member Function Documentation

◆ areDirty()

if (!empty( $remainingArguments)) bool TYPO3\CMS\Core\Routing\PageArguments::areDirty ( )
Returns
‪bool

Definition at line 95 of file PageArguments.php.

◆ clean()

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

Cleans empty array recursively.

Parameters
array<string,string|array>‪$array
Returns
‪array

Definition at line 202 of file PageArguments.php.

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

◆ diff()

array 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
Returns
‪array

Definition at line 238 of file PageArguments.php.

References TYPO3\CMS\Core\Utility\ArrayUtility\arrayDiffKeyRecursive().

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

◆ getPageId() [1/2]

int TYPO3\CMS\Core\Routing\PageArguments::getPageId ( )
Returns
‪int

Definition at line 111 of file PageArguments.php.

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

Referenced by TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController\getRelevantParametersForCachingFromPageArguments(), TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController\initializeFrontendUserOrUpdateCHashArgument(), TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController\initializeLegacyMountPointArgument(), and TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController\setPageArguments().

◆ getPageId() [2/2]

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

◆ getPageType()

string TYPO3\CMS\Core\Routing\PageArguments::getPageType ( )
Returns
‪string

Definition at line 119 of file PageArguments.php.

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

Referenced by TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController\initializeFrontendUserOrUpdateCHashArgument(), TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController\initializeLegacyMountPointArgument(), and TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController\setPageArguments().

◆ offsetExists()

bool TYPO3\CMS\Core\Routing\PageArguments::offsetExists (   $offset)
Parameters
mixed$offset
Returns
‪bool

Definition at line 247 of file PageArguments.php.

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

◆ offsetSet()

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

Definition at line 271 of file PageArguments.php.

◆ offsetUnset()

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

Definition at line 279 of file PageArguments.php.

◆ sort()

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

Sorts array keys recursively.

Parameters
array<string,string|array>‪$array
Returns
‪array

Definition at line 224 of file PageArguments.php.

References TYPO3\CMS\Core\Routing\PageArguments\clean(), and TYPO3\CMS\Core\Utility\ArrayUtility\naturalKeySortRecursive().

Referenced by 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 188 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\updateQueryArguments().

◆ updateQueryArguments()

TYPO3\CMS\Core\Routing\PageArguments::updateQueryArguments ( array  $queryArguments)
protected
Parameters
array<string,string|array>‪$queryArguments

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\queryArguments, TYPO3\CMS\Core\Routing\PageArguments\routeArguments, TYPO3\CMS\Core\Routing\PageArguments\sort(), and TYPO3\CMS\Core\Routing\PageArguments\updateDynamicArguments().

Member Data Documentation

◆ $pageId

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

Definition at line 29 of file PageArguments.php.

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

◆ $pageType

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

Definition at line 33 of file PageArguments.php.

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

◆ arguments [1/2]

$this TYPO3\CMS\Core\Routing\PageArguments::arguments = $this->routeArguments

Definition at line 85 of file PageArguments.php.

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

◆ arguments [2/2]

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

Definition at line 138 of file PageArguments.php.

◆ dynamicArguments

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

Definition at line 154 of file PageArguments.php.

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

◆ null [1/2]

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

Definition at line 130 of file PageArguments.php.

◆ null [2/2]

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

Definition at line 264 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 162 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 105 of file PageArguments.php.

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

◆ staticArguments [1/2]

array<string, $arguments; protected array<string, $staticArguments; protected array<string, $dynamicArguments; protected array<string, $routeArguments; protected array<string, $queryArguments = array( ); protected bool $dirty = false; public function __construct(int $pageId, string $pageType, array $routeArguments, array $staticArguments = [], array $remainingArguments = []) { $this->pageId = $pageId; $this->pageType = $pageType; $this->routeArguments = $this->sort($routeArguments); $this-> TYPO3\CMS\Core\Routing\PageArguments::staticArguments = $this->sort($staticArguments)
protected

All (merged) arguments of this URI (routeArguments + dynamicArguments)

string|array>

Definition at line 84 of file PageArguments.php.

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

◆ staticArguments [2/2]

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

Definition at line 146 of file PageArguments.php.