Simple route stack implementation.

 Methods

Create a new simple route stack.

__construct(\Zend\Mvc\Router\RoutePluginManager $routePluginManager) 

Parameters

addRoute(): defined by RouteStackInterface interface.

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

see \Zend\Mvc\Router\RouteStackInterface::addRoute()

Parameters

$name

string

$route

mixed

$priority

int

Returns

addRoutes(): defined by RouteStackInterface interface.

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

see \Zend\Mvc\Router\RouteStackInterface::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\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(array | \Traversable $options) : \Zend\Mvc\Router\SimpleRouteStack

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

Parameters

$options

array\Traversable

Exceptions

\Zend\Mvc\Router\Exception\InvalidArgumentException

Returns

Get a route by name

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

Parameters

$name

string

Returns

Get the route plugin manager.

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

Get the added routes

getRoutes() : \Traversable

Returns

\Traversablelist of all routes

Check if a route with a specific name exists

hasRoute(string $name) : bool

Parameters

$name

string

Returns

booltrue if route exists

match(): defined by RouteInterface interface.

match(\Zend\Stdlib\RequestInterface $request) : \Zend\Mvc\Router\RouteMatch | null

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

Parameters

Returns

removeRoute(): defined by RouteStackInterface interface.

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

see \Zend\Mvc\Router\RouteStackInterface::removeRoute()

Parameters

$name

string

Returns

Set a default parameter.

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

Parameters

$name

string

$value

mixed

Returns

Set a default parameters.

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

Parameters

$params

array

Returns

Set the route plugin manager.

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

setRoutes(): defined by RouteStackInterface interface.

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

Parameters

$routes

array\Traversable

Returns

Init method for extending classes.

init() : void

Create a route from array specifications.

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

Parameters

$specs

array\Traversable

Exceptions

\Zend\Mvc\Router\Exception\InvalidArgumentException

Returns

 Properties

 

Default parameters.

$defaultParams : array

 

Route plugin manager

$routePluginManager : \Zend\Mvc\Router\RoutePluginManager

 

Stack containing all routes.

$routes : \Zend\Mvc\Router\PriorityList