Zend Framework
LICENSE
This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

string
$_actionKey= ''action''
Action key for retrieving action from params
'action'
Details
string
$_controllerKey= ''controller''
Controller key for retrieving controller from params
'controller'
Details
boolean
$_dispatched= 'false'
Has the action been dispatched?
false
Details
string
$_moduleKey= ''module''
Module key for retrieving module from params
'module'
Details
clearParams(
)
:
\Zend_Controller_Request_Abstract
Unset all user parameters
Type | Description |
---|---|
\Zend_Controller_Request_Abstract |

getParam(
string $key, mixed $default
=
null
)
:
mixed
Get an action parameter
Name | Type | Description |
---|---|---|
$key | string | |
$default | mixed | Default value to use if key not found |
Type | Description |
---|---|
mixed |

getUserParam(
string $key, string $default
=
null
)
:
mixed
Retrieve a single user param (i.e, a param specific to the object and not the environment)
Name | Type | Description |
---|---|---|
$key | string | |
$default | string | Default value to use if key not found |
Type | Description |
---|---|
mixed |

getUserParams(
)
:
array
Retrieve only user params (i.e, any param specific to the object and not the environment)
Type | Description |
---|---|
array |

isDispatched(
)
:
boolean
Determine if the request has been dispatched
Type | Description |
---|---|
boolean |

setActionKey(
string $key
)
:
\Zend_Controller_Request_Abstract
Set the action key
Name | Type | Description |
---|---|---|
$key | string |
Type | Description |
---|---|
\Zend_Controller_Request_Abstract |

setActionName(
string $value
)
:
\Zend_Controller_Request_Abstract
Set the action name
Name | Type | Description |
---|---|---|
$value | string |
Type | Description |
---|---|
\Zend_Controller_Request_Abstract |

setControllerKey(
string $key
)
:
\Zend_Controller_Request_Abstract
Set the controller key
Name | Type | Description |
---|---|---|
$key | string |
Type | Description |
---|---|
\Zend_Controller_Request_Abstract |

setControllerName(
string $value
)
:
\Zend_Controller_Request_Abstract
Set the controller name to use
Name | Type | Description |
---|---|---|
$value | string |
Type | Description |
---|---|
\Zend_Controller_Request_Abstract |

setDispatched(
boolean $flag
=
true
)
:
\Zend_Controller_Request_Abstract
Set flag indicating whether or not request has been dispatched
Name | Type | Description |
---|---|---|
$flag | boolean |
Type | Description |
---|---|
\Zend_Controller_Request_Abstract |

setModuleKey(
string $key
)
:
\Zend_Controller_Request_Abstract
Set the module key
Name | Type | Description |
---|---|---|
$key | string |
Type | Description |
---|---|
\Zend_Controller_Request_Abstract |

setModuleName(
string $value
)
:
\Zend_Controller_Request_Abstract
Set the module name to use
Name | Type | Description |
---|---|---|
$value | string |
Type | Description |
---|---|
\Zend_Controller_Request_Abstract |

setParam(
string $key, mixed $value
)
:
\Zend_Controller_Request_Abstract
Set an action parameter
A $value of null will unset the $key if it exists
Name | Type | Description |
---|---|---|
$key | string | |
$value | mixed |
Type | Description |
---|---|
\Zend_Controller_Request_Abstract |

setParams(
array $array
)
:
\Zend_Controller_Request_Abstract
Set action parameters en masse; does not overwrite
Null values will unset the associated key.
Name | Type | Description |
---|---|---|
$array | array |
Type | Description |
---|---|
\Zend_Controller_Request_Abstract |