Controller/Router/Route/Module.php
Show:
inherited
inherited
Classes
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.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Controller
- Subpackage
- Router
- Version
- $Id$
\Zend_Controller_Router_Route_Module
Package: Zend_Controller\Router
Returns
Module Route
Default route for module functionality
- Parent(s)
- \Zend_Controller_Router_Route_Abstract
- Children
- \Zend_Rest_Route
- See
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties
Methods
__construct(array $defaults = array(), \Zend_Controller_Dispatcher_Interface $dispatcher = null, \Zend_Controller_Request_Abstract $request = null) : voidConstructor
Parameters
| Name | Type | Description |
|---|---|---|
| $defaults | array | Defaults for map variables with keys as variable names |
| $dispatcher | \Zend_Controller_Dispatcher_Interface | Dispatcher object |
| $request | \Zend_Controller_Request_Abstract | Request object |
assemble(array $data = array(), bool $reset = false, $encode = true, $partial = false) : stringAssembles user submitted parameters forming a URL path defined by this route
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $data | array | An array of variable and value pairs used as parameters |
| $reset | bool | Weither to reset the current params |
| $encode | ||
| $partial |
| Type | Description |
|---|---|
| string | Route path with user submitted parameters |
getDefault(string $name) : stringReturn a single parameter of route's defaults
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $name | string | Array key of the parameter |
| Type | Description |
|---|---|
| string | Previously set default |
getDefaults() : arrayReturn an array of defaults
Returns
| Type | Description |
|---|---|
| array | Route defaults |
getInstance( $config) : voidstatic
Instantiates route based on passed Zend_Config structure
Parameters
| Name | Type | Description |
|---|---|---|
| $config |
getVersion() : voidmatch(string $path, $partial = false) : arrayMatches a user submitted path. Assigns and returns an array of variables on a successful match.
If a request object is registered, it uses its setModuleName(),
setControllerName(), and setActionName() accessors to set those values.
Always returns the values as an array.
Parameters| Name | Type | Description |
|---|---|---|
| $path | string | Path used to match against this routing map |
| $partial |
| Type | Description |
|---|---|
| array | An array of assigned values or a false on a mismatch |