Docs For Class Zend_Controller_Router_Route

Description

Chain route is used for managing route chaining.

copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: New BSD License

Located in /Controller/Router/Route/Chain.php (line 34)

Zend_Controller_Router_Route_Abstract
   |
   --Zend_Controller_Router_Route_Chain

Variable Summary

mixed $_routes

mixed $_separators

Method Summary

static void getInstance ( $config)

string assemble ([array $data = array()], [ $reset = false], [ $encode = false])

Zend_Controller_Router_Route_Chain chain (Zend_Controller_Router_Route_Abstract $route, [string $separator = '/'])

array|false match (Zend_Controller_Request_Http $request, [ $partial = null])

void setRequest ([Zend_Controller_Request_Abstract $request = null])

Variables

mixed $_routes = array() (line 36)

access: protected

mixed $_separators = array() (line 37)

access: protected

Inherited Variables

Inherited from Zend_Controller_Router_Route_Abstract

Zend_Controller_Router_Route_Abstract::$_isAbstract
Zend_Controller_Router_Route_Abstract::$_matchedPath

Methods

static getInstance (line 44)

Instantiates route based on passed Zend_Config structure

access: public

static void getInstance ( $config)

Zend_Config $config: Configuration object

assemble (line 128)

Assembles a URL path defined by this route

return: Route path with user submitted parameters
access: public

string assemble ([array $data = array()], [ $reset = false], [ $encode = false])

array $data: An array of variable and value pairs used as parameters
$reset
$encode

chain (line 57)

Add a route to this chain

access: public

Zend_Controller_Router_Route_Chain chain (Zend_Controller_Router_Route_Abstract $route, [string $separator = '/'])

Zend_Controller_Router_Route_Abstract $route
string $separator

Redefinition of:

Zend_Controller_Router_Route_Abstract::chain(): Create a new chain

match (line 73)

Matches a user submitted path with a previously defined route.

Assigns and returns an array of defaults on a successful match.

return: An array of assigned values or a false on a mismatch
access: public

array|false match (Zend_Controller_Request_Http $request, [ $partial = null])

Zend_Controller_Request_Http $request: Request to get the path info from
$partial

setRequest (line 158)

Set the request object for this and the child routes

access: public

void setRequest ([Zend_Controller_Request_Abstract $request = null])

Zend_Controller_Request_Abstract|null $request

Inherited Methods

Inherited From Zend_Controller_Router_Route_Abstract

Zend_Controller_Router_Route_Abstract::chain()
Zend_Controller_Router_Route_Abstract::getMatchedPath()
Zend_Controller_Router_Route_Abstract::getVersion()
Zend_Controller_Router_Route_Abstract::isAbstract()
Zend_Controller_Router_Route_Abstract::setMatchedPath()