Interface RouteStackInterface

Summary

Fully Qualified Name: Zend\Router\RouteStackInterface
Extends: RouteInterface

Description

Methods

Name Description Defined By
addRoute() Add a route to the stack. RouteStackInterface
addRoutes() Add multiple routes to the stack. RouteStackInterface
assemble() Assemble the route. RouteInterface
factory() Create a new route with given options. RouteInterface
match() Match a given request. RouteInterface
removeRoute() Remove a route from the stack. RouteStackInterface
setRoutes() Remove all routes from the stack and set new ones. RouteStackInterface

Method Details

addRoute()

Add a route to the stack.

Parameter Name Type Description
$name string
$route mixed
$priority int

Returns: \RouteStackInterface

addRoutes()

Add multiple routes to the stack.

Parameter Name Type Description
$routes array|\Traversable

Returns: \RouteStackInterface

assemble()

Assemble the route.

Parameter Name Type Description
$params array
$options array

Returns: mixed

factory()

Create a new route with given options.

Parameter Name Type Description
$options array|\Traversable

Returns: \RouteInterface

match()

Match a given request.

Parameter Name Type Description
$request \Request

Returns: \RouteMatch|null

removeRoute()

Remove a route from the stack.

Parameter Name Type Description
$name string

Returns: \RouteStackInterface

setRoutes()

Remove all routes from the stack and set new ones.

Parameter Name Type Description
$routes array|\Traversable

Returns: \RouteStackInterface

Top