Zend_Controller_Router_Route_Module Class Reference

Public Member Functions
	getVersion ()
	__construct (array $defaults=array(), Zend_Controller_Dispatcher_Interface $dispatcher=null, Zend_Controller_Request_Abstract $request=null)
	Constructor.
	match ($path, $partial=false)
	Matches a user submitted path.
	assemble ($data=array(), $reset=false, $encode=true, $partial=false)
	Assembles user submitted parameters forming a URL path defined by this route.
	getDefault ($name)
	Return a single parameter of route's defaults.
	getDefaults ()
	Return an array of defaults.
Public Member Functions inherited from Zend_Controller_Router_Route_Abstract
	getVersion ()
	Get the version of the route.
	setMatchedPath ($path)
	Set partially matched path.
	getMatchedPath ()
	Get partially matched path.
	isAbstract ($flag=null)
	Check or set wether this is an abstract route or not.
	chain (Zend_Controller_Router_Route_Abstract $route, $separator= '/')
	Create a new chain.
Public Member Functions inherited from Zend_Controller_Router_Route_Interface
	match ($path)
	assemble ($data=array(), $reset=false, $encode=false)

Static Public Member Functions
static	getInstance (Zend_Config $config)
	Instantiates route based on passed Zend_Config structure.

Protected Member Functions
	_setRequestKeys ()
	Set request keys based on values in request object.

Protected Attributes
	$_defaults
	$_values = array()
	$_moduleValid = false
	$_keysSet = false
	$_moduleKey = 'module'
	$_controllerKey = 'controller'
	$_actionKey = 'action'
	$_dispatcher
	$_request
Protected Attributes inherited from Zend_Controller_Router_Route_Abstract
	$_isAbstract = false
	$_matchedPath = null

Additional Inherited Members
Public Attributes inherited from Zend_Controller_Router_Route_Abstract
const	URI_DELIMITER = '/'
	URI delimiter.

Constructor & Destructor Documentation

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

Constructor.

Parameters

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

Member Function Documentation

_setRequestKeys ( )

protected

Set request keys based on values in request object.

Returns

void

assemble	(		$data = array(),
			$reset = false,
			$encode = true,
			$partial = false
	)

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

Parameters

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

Returns

string Route path with user submitted parameters

getDefault

(

$name

)

Return a single parameter of route's defaults.

Parameters

string

$name

Array key of the parameter

Returns

string Previously set default

getDefaults

(

)

Return an array of defaults.

Returns

array Route defaults

static getInstance ( Zend_Config  $config )

static

Instantiates route based on passed Zend_Config structure.

Implements Zend_Controller_Router_Route_Interface.

getVersion

(

)

match	(		$path,
			$partial = false
	)

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.

Parameters

string

$path

Path used to match against this routing map

Returns

array An array of assigned values or a false on a mismatch

Member Data Documentation

$_actionKey = 'action'

protected

$_controllerKey = 'controller'

protected

$_defaults

protected

$_dispatcher

protected

$_keysSet = false

protected

$_moduleKey = 'module'

protected

$_moduleValid = false

protected

$_request

protected

$_values = array()

protected