Zend Framework
LICENSE
This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.
Ruby routing based Router.

string
$_chainNameSeparator= ''-''
Separator to use with chain names
'-'
Details
array
$_globalParams= 'array()'
Global parameters given to all routes
array()
Details
boolean
$_useCurrentParamsAsGlobal= 'false'
Determines if request parameters should be used as global parameters inside this router.
false
Details
_addChainRoutesFromConfig(
string $name, \Zend_Controller_Router_Route_Interface $route, \Zend_Config $childRoutesInfo
)
:
void
Add chain routes from a config route
Name | Type | Description |
---|---|---|
$name | string | |
$route | \Zend_Controller_Router_Route_Interface | |
$childRoutesInfo | \Zend_Config |

_getRouteFromConfig(
\Zend_Config $info
)
:
\Zend_Controller_Router_Route_Interface
Get a route frm a config instance
Name | Type | Description |
---|---|---|
$info | \Zend_Config |
Type | Description |
---|---|
\Zend_Controller_Router_Route_Interface |

addConfig(
\Zend_Config $config, string $section
=
null
)
:
\Zend_Controller_Router_Rewrite
Create routes out of Zend_Config configuration
Example INI: routes.archive.route = "archive/:year/*" routes.archive.defaults.controller = archive routes.archive.defaults.action = show routes.archive.defaults.year = 2000 routes.archive.reqs.year = "\d+"
routes.news.type = "Zend_Controller_Router_Route_Static" routes.news.route = "news" routes.news.defaults.controller = "news" routes.news.defaults.action = "list"
And finally after you have created a Zend_Config with above ini: $router = new Zend_Controller_Router_Rewrite(); $router->addConfig($config, 'routes');
Name | Type | Description |
---|---|---|
$config | \Zend_Config | Configuration object |
$section | string | Name of the config section containing route's definitions |
Type | Description |
---|---|
\Zend_Controller_Router_Rewrite |
Exception | Description |
---|---|
\Zend_Controller_Router_Exception |

addDefaultRoutes(
)
:
\Zend_Controller_Router_Rewrite
Add default routes which are used to mimic basic router behaviour
Type | Description |
---|---|
\Zend_Controller_Router_Rewrite |

addRoute(
string $name, \Zend_Controller_Router_Route_Interface $route
)
:
\Zend_Controller_Router_Rewrite
Add route to the route chain
If route contains method setRequest(), it is initialized with a request object
Name | Type | Description |
---|---|---|
$name | string | Name of the route |
$route | \Zend_Controller_Router_Route_Interface | Instance of the route |
Type | Description |
---|---|
\Zend_Controller_Router_Rewrite |

addRoutes(
array $routes
)
:
\Zend_Controller_Router_Rewrite
Add routes to the route chain
Name | Type | Description |
---|---|---|
$routes | array | Array of routes with names as keys and routes as values |
Type | Description |
---|---|
\Zend_Controller_Router_Rewrite |

assemble(
array $userParams, mixed $name
=
null, bool $reset
=
false, bool $encode
=
true
)
:
string
Generates a URL path that can be used in URL creation, redirection, etc.
Name | Type | Description |
---|---|---|
$userParams | array | Options passed by a user used to override parameters |
$name | mixed | The name of a Route to use |
$reset | bool | Whether to reset to the route defaults ignoring URL params |
$encode | bool | Tells to encode URL parts on output |
Type | Description |
---|---|
string | Resulting absolute URL path |
Exception | Description |
---|---|
\Zend_Controller_Router_Exception |

getChainNameSeparator(
)
:
string
Get the separator to use for chain names
Type | Description |
---|---|
string |

getCurrentRoute(
)
:
\Zend_Controller_Router_Route_Interface
Retrieve a currently matched route
Type | Description |
---|---|
\Zend_Controller_Router_Route_Interface | Route object |
Exception | Description |
---|---|
\Zend_Controller_Router_Exception |

getCurrentRouteName(
)
:
\Zend_Controller_Router_Route_Interface
Retrieve a name of currently matched route
Type | Description |
---|---|
\Zend_Controller_Router_Route_Interface | Route object |
Exception | Description |
---|---|
\Zend_Controller_Router_Exception |

getRoute(
string $name
)
:
\Zend_Controller_Router_Route_Interface
Retrieve a named route
Name | Type | Description |
---|---|---|
$name | string | Name of the route |
Type | Description |
---|---|
\Zend_Controller_Router_Route_Interface | Route object |
Exception | Description |
---|---|
\Zend_Controller_Router_Exception |

getRoutes(
)
:
array
Retrieve an array of routes added to the route chain
Type | Description |
---|---|
array | All of the defined routes |

hasRoute(
string $name
)
:
boolean
Check if named route exists
Name | Type | Description |
---|---|---|
$name | string | Name of the route |
Type | Description |
---|---|
boolean |

removeDefaultRoutes(
)
:
\Zend_Controller_Router_Rewrite
Remove all standard default routes
Type | Description |
---|---|
\Zend_Controller_Router_Rewrite |

removeRoute(
string $name
)
:
\Zend_Controller_Router_Rewrite
Remove a route from the route chain
Name | Type | Description |
---|---|---|
$name | string | Name of the route |
Type | Description |
---|---|
\Zend_Controller_Router_Rewrite |
Exception | Description |
---|---|
\Zend_Controller_Router_Exception |

route(
$request
)
:
\Zend_Controller_Request_Abstract
Find a matching route to the current PATH_INFO and inject returning values to the Request object.
Name | Type | Description |
---|---|---|
$request |
Type | Description |
---|---|
\Zend_Controller_Request_Abstract | Request object |
Exception | Description |
---|---|
\Zend_Controller_Router_Exception |

setChainNameSeparator(
string $separator
)
:
\Zend_Controller_Router_Rewrite
Set the separator to use with chain names
Name | Type | Description |
---|---|---|
$separator | string | The separator to use |
Type | Description |
---|---|
\Zend_Controller_Router_Rewrite |

setGlobalParam(
string $name, mixed $value
)
:
\Zend_Controller_Router_Rewrite
Set a global parameter
Name | Type | Description |
---|---|---|
$name | string | |
$value | mixed |
Type | Description |
---|---|
\Zend_Controller_Router_Rewrite |

useRequestParametersAsGlobal(
boolean|null $use
=
null
)
:
boolean|\Zend_Controller_Router_Rewrite
Determines/returns whether to use the request parameters as global parameters.
Name | Type | Description |
---|---|---|
$use | boolean|null | Null/unset when you want to retrieve the current state. True when request parameters should be global, false otherwise |
Type | Description |
---|---|
boolean|\Zend_Controller_Router_Rewrite | Returns a boolean if first param isn't set, returns an instance of Zend_Controller_Router_Rewrite otherwise. |