CompiledRoute
in package
implements
Serializable
CompiledRoutes are returned by the RouteCompiler class.
Tags
Table of Contents
Interfaces
- Serializable
Properties
- $hostRegex : string|null
- $hostTokens : array<string|int, mixed>
- $hostVariables : array<string|int, mixed>
- $pathVariables : array<string|int, mixed>
- $regex : string
- $staticPrefix : string
- $tokens : array<string|int, mixed>
- $variables : array<string|int, mixed>
Methods
- __construct() : mixed
- __serialize() : array<string|int, mixed>
- __unserialize() : void
- getHostRegex() : string|null
- Returns the host regex.
- getHostTokens() : array<string|int, mixed>
- Returns the host tokens.
- getHostVariables() : array<string|int, mixed>
- Returns the host variables.
- getPathVariables() : array<string|int, mixed>
- Returns the path variables.
- getRegex() : string
- Returns the regex.
- getStaticPrefix() : string
- Returns the static prefix.
- getTokens() : array<string|int, mixed>
- Returns the tokens.
- getVariables() : array<string|int, mixed>
- Returns the variables.
Properties
$hostRegex
private
string|null
$hostRegex
$hostTokens
private
array<string|int, mixed>
$hostTokens
$hostVariables
private
array<string|int, mixed>
$hostVariables
$pathVariables
private
array<string|int, mixed>
$pathVariables
$regex
private
string
$regex
$staticPrefix
private
string
$staticPrefix
$tokens
private
array<string|int, mixed>
$tokens
$variables
private
array<string|int, mixed>
$variables
Methods
__construct()
public
__construct(string $staticPrefix, string $regex, array<string|int, mixed> $tokens, array<string|int, mixed> $pathVariables[, string|null $hostRegex = null ][, array<string|int, mixed> $hostTokens = [] ][, array<string|int, mixed> $hostVariables = [] ][, array<string|int, mixed> $variables = [] ]) : mixed
Parameters
- $staticPrefix : string
-
The static prefix of the compiled route
- $regex : string
-
The regular expression to use to match this route
- $tokens : array<string|int, mixed>
-
An array of tokens to use to generate URL for this route
- $pathVariables : array<string|int, mixed>
-
An array of path variables
- $hostRegex : string|null = null
-
Host regex
- $hostTokens : array<string|int, mixed> = []
-
Host tokens
- $hostVariables : array<string|int, mixed> = []
-
An array of host variables
- $variables : array<string|int, mixed> = []
-
An array of variables (variables defined in the path and in the host patterns)
__serialize()
public
__serialize() : array<string|int, mixed>
Return values
array<string|int, mixed>__unserialize()
public
__unserialize(array<string|int, mixed> $data) : void
Parameters
- $data : array<string|int, mixed>
getHostRegex()
Returns the host regex.
public
getHostRegex() : string|null
Return values
string|nullgetHostTokens()
Returns the host tokens.
public
getHostTokens() : array<string|int, mixed>
Return values
array<string|int, mixed>getHostVariables()
Returns the host variables.
public
getHostVariables() : array<string|int, mixed>
Return values
array<string|int, mixed>getPathVariables()
Returns the path variables.
public
getPathVariables() : array<string|int, mixed>
Return values
array<string|int, mixed>getRegex()
Returns the regex.
public
getRegex() : string
Return values
stringgetStaticPrefix()
Returns the static prefix.
public
getStaticPrefix() : string
Return values
stringgetTokens()
Returns the tokens.
public
getTokens() : array<string|int, mixed>
Return values
array<string|int, mixed>getVariables()
Returns the variables.
public
getVariables() : array<string|int, mixed>