RouteInterface part.

package Zend_Mvc_Router
subpackage Http
see \Zend\Mvc\Router\Http\http://guides.rubyonrails.org/routing.html

 Methods

Create a new part route.

__construct(mixed $route, bool $mayTerminate, \Zend\Mvc\Router\RoutePluginManager $routePlugins, array $childRoutes) 

Parameters

$route

mixed

$mayTerminate

bool

$childRoutes

arraynull

Exceptions

\Zend\Mvc\Router\Exception\InvalidArgumentException

addRoute(): defined by RouteStackInterface interface.

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

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

Parameters

$name

string

$route

mixed

$priority

integer

Returns

addRoutes(): defined by RouteStackInterface interface.

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

see \Zend\Mvc\Router\RouteStack::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

assemble(): Defined by RouteInterface interface.

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

see \Zend\Mvc\Router\Http\Route::assemble()

Parameters

$params

array

$options

array

Exceptions

\Zend\Mvc\Router\Exception\RuntimeException

Returns

mixed

factory(): defined by RouteInterface interface.

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

see \Zend\Mvc\Router\Http\Route::factory()

Parameters

$options

mixed

Exceptions

\Zend\Mvc\Router\Exception\InvalidArgumentException

Returns

getAssembledParams(): defined by RouteInterface interface.

getAssembledParams() : array

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

Returns

array

Get the base URL.

getBaseUrl() : string
Inherited

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

Returns

string

Get the request URI.

getRequestUri() : \Zend\Uri\Http
Inherited

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

Returns

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

match(): defined by RouteInterface interface.

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

see \Zend\Mvc\Router\Http\Route::match()

Parameters

$pathOffset

intnull

Returns

removeRoute(): defined by RouteStackInterface interface.

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

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

Parameters

$name

string

Returns

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

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

Set the request URI.

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

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

Parameters

Returns

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

Returns

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

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(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

array\Traversable

Exceptions

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

Returns

 Properties

 

Base URL.

$baseUrl : string
Inherited

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

Child routes.

$childRoutes : mixed

 

Default parameters.

$defaultParams : array
Inherited

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

Whether the route may terminate.

$mayTerminate : bool

 

Request URI.

$requestUri : \Zend\Uri\Http
Inherited

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

RouteInterface to match.

$route : \Zend\Mvc\Router\Http\RouteInterface

 

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