Controller/Request/Abstract.php
inherited
Classes
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 [email protected] so we can send you a copy immediately.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Controller
- Version
- $Id: Abstract.php 24593 2012-01-05 20:35:02Z matthew $
\Zend_Controller_Request_Abstract
- Children
- \Zend_Controller_Request_Http
- \Zend_Controller_Request_Simple
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties
string $_action = Action
- Type
- string
string $_actionKey = 'action'Action key for retrieving action from params
'action'Details- Type
- string
string $_controller = Controller
- Type
- string
string $_controllerKey = 'controller'Controller key for retrieving controller from params
'controller'Details- Type
- string
boolean $_dispatched = falseHas the action been dispatched?
falseDetails- Type
- boolean
string $_module = Module
- Type
- string
string $_moduleKey = 'module'Module key for retrieving module from params
'module'Details- Type
- string
array $_params = array()Request parameters
array()Details- Type
- array
Methods
clearParams() : \Zend_Controller_Request_AbstractUnset all user parameters
| Type | Description |
|---|---|
| \Zend_Controller_Request_Abstract |
getActionKey() : stringRetrieve the action key
| Type | Description |
|---|---|
| string |
getActionName() : stringRetrieve the action name
| Type | Description |
|---|---|
| string |
getControllerKey() : stringRetrieve the controller key
| Type | Description |
|---|---|
| string |
getControllerName() : stringRetrieve the controller name
| Type | Description |
|---|---|
| string |
getModuleKey() : stringRetrieve the module key
| Type | Description |
|---|---|
| string |
getModuleName() : stringRetrieve the module name
| Type | Description |
|---|---|
| string |
getParam(string $key, mixed $default = null) : mixedGet an action parameter
| Name | Type | Description |
|---|---|---|
| $key | string | |
| $default | mixed | Default value to use if key not found |
| Type | Description |
|---|---|
| mixed |
getParams() : arrayGet all action parameters
| Type | Description |
|---|---|
| array |
getUserParam(string $key, string $default = null) : mixedRetrieve 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() : arrayRetrieve only user params (i.e, any param specific to the object and not the environment)
| Type | Description |
|---|---|
| array |
isDispatched() : booleanDetermine if the request has been dispatched
| Type | Description |
|---|---|
| boolean |
setActionKey(string $key) : \Zend_Controller_Request_AbstractSet the action key
| Name | Type | Description |
|---|---|---|
| $key | string |
| Type | Description |
|---|---|
| \Zend_Controller_Request_Abstract |
setActionName(string $value) : \Zend_Controller_Request_AbstractSet the action name
| Name | Type | Description |
|---|---|---|
| $value | string |
| Type | Description |
|---|---|
| \Zend_Controller_Request_Abstract |
setControllerKey(string $key) : \Zend_Controller_Request_AbstractSet the controller key
| Name | Type | Description |
|---|---|---|
| $key | string |
| Type | Description |
|---|---|
| \Zend_Controller_Request_Abstract |
setControllerName(string $value) : \Zend_Controller_Request_AbstractSet the controller name to use
| Name | Type | Description |
|---|---|---|
| $value | string |
| Type | Description |
|---|---|
| \Zend_Controller_Request_Abstract |
setDispatched(boolean $flag = true) : \Zend_Controller_Request_AbstractSet 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_AbstractSet the module key
| Name | Type | Description |
|---|---|---|
| $key | string |
| Type | Description |
|---|---|
| \Zend_Controller_Request_Abstract |
setModuleName(string $value) : \Zend_Controller_Request_AbstractSet the module name to use
| Name | Type | Description |
|---|---|---|
| $value | string |
| Type | Description |
|---|---|
| \Zend_Controller_Request_Abstract |
setParam(string $key, mixed $value) : \Zend_Controller_Request_AbstractSet 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_AbstractSet 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 |