category Zend
package Zend_Controller
subpackage Request
copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
license New BSD License
inherited_from \Zend_Controller_Request_Abstract

 Methods

__construct()

__construct($action = null, $controller = null, $module = null, array $params = array()

Parameters

$action

$controller

$module

$params

Unset all user parameters

clearParams() : \Zend_Controller_Request_Abstract
Inherited

Returns

\Zend_Controller_Request_Abstract

Retrieve the action key

getActionKey() : string
Inherited

Returns

string

Retrieve the action name

getActionName() : string
Inherited

Returns

string

Retrieve the controller key

getControllerKey() : string
Inherited

Returns

string

Retrieve the controller name

getControllerName() : string
Inherited

Returns

string

Retrieve the module key

getModuleKey() : string
Inherited

Returns

string

Retrieve the module name

getModuleName() : string
Inherited

Returns

string

Get an action parameter

getParam(string $key, mixed $default = null) : mixed
Inherited

Parameters

$key

string

$default

mixed

Default value to use if key not found

Returns

mixed

Get all action parameters

getParams() : array
Inherited

Returns

array

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

getUserParam(string $key, string $default = null) : mixed
Inherited

Parameters

$key

string

$default

string

Default value to use if key not found

Returns

mixed

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

getUserParams() : array
Inherited

Returns

array

Determine if the request has been dispatched

isDispatched() : boolean
Inherited

Returns

boolean

Set the action key

setActionKey(string $key) : \Zend_Controller_Request_Abstract
Inherited

Parameters

$key

string

Returns

\Zend_Controller_Request_Abstract

Set the action name

setActionName(string $value) : \Zend_Controller_Request_Abstract
Inherited

Parameters

$value

string

Returns

\Zend_Controller_Request_Abstract

Set the controller key

setControllerKey(string $key) : \Zend_Controller_Request_Abstract
Inherited

Parameters

$key

string

Returns

\Zend_Controller_Request_Abstract

Set the controller name to use

setControllerName(string $value) : \Zend_Controller_Request_Abstract
Inherited

Parameters

$value

string

Returns

\Zend_Controller_Request_Abstract

Set flag indicating whether or not request has been dispatched

setDispatched(boolean $flag = true) : \Zend_Controller_Request_Abstract
Inherited

Parameters

$flag

boolean

Returns

\Zend_Controller_Request_Abstract

Set the module key

setModuleKey(string $key) : \Zend_Controller_Request_Abstract
Inherited

Parameters

$key

string

Returns

\Zend_Controller_Request_Abstract

Set the module name to use

setModuleName(string $value) : \Zend_Controller_Request_Abstract
Inherited

Parameters

$value

string

Returns

\Zend_Controller_Request_Abstract

Set an action parameter

setParam(string $key, mixed $value) : \Zend_Controller_Request_Abstract
Inherited

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

Parameters

$key

string

$value

mixed

Returns

\Zend_Controller_Request_Abstract

Set action parameters en masse; does not overwrite

setParams(array $array) : \Zend_Controller_Request_Abstract
Inherited

Null values will unset the associated key.

Parameters

$array

array

Returns

\Zend_Controller_Request_Abstract

 Properties

 

Action

$_action : string

Default

 

Action key for retrieving action from params

$_actionKey : string

Default

'action'
 

Controller

$_controller : string

Default

 

Controller key for retrieving controller from params

$_controllerKey : string

Default

'controller'
 

Has the action been dispatched?

$_dispatched : boolean

Default

false
 

Module

$_module : string

Default

 

Module key for retrieving module from params

$_moduleKey : string

Default

'module'
 

Request parameters

$_params : array

Default

array()