Class RouteMatch

Summary

Fully Qualified Name: Laminas\Router\Http\RouteMatch
Extends: RouteMatch

Description

Part route match.

Methods

Name Description Defined By
__construct() Create a part RouteMatch with given parameters and length. RouteMatch
getLength() Get the matched path length. RouteMatch
getMatchedRouteName() Get name of matched route. RouteMatch
getParam() Get a specific parameter. RouteMatch
getParams() Get all parameters. RouteMatch
merge() Merge parameters from another match. RouteMatch
setMatchedRouteName() setMatchedRouteName(): defined by BaseRouteMatch. RouteMatch
setParam() Set a parameter. RouteMatch

Method Details

__construct()

Create a part RouteMatch with given parameters and length.

Parameter Name Type Description
$params array
$length int

Returns:

getLength()

Get the matched path length.

Returns: int

getMatchedRouteName()

Get name of matched route.

Returns: string

getParam()

Get a specific parameter.

Parameter Name Type Description
$name string
$default mixed

Returns: mixed

getParams()

Get all parameters.

Returns: array

merge()

Merge parameters from another match.

Parameter Name Type Description
$match \RouteMatch

Returns: \RouteMatch

setMatchedRouteName()

setMatchedRouteName(): defined by BaseRouteMatch.

Parameter Name Type Description
$name string

Returns: \RouteMatch

setParam()

Set a parameter.

Parameter Name Type Description
$name string
$value mixed

Returns: \RouteMatch

Top