PageArguments
class \
- Implements
- RouteResultInterface
Contains all resolved parameters when a page is resolved from a page path segment plus all fragments.
Table of Contents
Interfaces
- RouteResultInterface
- An object that is usually returned by a Router to contain all results.
Properties
- $arguments : array<string, string|array>
- All (merged) arguments of this URI (routeArguments + dynamicArguments)
- $dirty : bool
- $dynamicArguments : array<string, string|array>
- Route arguments, that have an infinite number of possible values AND query string arguments. These arguments require a cHash.
- $pageId : int
- $pageType : string
- $queryArguments : array<string, string|array>
- Query arguments in the generated URI
- $routeArguments : array<string, string|array>
- Arguments defined in and mapped by a route enhancer
- $staticArguments : array<string, string|array>
- Route arguments mapped by static mappers "static" means the provided values in a URI maps to a finite number of values (routeArguments - "arguments mapped by non static mapper")
Methods
- __construct() : mixed
- areDirty() : bool
- get() : string|array<string, string|array>|null
- getArguments() : array<string, string|array>
- getDynamicArguments() : array<string, string|array>
- getPageId() : int
- getPageType() : string
- getQueryArguments() : array<string, string|array>
- getRouteArguments() : array<string, string|array>
- getStaticArguments() : array<string, string|array>
- offsetExists() : bool
- offsetGet() : string|array<string, string|array>|null
- offsetSet() : mixed
- offsetUnset() : mixed
- clean() : array
- Cleans empty array recursively.
- diff() : array
- Removes keys that are defined in $second from $first recursively.
- sort() : array
- Sorts array keys recursively.
- updateDynamicArguments() : void
- Updates dynamic arguments based on definitions for static arguments.
- updateQueryArguments() : mixed
Properties
$arguments
All (merged) arguments of this URI (routeArguments + dynamicArguments)
protected
array<string, string|array>
$arguments
$dirty
protected
bool
$dirty
= false
$dynamicArguments
Route arguments, that have an infinite number of possible values AND query string arguments. These arguments require a cHash.
protected
array<string, string|array>
$dynamicArguments
$pageId
protected
int
$pageId
$pageType
protected
string
$pageType
$queryArguments
Query arguments in the generated URI
protected
array<string, string|array>
$queryArguments
= []
$routeArguments
Arguments defined in and mapped by a route enhancer
protected
array<string, string|array>
$routeArguments
$staticArguments
Route arguments mapped by static mappers "static" means the provided values in a URI maps to a finite number of values (routeArguments - "arguments mapped by non static mapper")
protected
array<string, string|array>
$staticArguments
Methods
__construct()
public
__construct(int $pageId, string $pageType, array $routeArguments[, array $staticArguments = [] ][, array $remainingArguments = [] ]) : mixed
Parameters
- $pageId : int
- $pageType : string
- $routeArguments : array
- $staticArguments : array = []
- $remainingArguments : array = []
areDirty()
public
areDirty() : bool
Return values
boolget()
public
get(string $name) : string|array<string, string|array>|null
Parameters
- $name : string
Return values
string|array<string, string|array>|nullgetArguments()
public
getArguments() : array<string, string|array>
Return values
array<string, string|array>getDynamicArguments()
public
getDynamicArguments() : array<string, string|array>
Return values
array<string, string|array>getPageId()
public
getPageId() : int
Return values
intgetPageType()
public
getPageType() : string
Return values
stringgetQueryArguments()
public
getQueryArguments() : array<string, string|array>
Return values
array<string, string|array>getRouteArguments()
public
getRouteArguments() : array<string, string|array>
Return values
array<string, string|array>getStaticArguments()
public
getStaticArguments() : array<string, string|array>
Return values
array<string, string|array>offsetExists()
public
offsetExists(mixed $offset) : bool
Parameters
- $offset : mixed
Return values
booloffsetGet()
public
offsetGet(mixed $offset) : string|array<string, string|array>|null
Parameters
- $offset : mixed
Tags
Attributes
- #[ReturnTypeWillChange]
Return values
string|array<string, string|array>|nulloffsetSet()
public
offsetSet(mixed $offset, mixed $value) : mixed
Parameters
- $offset : mixed
- $value : mixed
Tags
Attributes
- #[ReturnTypeWillChange]
offsetUnset()
public
offsetUnset(mixed $offset) : mixed
Parameters
- $offset : mixed
Tags
Attributes
- #[ReturnTypeWillChange]
clean()
Cleans empty array recursively.
protected
clean(array<string, string|array> $array) : array
Parameters
- $array : array<string, string|array>
Return values
arraydiff()
Removes keys that are defined in $second from $first recursively.
protected
diff(array<string, string|array> $first, array<string, string|array> $second) : array
Parameters
- $first : array<string, string|array>
- $second : array<string, string|array>
Return values
arraysort()
Sorts array keys recursively.
protected
sort(array<string, string|array> $array) : array
Parameters
- $array : array<string, string|array>
Return values
arrayupdateDynamicArguments()
Updates dynamic arguments based on definitions for static arguments.
protected
updateDynamicArguments() : void
updateQueryArguments()
protected
updateQueryArguments(array<string, string|array> $queryArguments) : mixed
Parameters
- $queryArguments : array<string, string|array>