Class Zend_Controller_Router_Route_Module

Description

Implements interfaces:

Module Route

Default route for module functionality

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


	
			
Class Constant Summary
Variable Summary
Method Summary
 static void getInstance ( $config)
 Zend_Controller_Router_Route_Module __construct ([ $defaults = array()], [Zend_Controller_Dispatcher_Interface $dispatcher = null], [Zend_Controller_Request_Abstract $request = null])
 string assemble ([array $data = array()], [ $reset = false])
 array match (string $path)
 void _setRequestKeys ()
Variables
string $_actionKey = 'action' (line 62)

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

  • access: protected
string $_controllerKey = 'controller' (line 61)

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

  • access: protected
array $_defaults (line 50)

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

  • access: protected
Zend_Controller_Dispatcher_Interface $_dispatcher (line 68)
  • access: protected
mixed $_keysSet = false (line 54)
  • access: protected
string $_moduleKey = 'module' (line 60)

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

  • access: protected
mixed $_moduleValid = false (line 53)
  • access: protected
Zend_Controller_Request_Abstract $_request (line 73)
  • access: protected
mixed $_values = array() (line 52)
  • access: protected
Methods
static getInstance (line 78)

Instantiates route based on passed Zend_Config structure

  • access: public
static void getInstance ( $config)

Implementation of:
Zend_Controller_Router_Route_Interface::getInstance()
Constructor __construct (line 91)

Constructor

  • access: public
Zend_Controller_Router_Route_Module __construct ([ $defaults = array()], [Zend_Controller_Dispatcher_Interface $dispatcher = null], [Zend_Controller_Request_Abstract $request = null])
assemble (line 186)

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()], [ $reset = false])
  • array $data: An array of variable and value pairs used as parameters
  • $reset

Implementation of:
Zend_Controller_Router_Route_Interface::assemble()
match (line 141)

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)
  • string $path: Path used to match against this routing map

Implementation of:
Zend_Controller_Router_Route_Interface::match()
_setRequestKeys (line 111)

Set request keys based on values in request object

  • access: protected
void _setRequestKeys ()
Class Constants
URI_DELIMITER = '/' (line 44)

Documentation generated on Sun, 27 May 2007 23:25:53 -0700 by phpDocumentor 1.3.2