Controller/Router/Route/Chain.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: Chain.php 25249 2013-02-06 09:54:24Z frosch $
\Zend_Controller_Router_Route_Chain
Implements interface and provides convenience methods
- Parent(s)
- \Zend_Controller_Router_Route_Abstract
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Constants
Properties


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


assemble(array $data = array(), bool $reset = false, bool $encode = false) : string
Assembles a URL path defined by this route
Name | Type | Description |
---|---|---|
$data | array | An array of variable and value pairs used as parameters |
$reset | bool | |
$encode | bool |
Type | Description |
---|---|
string | Route path with user submitted parameters |


chain(\Zend_Controller_Router_Route_Abstract $route, string $separator = self::URI_DELIMITER) : \Zend_Controller_Router_Route_Chain
Add a route to this 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(\Zend_Config $config) : \Zend_Controller_Router_Route_Chain
Instantiates route based on passed Zend_Config structure
Name | Type | Description |
---|---|---|
$config | \Zend_Config | Configuration object |
Type | Description |
---|---|
\Zend_Controller_Router_Route_Chain |


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


getVersion() : integer
Get the version of the route
Inherited from: \Zend_Controller_Router_Route_Abstract::getVersion()Type | Description |
---|---|
integer |


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(\Zend_Controller_Request_Http $request, null $partial = null) : array | false
Matches a user submitted path with a previously defined route.
Assigns and returns an array of defaults on a successful match.
Name | Type | Description |
---|---|---|
$request | \Zend_Controller_Request_Http | Request to get the path info from |
$partial | null |
Type | Description |
---|---|
array | false | 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 |


setRequest(\Zend_Controller_Request_Abstract | null $request = null) : void
Set the request object for this and the child routes
Name | Type | Description |
---|---|---|
$request | \Zend_Controller_Request_Abstract | null |