Docs For Class Zend_Controller_Router_Route

Description

Module Route

Default route for module functionality

copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
see: http://manuals.rubyonrails.com/read/chapter/65
license: New BSD License

Located in /Controller/Router/Route/Module.php (line 37)

Zend_Controller_Router_Route_Abstract
   |
   --Zend_Controller_Router_Route_Module

Direct descendents

Class	Description
Zend_Rest_Route	Rest Route

Class Constant Summary

URI_DELIMITER = '/'

Variable Summary

string $_actionKey

string $_controllerKey

array $_defaults

Zend_Controller_Dispatcher_Interface $_dispatcher

mixed $_keysSet

string $_moduleKey

mixed $_moduleValid

Zend_Controller_Request_Abstract $_request

mixed $_values

Method Summary

static void getInstance ( $config)

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

string getDefault (string $name)

array getDefaults ()

void getVersion ()

array match (string $path, [ $partial = false])

Zend_Controller_Router_Route_Module __construct ([ $defaults = array()], [Zend_Controller_Dispatcher_Interface $dispatcher = null], [Zend_Controller_Request_Abstract $request = null])

void _setRequestKeys ()

Variables

string $_actionKey = 'action' (line 60)

Array keys to use for module, controller, and action. Should be taken out of request.

access: protected

string $_controllerKey = 'controller' (line 59)

Array keys to use for module, controller, and action. Should be taken out of request.

access: protected

array $_defaults (line 48)

Default values for the route (ie. module, controller, action, params)

access: protected

Zend_Controller_Dispatcher_Interface $_dispatcher (line 66)

access: protected

mixed $_keysSet = false (line 52)

access: protected

string $_moduleKey = 'module' (line 58)

Array keys to use for module, controller, and action. Should be taken out of request.

access: protected

mixed $_moduleValid = false (line 51)

access: protected

Zend_Controller_Request_Abstract $_request (line 71)

access: protected

mixed $_values = array() (line 50)

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 80)

Instantiates route based on passed Zend_Config structure

access: public

static void getInstance ( $config)

Zend_Config $config

Redefined in descendants as:

Zend_Rest_Route::getInstance() : Instantiates route based on passed Zend_Config structure

assemble (line 202)

Assembles user submitted parameters forming a URL path defined by this route

return: Route path with user submitted parameters
access: public

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

array $data: An array of variable and value pairs used as parameters
bool $reset: Weither to reset the current params
$encode
$partial

Redefined in descendants as:

Zend_Rest_Route::assemble() : Assembles user submitted parameters forming a URL path defined by this route

getDefault (line 274)

Return a single parameter of route's defaults

return: Previously set default
access: public

string getDefault (string $name)

string $name: Array key of the parameter

getDefaults (line 285)

Return an array of defaults

return: Route defaults
access: public

array getDefaults ()

getVersion (line 73)

access: public

void getVersion ()

Redefinition of:

Zend_Controller_Router_Route_Abstract::getVersion(): Get the version of the route

Redefined in descendants as:

Zend_Rest_Route::getVersion() : Tells Rewrite Router which version this Route is

match (line 148)

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.

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

array match (string $path, [ $partial = false])

string $path: Path used to match against this routing map
$partial

Redefined in descendants as:

Zend_Rest_Route::match() : Matches a user submitted request. Assigns and returns an array of variables on a successful match.

Constructor __construct (line 98)

Constructor

access: public

Zend_Controller_Router_Route_Module __construct ([ $defaults = array()], [Zend_Controller_Dispatcher_Interface $dispatcher = null], [Zend_Controller_Request_Abstract $request = null])

array $defaults: Defaults for map variables with keys as variable names
Zend_Controller_Dispatcher_Interface $dispatcher: Dispatcher object
Zend_Controller_Request_Abstract $request: Request object

Redefined in descendants as:

Zend_Rest_Route::__construct() : Constructor

_setRequestKeys (line 118)

Set request keys based on values in request object

access: protected

void _setRequestKeys ()

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()

Class Constants

URI_DELIMITER = '/' (line 42)

URI delimiter