Controller/Request/Simple.php
Show:
inherited
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
- Subpackage
- Request
- Version
- $Id: Simple.php 24593 2012-01-05 20:35:02Z matthew $
\Zend_Controller_Request_Simple
Package: Zend\Controller\Request
Parameters
Returns
Parameters
Returns
- Parent(s)
- \Zend_Controller_Request_Abstract
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties
string $_actionKey = 'action'
inherited
Action key for retrieving action from params
Inherited from: \Zend_Controller_Request_Abstract::$$_actionKey
Default value
'action'Details- Type
- string
- Inherited_from
- \Zend_Controller_Request_Abstract::$$_actionKey
string $_controller =
Details
- Type
- string
- Inherited_from
- \Zend_Controller_Request_Abstract::$$_controller
string $_controllerKey = 'controller'
inherited
Controller key for retrieving controller from params
Inherited from: \Zend_Controller_Request_Abstract::$$_controllerKey
Default value
'controller'Details- Type
- string
- Inherited_from
- \Zend_Controller_Request_Abstract::$$_controllerKey
boolean $_dispatched = false
inherited
Has the action been dispatched?
Inherited from: \Zend_Controller_Request_Abstract::$$_dispatched
Default value
falseDetails- Type
- boolean
- Inherited_from
- \Zend_Controller_Request_Abstract::$$_dispatched
string $_moduleKey = 'module'
inherited
Module key for retrieving module from params
Inherited from: \Zend_Controller_Request_Abstract::$$_moduleKey
Default value
'module'Details- Type
- string
- Inherited_from
- \Zend_Controller_Request_Abstract::$$_moduleKey
array $_params = array()
Default value
array()Details- Type
- array
- Inherited_from
- \Zend_Controller_Request_Abstract::$$_params
Methods
__construct( $action = null, $controller = null, $module = null, $params = array()) : void
Parameters
| Name | Type | Description |
|---|---|---|
| $action | ||
| $controller | ||
| $module | ||
| $params |
clearParams() : \Zend_Controller_Request_Abstract
Returns
| Type | Description |
|---|---|
| \Zend_Controller_Request_Abstract |
getActionKey() : string
Returns
| Type | Description |
|---|---|
| string |
getActionName() : string
inherited
Retrieve the action name
Inherited from: \Zend_Controller_Request_Abstract::getActionName()
Returns
| Type | Description |
|---|---|
| string |
getControllerKey() : string
inherited
Retrieve the controller key
Inherited from: \Zend_Controller_Request_Abstract::getControllerKey()
Returns
| Type | Description |
|---|---|
| string |
getControllerName() : string
inherited
Retrieve the controller name
Inherited from: \Zend_Controller_Request_Abstract::getControllerName()
Returns
| Type | Description |
|---|---|
| string |
getModuleKey() : string
Returns
| Type | Description |
|---|---|
| string |
getModuleName() : string
inherited
Retrieve the module name
Inherited from: \Zend_Controller_Request_Abstract::getModuleName()
Returns
| Type | Description |
|---|---|
| string |
getParam(string $key, mixed $default = null) : mixed
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $key | string | |
| $default | mixed | Default value to use if key not found |
| Type | Description |
|---|---|
| mixed |
getParams() : array
Returns
| Type | Description |
|---|---|
| array |
getUserParam(string $key, string $default = null) : mixed
inherited
Retrieve a single user param (i.e, a param specific to the object and not the environment)
Inherited from: \Zend_Controller_Request_Abstract::getUserParam()
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $key | string | |
| $default | string | Default value to use if key not found |
| Type | Description |
|---|---|
| mixed |
getUserParams() : array
inherited
Retrieve only user params (i.e, any param specific to the object and not the environment)
Inherited from: \Zend_Controller_Request_Abstract::getUserParams()
Returns
| Type | Description |
|---|---|
| array |
isDispatched() : boolean
inherited
Determine if the request has been dispatched
Inherited from: \Zend_Controller_Request_Abstract::isDispatched()
Returns
| Type | Description |
|---|---|
| boolean |
setActionKey(string $key) : \Zend_Controller_Request_Abstract
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $key | string |
| Type | Description |
|---|---|
| \Zend_Controller_Request_Abstract |
setActionName(string $value) : \Zend_Controller_Request_Abstract
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $value | string |
| Type | Description |
|---|---|
| \Zend_Controller_Request_Abstract |
setControllerKey(string $key) : \Zend_Controller_Request_Abstract
inherited
Set the controller key
Inherited from: \Zend_Controller_Request_Abstract::setControllerKey()
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $key | string |
| Type | Description |
|---|---|
| \Zend_Controller_Request_Abstract |
setControllerName(string $value) : \Zend_Controller_Request_Abstract
inherited
Set the controller name to use
Inherited from: \Zend_Controller_Request_Abstract::setControllerName()
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $value | string |
| Type | Description |
|---|---|
| \Zend_Controller_Request_Abstract |
setDispatched(boolean $flag = true) : \Zend_Controller_Request_Abstract
inherited
Set flag indicating whether or not request has been dispatched
Inherited from: \Zend_Controller_Request_Abstract::setDispatched()
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $flag | boolean |
| Type | Description |
|---|---|
| \Zend_Controller_Request_Abstract |
setModuleKey(string $key) : \Zend_Controller_Request_Abstract
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $key | string |
| Type | Description |
|---|---|
| \Zend_Controller_Request_Abstract |
setModuleName(string $value) : \Zend_Controller_Request_Abstract
inherited
Set the module name to use
Inherited from: \Zend_Controller_Request_Abstract::setModuleName()
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $value | string |
| Type | Description |
|---|---|
| \Zend_Controller_Request_Abstract |
setParam(string $key, mixed $value) : \Zend_Controller_Request_Abstract
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
inherited
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 |