Docs For Class Zend_Controller_Request

Description

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

Located in /Controller/Request/Abstract.php (line 28)

Direct descendents

Class	Description
Zend_Controller_Request_Simple
Zend_Controller_Request_Http	Zend_Controller_Request_Http

Variable Summary

string $_action

string $_actionKey

string $_controller

string $_controllerKey

boolean $_dispatched

string $_module

string $_moduleKey

array $_params

Method Summary

Zend_Controller_Request_Abstract clearParams ()

string getActionKey ()

string getActionName ()

string getControllerKey ()

string getControllerName ()

string getModuleKey ()

string getModuleName ()

mixed getParam (string $key, [mixed $default = null])

array getParams ()

mixed getUserParam (string $key, [string $default = null])

array getUserParams ()

boolean isDispatched ()

Zend_Controller_Request_Abstract setActionKey (string $key)

Zend_Controller_Request_Abstract setActionName (string $value)

Zend_Controller_Request_Abstract setControllerKey (string $key)

Zend_Controller_Request_Abstract setControllerName (string $value)

Zend_Controller_Request_Abstract setDispatched ([boolean $flag = true])

Zend_Controller_Request_Abstract setModuleKey (string $key)

Zend_Controller_Request_Abstract setModuleName (string $value)

Zend_Controller_Request_Abstract setParam (string $key, mixed $value)

Zend_Controller_Request_Abstract setParams ( $array)

Variables

string $_action (line 64)

Action

access: protected

string $_actionKey = 'action' (line 70)

Action key for retrieving action from params

access: protected

string $_controller (line 52)

Controller

access: protected

string $_controllerKey = 'controller' (line 58)

Controller key for retrieving controller from params

access: protected

boolean $_dispatched = false (line 34)

Has the action been dispatched?

access: protected

string $_module (line 40)

Module

access: protected

string $_moduleKey = 'module' (line 46)

Module key for retrieving module from params

access: protected

array $_params = array() (line 76)

Request parameters

access: protected

Redefined in descendants as:

Zend_Controller_Request_Http::$_params : Instance parameters

Methods

clearParams (line 329)

Unset all user parameters

access: public

Zend_Controller_Request_Abstract clearParams ()

getActionKey (line 211)

Retrieve the action key

access: public

string getActionKey ()

getActionName (line 135)

Retrieve the action name

access: public

string getActionName ()

getControllerKey (line 189)

Retrieve the controller key

access: public

string getControllerKey ()

getControllerName (line 109)

Retrieve the controller name

access: public

string getControllerName ()

getModuleKey (line 167)

Retrieve the module key

access: public

string getModuleKey ()

getModuleName (line 83)

Retrieve the module name

access: public

string getModuleName ()

getParam (line 235)

Get an action parameter

access: public

mixed getParam (string $key, [mixed $default = null])

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

Redefined in descendants as:

Zend_Controller_Request_Http::getParam() : Retrieve a parameter

getParams (line 298)

Get all action parameters

access: public

array getParams ()

Redefined in descendants as:

Zend_Controller_Request_Http::getParams() : Retrieve an array of parameters

getUserParam (line 262)

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

access: public

mixed getUserParam (string $key, [string $default = null])

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

getUserParams (line 250)

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

access: public

array getUserParams ()

isDispatched (line 352)

Determine if the request has been dispatched

access: public

boolean isDispatched ()

setActionKey (line 222)

Set the action key

access: public

Zend_Controller_Request_Abstract setActionKey (string $key)

string $key

setActionName (line 150)

Set the action name

access: public

Zend_Controller_Request_Abstract setActionName (string $value)

string $value

setControllerKey (line 200)

Set the controller key

access: public

Zend_Controller_Request_Abstract setControllerKey (string $key)

string $key

setControllerName (line 124)

Set the controller name to use

access: public

Zend_Controller_Request_Abstract setControllerName (string $value)

string $value

setDispatched (line 341)

Set flag indicating whether or not request has been dispatched

access: public

Zend_Controller_Request_Abstract setDispatched ([boolean $flag = true])

boolean $flag

setModuleKey (line 178)

Set the module key

access: public

Zend_Controller_Request_Abstract setModuleKey (string $key)

string $key

setModuleName (line 98)

Set the module name to use

access: public

Zend_Controller_Request_Abstract setModuleName (string $value)

string $value

setParam (line 280)

Set an action parameter

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

access: public

Zend_Controller_Request_Abstract setParam (string $key, mixed $value)

string $key
mixed $value

Redefined in descendants as:

Zend_Controller_Request_Http::setParam() : Set a userland parameter

setParams (line 311)

Set action parameters en masse; does not overwrite

Null values will unset the associated key.

access: public

Zend_Controller_Request_Abstract setParams ( $array)

array $array

Redefined in descendants as:

Zend_Controller_Request_Http::setParams() : Set parameters