Zend_Controller_Request_Abstract Class Reference

Public Member Functions
	getModuleName ()
	Retrieve the module name.
	setModuleName ($value)
	Set the module name to use.
	getControllerName ()
	Retrieve the controller name.
	setControllerName ($value)
	Set the controller name to use.
	getActionName ()
	Retrieve the action name.
	setActionName ($value)
	Set the action name.
	getModuleKey ()
	Retrieve the module key.
	setModuleKey ($key)
	Set the module key.
	getControllerKey ()
	Retrieve the controller key.
	setControllerKey ($key)
	Set the controller key.
	getActionKey ()
	Retrieve the action key.
	setActionKey ($key)
	Set the action key.
	getParam ($key, $default=null)
	Get an action parameter.
	getUserParams ()
	Retrieve only user params (i.e, any param specific to the object and not the environment)
	getUserParam ($key, $default=null)
	Retrieve a single user param (i.e, a param specific to the object and not the environment)
	setParam ($key, $value)
	Set an action parameter.
	getParams ()
	Get all action parameters.
	setParams (array $array)
	Set action parameters en masse; does not overwrite.
	clearParams ()
	Unset all user parameters.
	setDispatched ($flag=true)
	Set flag indicating whether or not request has been dispatched.
	isDispatched ()
	Determine if the request has been dispatched.

Protected Attributes
	$_dispatched = false
	$_module
	$_moduleKey = 'module'
	$_controller
	$_controllerKey = 'controller'
	$_action
	$_actionKey = 'action'
	$_params = array()

Member Function Documentation

clearParams

(

)

Unset all user parameters.

Returns

Zend_Controller_Request_Abstract

getActionKey

(

)

Retrieve the action key.

Returns

string

getActionName

(

)

Retrieve the action name.

Returns

string

getControllerKey

(

)

Retrieve the controller key.

Returns

string

getControllerName

(

)

Retrieve the controller name.

Returns

string

getModuleKey

(

)

Retrieve the module key.

Returns

string

getModuleName

(

)

Retrieve the module name.

Returns

string

getParam	(		$key,
			$default = null
	)

Get an action parameter.

Parameters

string	$key
mixed	$default	Default value to use if key not found

Returns

mixed

getParams

(

)

Get all action parameters.

Returns

array

getUserParam	(		$key,
			$default = null
	)

Retrieve a single user param (i.e, a param specific to the object and not the environment)

Parameters

string	$key
string	$default	Default value to use if key not found

Returns

mixed

getUserParams

(

)

Retrieve only user params (i.e, any param specific to the object and not the environment)

Returns

array

isDispatched

(

)

Determine if the request has been dispatched.

Returns

boolean

setActionKey

(

$key

)

Set the action key.

Parameters

string

$key

Returns

Zend_Controller_Request_Abstract

setActionName

(

$value

)

Set the action name.

Parameters

string

$value

Returns

Zend_Controller_Request_Abstract

See Also

ZF-3465

setControllerKey

(

$key

)

Set the controller key.

Parameters

string

$key

Returns

Zend_Controller_Request_Abstract

setControllerName

(

$value

)

Set the controller name to use.

Parameters

string

$value

Returns

Zend_Controller_Request_Abstract

setDispatched

(

$flag = true

)

Set flag indicating whether or not request has been dispatched.

Parameters

boolean

$flag

Returns

Zend_Controller_Request_Abstract

setModuleKey

(

$key

)

Set the module key.

Parameters

string

$key

Returns

Zend_Controller_Request_Abstract

setModuleName

(

$value

)

Set the module name to use.

Parameters

string

$value

Returns

Zend_Controller_Request_Abstract

setParam	(		$key,
			$value
	)

Set an action parameter.

A $value of null will unset the $key if it exists

Parameters

string	$key
mixed	$value

Returns

Zend_Controller_Request_Abstract

setParams

(

array

$array

)

Set action parameters en masse; does not overwrite.

Null values will unset the associated key.

Parameters

array

$array

Returns

Zend_Controller_Request_Abstract

Member Data Documentation

$_action

protected

$_actionKey = 'action'

protected

$_controller

protected

$_controllerKey = 'controller'

protected

$_dispatched = false

protected

$_module

protected

$_moduleKey = 'module'

protected

$_params = array()

protected