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.

__construct(
$action
=
null, $controller
=
null, $module
=
null, $params
=
array
)
:
void
Name | Type | Description |
---|---|---|
$action | ||
$controller | ||
$module | ||
$params |

clearParams(
)
:
\Zend_Controller_Request_Abstract
Unset all user parameters
Inherited from: \Zend_Controller_Request_Abstract::clearParams()Type | Description |
---|---|
\Zend_Controller_Request_Abstract |

getActionKey(
)
:
string
Retrieve the action key
Inherited from: \Zend_Controller_Request_Abstract::getActionKey()Type | Description |
---|---|
string |

getActionName(
)
:
string
Retrieve the action name
Inherited from: \Zend_Controller_Request_Abstract::getActionName()Type | Description |
---|---|
string |

getControllerKey(
)
:
string
Retrieve the controller key
Inherited from: \Zend_Controller_Request_Abstract::getControllerKey()Type | Description |
---|---|
string |

getControllerName(
)
:
string
Retrieve the controller name
Inherited from: \Zend_Controller_Request_Abstract::getControllerName()Type | Description |
---|---|
string |

getModuleKey(
)
:
string
Retrieve the module key
Inherited from: \Zend_Controller_Request_Abstract::getModuleKey()Type | Description |
---|---|
string |

getModuleName(
)
:
string
Retrieve the module name
Inherited from: \Zend_Controller_Request_Abstract::getModuleName()Type | Description |
---|---|
string |

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

getParams(
)
:
array
Get all action parameters
Inherited from: \Zend_Controller_Request_Abstract::getParams()Type | Description |
---|---|
array |

getUserParam(
string $key, string $default
=
null
)
:
mixed
Retrieve a single user param (i.e, a param specific to the object and not the environment)
Inherited from: \Zend_Controller_Request_Abstract::getUserParam()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)
Inherited from: \Zend_Controller_Request_Abstract::getUserParams()Type | Description |
---|---|
array |

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

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

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

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

setControllerName(
string $value
)
:
\Zend_Controller_Request_Abstract
Set the controller name to use
Inherited from: \Zend_Controller_Request_Abstract::setControllerName()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
Inherited from: \Zend_Controller_Request_Abstract::setDispatched()Name | Type | Description |
---|---|---|
$flag | boolean |
Type | Description |
---|---|
\Zend_Controller_Request_Abstract |

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

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

setParam(
string $key, mixed $value
)
:
\Zend_Controller_Request_Abstract
Set an action parameter
Inherited from: \Zend_Controller_Request_Abstract::setParam()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
Inherited from: \Zend_Controller_Request_Abstract::setParams()Null values will unset the associated key.
Name | Type | Description |
---|---|---|
$array | array |
Type | Description |
---|---|
\Zend_Controller_Request_Abstract |