Class Chain

Summary

Fully Qualified Name: Zend\Router\Http\Chain
Extends: TreeRouteStack
Implements: RouteInterface

Description

Chain route.

Methods

Name Description Defined By
__construct() Create a new part route. Chain
addPrototype() Add a prototype. TreeRouteStack
addPrototypes() Add multiple prototypes at once. TreeRouteStack
addRoute() addRoute(): defined by RouteStackInterface interface. TreeRouteStack
addRoutes() addRoutes(): defined by RouteStackInterface interface. SimpleRouteStack
assemble() assemble(): Defined by RouteInterface interface. Chain
factory() factory(): defined by RouteInterface interface. Chain
getAssembledParams() getAssembledParams(): defined by RouteInterface interface. Chain
getBaseUrl() Get the base URL. TreeRouteStack
getPrototype() Get a prototype. TreeRouteStack
getRequestUri() Get the request URI. TreeRouteStack
getRoute() Get a route by name SimpleRouteStack
getRoutePluginManager() Get the route plugin manager. SimpleRouteStack
getRoutes() Get the added routes SimpleRouteStack
hasRoute() Check if a route with a specific name exists SimpleRouteStack
match() match(): defined by RouteInterface interface. Chain
removeRoute() removeRoute(): defined by RouteStackInterface interface. SimpleRouteStack
setBaseUrl() Set the base URL. TreeRouteStack
setDefaultParam() Set a default parameter. SimpleRouteStack
setDefaultParams() Set a default parameters. SimpleRouteStack
setRequestUri() Set the request URI. TreeRouteStack
setRoutePluginManager() Set the route plugin manager. SimpleRouteStack
setRoutes() setRoutes(): defined by RouteStackInterface interface. SimpleRouteStack

Method Details

__construct()

Create a new part route.

Parameter Name Type Description
$routes array
$routePlugins \RoutePluginManager
$prototypes \ArrayObject|null

Returns:

addPrototype()

Add a prototype.

Parameter Name Type Description
$name string
$route mixed

Returns: \TreeRouteStack

addPrototypes()

Add multiple prototypes at once.

Parameter Name Type Description
$routes \Traversable

Returns: \TreeRouteStack

addRoute()

addRoute(): defined by RouteStackInterface interface.

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

Returns: \TreeRouteStack

addRoutes()

addRoutes(): defined by RouteStackInterface interface.

Parameter Name Type Description
$routes array|\Traversable

Returns: \SimpleRouteStack

assemble()

assemble(): Defined by RouteInterface interface.

Parameter Name Type Description
$params array
$options array

Returns: mixed

factory()

factory(): defined by RouteInterface interface.

Parameter Name Type Description
$options mixed

Returns: \Part

getAssembledParams()

getAssembledParams(): defined by RouteInterface interface.

Returns: array

getBaseUrl()

Get the base URL.

Returns: string

getPrototype()

Get a prototype.

Parameter Name Type Description
$name string

Returns: \RouteInterface|null

getRequestUri()

Get the request URI.

Returns: \HttpUri

getRoute()

Get a route by name

Parameter Name Type Description
$name string

Returns: \RouteInterface the route

getRoutePluginManager()

Get the route plugin manager.

Returns: \RoutePluginManager

getRoutes()

Get the added routes

Returns: \Traversable list of all routes

hasRoute()

Check if a route with a specific name exists

Parameter Name Type Description
$name string

Returns: bool true if route exists

match()

match(): defined by RouteInterface interface.

Parameter Name Type Description
$request \Request
$pathOffset int|null
$options array

Returns: \RouteMatch|null

removeRoute()

removeRoute(): defined by RouteStackInterface interface.

Parameter Name Type Description
$name string

Returns: \SimpleRouteStack

setBaseUrl()

Set the base URL.

Parameter Name Type Description
$baseUrl string

Returns: self

setDefaultParam()

Set a default parameter.

Parameter Name Type Description
$name string
$value mixed

Returns: \SimpleRouteStack

setDefaultParams()

Set a default parameters.

Parameter Name Type Description
$params array

Returns: \SimpleRouteStack

setRequestUri()

Set the request URI.

Parameter Name Type Description
$uri \HttpUri

Returns: \TreeRouteStack

setRoutePluginManager()

Set the route plugin manager.

Parameter Name Type Description
$routePlugins \RoutePluginManager

Returns: \SimpleRouteStack

setRoutes()

setRoutes(): defined by RouteStackInterface interface.

Parameter Name Type Description
$routes array|\Traversable

Returns: \SimpleRouteStack

Top