Zend Framework » \Zend\Mvc\Router\Http\Chain

Chain route.

Methods

Create a new part route.

__construct(array $routes, \Zend\Mvc\Router\RoutePluginManager $routePlugins, \ArrayObject $prototypes)

Parameters

$routes

array

$routePlugins

\Zend\Mvc\Router\RoutePluginManager

$prototypes

\ArrayObjectnull

Add a prototype.

addPrototype(string $name, mixed $route) : \Zend\Mvc\Router\Http\TreeRouteStack

Inherited

inherited_from	\Zend\Mvc\Router\Http\TreeRouteStack::addPrototype()

Parameters

$name

string

$route

mixed

Returns

\Zend\Mvc\Router\Http\TreeRouteStack

Add multiple prototypes at once.

addPrototypes(\Traversable $routes) : \Zend\Mvc\Router\Http\TreeRouteStack

Inherited

inherited_from	\Zend\Mvc\Router\Http\TreeRouteStack::addPrototypes()

Parameters

$routes

\Traversable

Exceptions

`\Zend\Mvc\Router\Exception\InvalidArgumentException`

Returns

\Zend\Mvc\Router\Http\TreeRouteStack

addRoute(): defined by RouteStackInterface interface.

addRoute(string $name, mixed $route, int $priority) : \Zend\Mvc\Router\Http\TreeRouteStack

Inherited

see	\Zend\Mvc\Router\Http\RouteStackInterface::addRoute()
inherited_from	\Zend\Mvc\Router\Http\TreeRouteStack::addRoute()

Parameters

$name

string

$route

mixed

$priority

int

Returns

\Zend\Mvc\Router\Http\TreeRouteStack

addRoutes(): defined by RouteStackInterface interface.

addRoutes(array | \Traversable $routes) : \Zend\Mvc\Router\SimpleRouteStack

Inherited

see	\Zend\Mvc\Router\RouteStackInterface::addRoutes()
inherited_from	\Zend\Mvc\Router\SimpleRouteStack::addRoutes()
inherited_from	\Zend\Mvc\Router\Http\TreeRouteStack::addRoutes()

Parameters

$routes

array\Traversable

Exceptions

`\Zend\Mvc\Router\Exception\InvalidArgumentException`

Returns

\Zend\Mvc\Router\SimpleRouteStack

assemble(): Defined by RouteInterface interface.

assemble(array $params, array $options) : mixed

see	\Zend\Mvc\Router\RouteInterface::assemble()

Parameters

$params

array

$options

array

Exceptions

`\Zend\Mvc\Router\Exception\InvalidArgumentException`
`\Zend\Mvc\Router\Exception\RuntimeException`

Returns

mixed

factory(): defined by RouteInterface interface.

factory(mixed $options) : \Zend\Mvc\Router\Http\Part

see	\Zend\Mvc\Router\RouteInterface::factory()

Parameters

$options

mixed

Exceptions

`\Zend\Mvc\Router\Exception\InvalidArgumentException`

Returns

\Zend\Mvc\Router\Http\Part

getAssembledParams(): defined by RouteInterface interface.

getAssembledParams() : array

see	\Zend\Mvc\Router\Http\RouteInterface::getAssembledParams

Returns

array

Get the base URL.

getBaseUrl() : string

Inherited

inherited_from	\Zend\Mvc\Router\Http\TreeRouteStack::getBaseUrl()

Returns

string

Get a prototype.

getPrototype(string $name) : \Zend\Mvc\Router\Http\RouteInterface | null

Inherited

inherited_from	\Zend\Mvc\Router\Http\TreeRouteStack::getPrototype()

Parameters

$name

string

Returns

\Zend\Mvc\Router\Http\RouteInterfacenull

Get the request URI.

getRequestUri() : \Zend\Uri\Http

Inherited

inherited_from	\Zend\Mvc\Router\Http\TreeRouteStack::getRequestUri()

Returns

\Zend\Uri\Http

Get a route by name

getRoute(string $name) : \Zend\Mvc\Router\RouteInterface

Inherited

inherited_from	\Zend\Mvc\Router\SimpleRouteStack::getRoute()
inherited_from	\Zend\Mvc\Router\Http\TreeRouteStack::getRoute()

Parameters

$name

string

Returns

\Zend\Mvc\Router\RouteInterfacethe route

Get the route plugin manager.

getRoutePluginManager() : \Zend\Mvc\Router\RoutePluginManager

Inherited

inherited_from	\Zend\Mvc\Router\SimpleRouteStack::getRoutePluginManager()
inherited_from	\Zend\Mvc\Router\Http\TreeRouteStack::getRoutePluginManager()

Returns

\Zend\Mvc\Router\RoutePluginManager

Get the added routes

getRoutes() : \Traversable

Inherited

inherited_from	\Zend\Mvc\Router\SimpleRouteStack::getRoutes()
inherited_from	\Zend\Mvc\Router\Http\TreeRouteStack::getRoutes()

Returns

\Traversablelist of all routes

Check if a route with a specific name exists

hasRoute(string $name) : bool

Inherited

inherited_from	\Zend\Mvc\Router\SimpleRouteStack::hasRoute()
inherited_from	\Zend\Mvc\Router\Http\TreeRouteStack::hasRoute()

Parameters

$name

string

Returns

booltrue if route exists

match(): defined by RouteInterface interface.

match(\Zend\Stdlib\RequestInterface $request, int | null $pathOffset, array $options) : \Zend\Mvc\Router\Http\RouteMatch | null

see	\Zend\Mvc\Router\RouteInterface::match()

Parameters

$request

\Zend\Stdlib\RequestInterface

$pathOffset

intnull

$options

array

Returns

\Zend\Mvc\Router\Http\RouteMatchnull

removeRoute(): defined by RouteStackInterface interface.

removeRoute(string $name) : \Zend\Mvc\Router\SimpleRouteStack

Inherited

see	\Zend\Mvc\Router\RouteStackInterface::removeRoute()
inherited_from	\Zend\Mvc\Router\SimpleRouteStack::removeRoute()
inherited_from	\Zend\Mvc\Router\Http\TreeRouteStack::removeRoute()

Parameters

$name

string

Returns

\Zend\Mvc\Router\SimpleRouteStack

Set the base URL.

setBaseUrl(string $baseUrl) : \Zend\Mvc\Router\Http\self

Inherited

inherited_from	\Zend\Mvc\Router\Http\TreeRouteStack::setBaseUrl()

Parameters

$baseUrl

string

Returns

\Zend\Mvc\Router\Http\self

Set a default parameter.

setDefaultParam(string $name, mixed $value) : \Zend\Mvc\Router\SimpleRouteStack

Inherited

inherited_from	\Zend\Mvc\Router\SimpleRouteStack::setDefaultParam()
inherited_from	\Zend\Mvc\Router\Http\TreeRouteStack::setDefaultParam()

Parameters

$name

string

$value

mixed

Returns

\Zend\Mvc\Router\SimpleRouteStack

Set a default parameters.

setDefaultParams(array $params) : \Zend\Mvc\Router\SimpleRouteStack

Inherited

inherited_from	\Zend\Mvc\Router\SimpleRouteStack::setDefaultParams()
inherited_from	\Zend\Mvc\Router\Http\TreeRouteStack::setDefaultParams()

Parameters

$params

array

Returns

\Zend\Mvc\Router\SimpleRouteStack

Set the request URI.

setRequestUri(\Zend\Uri\Http $uri) : \Zend\Mvc\Router\Http\TreeRouteStack

Inherited

inherited_from	\Zend\Mvc\Router\Http\TreeRouteStack::setRequestUri()

Parameters

$uri

\Zend\Uri\Http

Returns

\Zend\Mvc\Router\Http\TreeRouteStack

Set the route plugin manager.

setRoutePluginManager(\Zend\Mvc\Router\RoutePluginManager $routePlugins) : \Zend\Mvc\Router\SimpleRouteStack

Inherited

inherited_from	\Zend\Mvc\Router\SimpleRouteStack::setRoutePluginManager()
inherited_from	\Zend\Mvc\Router\Http\TreeRouteStack::setRoutePluginManager()

Parameters

$routePlugins

\Zend\Mvc\Router\RoutePluginManager

Returns

\Zend\Mvc\Router\SimpleRouteStack

setRoutes(): defined by RouteStackInterface interface.

setRoutes(array | \Traversable $routes) : \Zend\Mvc\Router\SimpleRouteStack

Inherited

inherited_from	\Zend\Mvc\Router\SimpleRouteStack::setRoutes()
inherited_from	\Zend\Mvc\Router\Http\TreeRouteStack::setRoutes()

Parameters

$routes

array\Traversable

Returns

\Zend\Mvc\Router\SimpleRouteStack

init(): defined by SimpleRouteStack.

init() : void

Inherited

see	\Zend\Mvc\Router\SimpleRouteStack::init()
inherited_from	\Zend\Mvc\Router\Http\TreeRouteStack::init()

routeFromArray(): defined by SimpleRouteStack.

routeFromArray(string | array | \Traversable $specs) : \Zend\Mvc\Router\Http\RouteInterface

Inherited

see	\Zend\Mvc\Router\SimpleRouteStack::routeFromArray()
inherited_from	\Zend\Mvc\Router\Http\TreeRouteStack::routeFromArray()

Parameters

$specs

stringarray\Traversable

Exceptions

`\Zend\Mvc\Router\Exception\InvalidArgumentException`	When route definition is not an array nor traversable
`\Zend\Mvc\Router\Exception\InvalidArgumentException`	When chain routes are not an array nor traversable
`\Zend\Mvc\Router\Exception\RuntimeException`	When a generated routes does not implement the HTTP route interface

Returns

\Zend\Mvc\Router\Http\RouteInterface

Properties

List of assembled parameters.

$assembledParams : array

Base URL.

$baseUrl : string

Inherited

inherited_from	\Zend\Mvc\Router\Http\TreeRouteStack::$$baseUrl

Chain routes.

$chainRoutes : array

Default parameters.

$defaultParams : array

Inherited

inherited_from	\Zend\Mvc\Router\SimpleRouteStack::$$defaultParams
inherited_from	\Zend\Mvc\Router\Http\TreeRouteStack::$$defaultParams

Prototype routes.

$prototypes : \ArrayObject

Inherited

We use an ArrayObject in this case so we can easily pass it down the tree by reference.

inherited_from	\Zend\Mvc\Router\Http\TreeRouteStack::$$prototypes

Request URI.

$requestUri : \Zend\Uri\Http

Inherited

inherited_from	\Zend\Mvc\Router\Http\TreeRouteStack::$$requestUri

Route plugin manager

$routePluginManager : \Zend\Mvc\Router\RoutePluginManager

Inherited

inherited_from	\Zend\Mvc\Router\SimpleRouteStack::$$routePluginManager
inherited_from	\Zend\Mvc\Router\Http\TreeRouteStack::$$routePluginManager

Stack containing all routes.

$routes : \Zend\Mvc\Router\PriorityList

Inherited

inherited_from	\Zend\Mvc\Router\SimpleRouteStack::$$routes
inherited_from	\Zend\Mvc\Router\Http\TreeRouteStack::$$routes