Controller/Router/Route/Module.php
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-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Controller
- Subpackage
- Router
- Version
- $Id: Module.php 24593 2012-01-05 20:35:02Z matthew $
\Zend_Controller_Router_Route_Module
Default route for module functionality
- Parent(s)
- \Zend_Controller_Router_Route_Abstract
- Children
- \Zend_Rest_Route
- See
- \global\http://manuals.rubyonrails.com/read/chapter/65
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Constants
Properties


array $_defaults
module, controller, action, params)
- Type
- array


boolean $_isAbstract = false
false
Details- Type
- boolean
- Inherited_from
- \Zend_Controller_Router_Route_Abstract::$$_isAbstract


string $_matchedPath = null
null
Details- Type
- string
- Inherited_from
- \Zend_Controller_Router_Route_Abstract::$$_matchedPath
Methods


__construct(array $defaults = array(), \Zend_Controller_Dispatcher_Interface $dispatcher = null, \Zend_Controller_Request_Abstract $request = null) : void
Constructor
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) : string
Assembles user submitted parameters forming a URL path defined by this route
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 |


chain(\Zend_Controller_Router_Route_Abstract $route, string $separator = '/') : \Zend_Controller_Router_Route_Chain
Name | Type | Description |
---|---|---|
$route | \Zend_Controller_Router_Route_Abstract | |
$separator | string |
Type | Description |
---|---|
\Zend_Controller_Router_Route_Chain |


getDefault(string $name) : string
Return a single parameter of route's defaults
Name | Type | Description |
---|---|---|
$name | string | Array key of the parameter |
Type | Description |
---|---|
string | Previously set default |


getInstance( $config) : void
Instantiates route based on passed Zend_Config structure
Name | Type | Description |
---|---|---|
$config |


getMatchedPath() : string
Get partially matched path
Inherited from: \Zend_Controller_Router_Route_Abstract::getMatchedPath()Type | Description |
---|---|
string |


isAbstract(boolean $flag = null) : boolean
Check or set wether this is an abstract route or not
Inherited from: \Zend_Controller_Router_Route_Abstract::isAbstract()Name | Type | Description |
---|---|---|
$flag | boolean |
Type | Description |
---|---|
boolean |


match(string $path, $partial = false) : array
Matches 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.
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 |


setMatchedPath(string $path) : void
Set partially matched path
Inherited from: \Zend_Controller_Router_Route_Abstract::setMatchedPath()Name | Type | Description |
---|---|---|
$path | string |