Controller/Request/Simple.php

Show: PublicProtectedPrivateinherited
Table of Contents
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.

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
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

>VPropertyprotectedstring $_action
inherited
Action
Inherited from: \Zend_Controller_Request_Abstract::$$_action
Details
Type
string
Inherited_from
\Zend_Controller_Request_Abstract::$$_action  
>VPropertyprotectedstring $_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  
>VPropertyprotectedstring $_controller
inherited
Controller
Inherited from: \Zend_Controller_Request_Abstract::$$_controller
Details
Type
string
Inherited_from
\Zend_Controller_Request_Abstract::$$_controller  
>VPropertyprotectedstring $_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  
>VPropertyprotectedboolean $_dispatched = false
inherited
Has the action been dispatched?
Inherited from: \Zend_Controller_Request_Abstract::$$_dispatched
Default valuefalseDetails
Type
boolean
Inherited_from
\Zend_Controller_Request_Abstract::$$_dispatched  
>VPropertyprotectedstring $_module
inherited
Module
Inherited from: \Zend_Controller_Request_Abstract::$$_module
Details
Type
string
Inherited_from
\Zend_Controller_Request_Abstract::$$_module  
>VPropertyprotectedstring $_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  
>VPropertyprotectedarray $_params = array()
inherited
Request parameters
Inherited from: \Zend_Controller_Request_Abstract::$$_params
Default valuearray()Details
Type
array
Inherited_from
\Zend_Controller_Request_Abstract::$$_params  

Methods

methodpublic__construct( $action = null,  $controller = null,  $module = null,  $params = array()) : void

Parameters
NameTypeDescription
$action
$controller
$module
$params
methodpublicclearParams() : \Zend_Controller_Request_Abstract
inherited

Unset all user parameters

Inherited from: \Zend_Controller_Request_Abstract::clearParams()
Returns
TypeDescription
\Zend_Controller_Request_Abstract
methodpublicgetActionKey() : string
inherited

Retrieve the action key

Inherited from: \Zend_Controller_Request_Abstract::getActionKey()
Returns
TypeDescription
string
methodpublicgetActionName() : string
inherited

Retrieve the action name

Inherited from: \Zend_Controller_Request_Abstract::getActionName()
Returns
TypeDescription
string
methodpublicgetControllerKey() : string
inherited

Retrieve the controller key

Inherited from: \Zend_Controller_Request_Abstract::getControllerKey()
Returns
TypeDescription
string
methodpublicgetControllerName() : string
inherited

Retrieve the controller name

Inherited from: \Zend_Controller_Request_Abstract::getControllerName()
Returns
TypeDescription
string
methodpublicgetModuleKey() : string
inherited

Retrieve the module key

Inherited from: \Zend_Controller_Request_Abstract::getModuleKey()
Returns
TypeDescription
string
methodpublicgetModuleName() : string
inherited

Retrieve the module name

Inherited from: \Zend_Controller_Request_Abstract::getModuleName()
Returns
TypeDescription
string
methodpublicgetParam(string $key, mixed $default = null) : mixed
inherited

Get an action parameter

Inherited from: \Zend_Controller_Request_Abstract::getParam()
Parameters
NameTypeDescription
$keystring
$defaultmixed

Default value to use if key not found

Returns
TypeDescription
mixed
methodpublicgetParams() : array
inherited

Get all action parameters

Inherited from: \Zend_Controller_Request_Abstract::getParams()
Returns
TypeDescription
array
methodpublicgetUserParam(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
NameTypeDescription
$keystring
$defaultstring

Default value to use if key not found

Returns
TypeDescription
mixed
methodpublicgetUserParams() : 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
TypeDescription
array
methodpublicisDispatched() : boolean
inherited

Determine if the request has been dispatched

Inherited from: \Zend_Controller_Request_Abstract::isDispatched()
Returns
TypeDescription
boolean
methodpublicsetActionKey(string $key) : \Zend_Controller_Request_Abstract
inherited

Set the action key

Inherited from: \Zend_Controller_Request_Abstract::setActionKey()
Parameters
NameTypeDescription
$keystring
Returns
TypeDescription
\Zend_Controller_Request_Abstract
methodpublicsetActionName(string $value) : \Zend_Controller_Request_Abstract
inherited

Set the action name

Inherited from: \Zend_Controller_Request_Abstract::setActionName()
Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Controller_Request_Abstract
methodpublicsetControllerKey(string $key) : \Zend_Controller_Request_Abstract
inherited

Set the controller key

Inherited from: \Zend_Controller_Request_Abstract::setControllerKey()
Parameters
NameTypeDescription
$keystring
Returns
TypeDescription
\Zend_Controller_Request_Abstract
methodpublicsetControllerName(string $value) : \Zend_Controller_Request_Abstract
inherited

Set the controller name to use

Inherited from: \Zend_Controller_Request_Abstract::setControllerName()
Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Controller_Request_Abstract
methodpublicsetDispatched(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
NameTypeDescription
$flagboolean
Returns
TypeDescription
\Zend_Controller_Request_Abstract
methodpublicsetModuleKey(string $key) : \Zend_Controller_Request_Abstract
inherited

Set the module key

Inherited from: \Zend_Controller_Request_Abstract::setModuleKey()
Parameters
NameTypeDescription
$keystring
Returns
TypeDescription
\Zend_Controller_Request_Abstract
methodpublicsetModuleName(string $value) : \Zend_Controller_Request_Abstract
inherited

Set the module name to use

Inherited from: \Zend_Controller_Request_Abstract::setModuleName()
Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Controller_Request_Abstract
methodpublicsetParam(string $key, mixed $value) : \Zend_Controller_Request_Abstract
inherited

Set an action parameter

Inherited from: \Zend_Controller_Request_Abstract::setParam()

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

Parameters
NameTypeDescription
$keystring
$valuemixed
Returns
TypeDescription
\Zend_Controller_Request_Abstract
methodpublicsetParams(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.

Parameters
NameTypeDescription
$arrayarray
Returns
TypeDescription
\Zend_Controller_Request_Abstract
Documentation was generated by phpDocumentor 2.0.0a12.