MatchInterface
in
Pop router match interface
Tags
Table of Contents
- addControllerParams() : MatchInterface
- Add controller params to be passed into a new controller instance
- addRoute() : MatchInterface
- Add a route
- addRoutes() : MatchInterface
- Add multiple controller routes
- appendControllerParams() : MatchInterface
- Append controller params to be passed into a new controller instance
- getAction() : mixed
- Get the action
- getController() : mixed
- Get the controller
- getControllerParams() : mixed
- Get the params assigned to the controller
- getDefaultRoute() : array<string|int, mixed>
- Get the default route
- getDynamicRoute() : array<string|int, mixed>
- Get the dynamic route
- getDynamicRoutePrefix() : array<string|int, mixed>
- Get the dynamic route prefix
- getFlattenedRoutes() : array<string|int, mixed>
- Get flattened routes
- getOriginalRoute() : string
- Get original route string
- getPreparedRoutes() : array<string|int, mixed>
- Get prepared routes
- getRoute() : string
- Get route string
- getRouteParams() : array<string|int, mixed>
- Get the params discovered from the route
- getRoutes() : array<string|int, mixed>
- Get routes
- getRouteString() : string
- Get the route string
- getSegment() : string
- Get a route string segment
- getSegments() : array<string|int, mixed>
- Get the route string segments
- hasAction() : bool
- Determine if there is an action
- hasController() : bool
- Determine if there is a controller
- hasControllerParams() : bool
- Determine if the controller has params
- hasDefaultRoute() : bool
- Determine if there is a default route
- hasDynamicRoute() : bool
- Determine if there is a dynamic route
- hasRoute() : bool
- Determine if there is a route match
- hasRouteParams() : bool
- Determine if the route has params
- isDynamicRoute() : bool
- Determine if it is a dynamic route
- match() : bool
- Prepare the routes
- noRouteFound() : void
- Method to process if a route was not found
- prepare() : MatchInterface
- Match the route
- removeControllerParams() : MatchInterface
- Remove controller params
Methods
addControllerParams()
Add controller params to be passed into a new controller instance
public
addControllerParams(string $controller, mixed $params) : MatchInterface
Parameters
- $controller : string
- $params : mixed
Return values
MatchInterface —addRoute()
Add a route
public
addRoute(string $route, mixed $controller) : MatchInterface
Parameters
- $route : string
- $controller : mixed
Return values
MatchInterface —addRoutes()
Add multiple controller routes
public
addRoutes(array<string|int, mixed> $routes) : MatchInterface
Parameters
- $routes : array<string|int, mixed>
Return values
MatchInterface —appendControllerParams()
Append controller params to be passed into a new controller instance
public
appendControllerParams(string $controller, mixed $params) : MatchInterface
Parameters
- $controller : string
- $params : mixed
Return values
MatchInterface —getAction()
Get the action
public
getAction() : mixed
Return values
mixed —getController()
Get the controller
public
getController() : mixed
Return values
mixed —getControllerParams()
Get the params assigned to the controller
public
getControllerParams(string $controller) : mixed
Parameters
- $controller : string
Return values
mixed —getDefaultRoute()
Get the default route
public
getDefaultRoute() : array<string|int, mixed>
Return values
array<string|int, mixed> —getDynamicRoute()
Get the dynamic route
public
getDynamicRoute() : array<string|int, mixed>
Return values
array<string|int, mixed> —getDynamicRoutePrefix()
Get the dynamic route prefix
public
getDynamicRoutePrefix() : array<string|int, mixed>
Return values
array<string|int, mixed> —getFlattenedRoutes()
Get flattened routes
public
getFlattenedRoutes() : array<string|int, mixed>
Return values
array<string|int, mixed> —getOriginalRoute()
Get original route string
public
getOriginalRoute() : string
Return values
string —getPreparedRoutes()
Get prepared routes
public
getPreparedRoutes() : array<string|int, mixed>
Return values
array<string|int, mixed> —getRoute()
Get route string
public
getRoute() : string
Return values
string —getRouteParams()
Get the params discovered from the route
public
getRouteParams() : array<string|int, mixed>
Return values
array<string|int, mixed> —getRoutes()
Get routes
public
getRoutes() : array<string|int, mixed>
Return values
array<string|int, mixed> —getRouteString()
Get the route string
public
getRouteString() : string
Return values
string —getSegment()
Get a route string segment
public
getSegment(int $i) : string
Parameters
- $i : int
Return values
string —getSegments()
Get the route string segments
public
getSegments() : array<string|int, mixed>
Return values
array<string|int, mixed> —hasAction()
Determine if there is an action
public
hasAction() : bool
Return values
bool —hasController()
Determine if there is a controller
public
hasController() : bool
Return values
bool —hasControllerParams()
Determine if the controller has params
public
hasControllerParams(string $controller) : bool
Parameters
- $controller : string
Return values
bool —hasDefaultRoute()
Determine if there is a default route
public
hasDefaultRoute() : bool
Return values
bool —hasDynamicRoute()
Determine if there is a dynamic route
public
hasDynamicRoute() : bool
Return values
bool —hasRoute()
Determine if there is a route match
public
hasRoute() : bool
Return values
bool —hasRouteParams()
Determine if the route has params
public
hasRouteParams() : bool
Return values
bool —isDynamicRoute()
Determine if it is a dynamic route
public
isDynamicRoute() : bool
Return values
bool —match()
Prepare the routes
public
match([string $forceRoute = null ]) : bool
Parameters
- $forceRoute : string = null
Return values
bool —noRouteFound()
Method to process if a route was not found
public
noRouteFound([bool $exit = true ]) : void
Parameters
- $exit : bool = true
Return values
void —prepare()
Match the route
public
prepare() : MatchInterface
Return values
MatchInterface —removeControllerParams()
Remove controller params
public
removeControllerParams(string $controller) : MatchInterface
Parameters
- $controller : string