PageArguments 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<string|int, mixed>>
- All (merged) arguments of this URI (routeArguments + dynamicArguments)
- $dirty : bool
- $dynamicArguments : array<string, string|array<string|int, mixed>>
- 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<string|int, mixed>>
- Query arguments in the generated URI
- $routeArguments : array<string, string|array<string|int, mixed>>
- Arguments defined in and mapped by a route enhancer
- $staticArguments : array<string, string|array<string|int, mixed>>
- 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<string|int, mixed>>|null
- getArguments() : array<string, string|array<string|int, mixed>>
- getDynamicArguments() : array<string, string|array<string|int, mixed>>
- getPageId() : int
- getPageType() : string
- getQueryArguments() : array<string, string|array<string|int, mixed>>
- getRouteArguments() : array<string, string|array<string|int, mixed>>
- getStaticArguments() : array<string, string|array<string|int, mixed>>
- offsetExists() : bool
- offsetGet() : string|array<string, string|array<string|int, mixed>>|null
- offsetSet() : void
- offsetUnset() : void
- clean() : array<string|int, mixed>
- Cleans empty array recursively.
- diff() : array<string|int, mixed>
- Removes keys that are defined in $second from $first recursively.
- sort() : array<string|int, mixed>
- 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<string|int, mixed>>
$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<string|int, mixed>>
$dynamicArguments
$pageId
protected
int
$pageId
$pageType
protected
string
$pageType
$queryArguments
Query arguments in the generated URI
protected
array<string, string|array<string|int, mixed>>
$queryArguments
= []
$routeArguments
Arguments defined in and mapped by a route enhancer
protected
array<string, string|array<string|int, mixed>>
$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<string|int, mixed>>
$staticArguments
Methods
__construct()
public
__construct(int $pageId, string $pageType, array<string|int, mixed> $routeArguments[, array<string|int, mixed> $staticArguments = [] ][, array<string|int, mixed> $remainingArguments = [] ]) : mixed
Parameters
- $pageId : int
- $pageType : string
- $routeArguments : array<string|int, mixed>
- $staticArguments : array<string|int, mixed> = []
- $remainingArguments : array<string|int, mixed> = []
areDirty()
public
areDirty() : bool
Return values
boolget()
public
get(string $name) : string|array<string, string|array<string|int, mixed>>|null
Parameters
- $name : string
Return values
string|array<string, string|array<string|int, mixed>>|nullgetArguments()
public
getArguments() : array<string, string|array<string|int, mixed>>
Return values
array<string, string|array<string|int, mixed>>getDynamicArguments()
public
getDynamicArguments() : array<string, string|array<string|int, mixed>>
Return values
array<string, string|array<string|int, mixed>>getPageId()
public
getPageId() : int
Return values
intgetPageType()
public
getPageType() : string
Return values
stringgetQueryArguments()
public
getQueryArguments() : array<string, string|array<string|int, mixed>>
Return values
array<string, string|array<string|int, mixed>>getRouteArguments()
public
getRouteArguments() : array<string, string|array<string|int, mixed>>
Return values
array<string, string|array<string|int, mixed>>getStaticArguments()
public
getStaticArguments() : array<string, string|array<string|int, mixed>>
Return values
array<string, string|array<string|int, mixed>>offsetExists()
public
offsetExists(mixed $offset) : bool
Parameters
- $offset : mixed
Return values
booloffsetGet()
public
offsetGet(mixed $offset) : string|array<string, string|array<string|int, mixed>>|null
Parameters
- $offset : mixed
Return values
string|array<string, string|array<string|int, mixed>>|nulloffsetSet()
public
offsetSet(mixed $offset, mixed $value) : void
Parameters
- $offset : mixed
- $value : mixed
offsetUnset()
public
offsetUnset(mixed $offset) : void
Parameters
- $offset : mixed
clean()
Cleans empty array recursively.
protected
clean(array<string, string|array<string|int, mixed>> $array) : array<string|int, mixed>
Parameters
- $array : array<string, string|array<string|int, mixed>>
Return values
array<string|int, mixed>diff()
Removes keys that are defined in $second from $first recursively.
protected
diff(array<string, string|array<string|int, mixed>> $first, array<string, string|array<string|int, mixed>> $second) : array<string|int, mixed>
Parameters
- $first : array<string, string|array<string|int, mixed>>
- $second : array<string, string|array<string|int, mixed>>
Return values
array<string|int, mixed>sort()
Sorts array keys recursively.
protected
sort(array<string, string|array<string|int, mixed>> $array) : array<string|int, mixed>
Parameters
- $array : array<string, string|array<string|int, mixed>>
Return values
array<string|int, mixed>updateDynamicArguments()
Updates dynamic arguments based on definitions for static arguments.
protected
updateDynamicArguments() : void
updateQueryArguments()
protected
updateQueryArguments(array<string, string|array<string|int, mixed>> $queryArguments) : mixed
Parameters
- $queryArguments : array<string, string|array<string|int, mixed>>