Controller/Request/Abstract.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-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Controller  
Version
$Id$  

\Zend_Controller_Request_Abstract

Package: Zend_Controller
Children
\Zend_Controller_Request_Http
\Zend_Controller_Request_Simple
Category
Zend  
Copyright
Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

>VPropertyprotectedstring $_action
Action
Details
Type
string
>VPropertyprotectedstring $_actionKey = 'action'
Action key for retrieving action from params
Default value'action'Details
Type
string
>VPropertyprotectedstring $_controller
Controller
Details
Type
string
>VPropertyprotectedstring $_controllerKey = 'controller'
Controller key for retrieving controller from params
Default value'controller'Details
Type
string
>VPropertyprotectedboolean $_dispatched = false
Has the action been dispatched?
Default valuefalseDetails
Type
boolean
>VPropertyprotectedstring $_module
Module
Details
Type
string
>VPropertyprotectedstring $_moduleKey = 'module'
Module key for retrieving module from params
Default value'module'Details
Type
string
>VPropertyprotectedarray $_params = array()
Request parameters
Default valuearray()Details
Type
array

Methods

methodpublicclearParams() : \Zend_Controller_Request_Abstract

Unset all user parameters

Returns
TypeDescription
\Zend_Controller_Request_Abstract
methodpublicgetActionKey() : string

Retrieve the action key

Returns
TypeDescription
string
methodpublicgetActionName() : string

Retrieve the action name

Returns
TypeDescription
string
methodpublicgetControllerKey() : string

Retrieve the controller key

Returns
TypeDescription
string
methodpublicgetControllerName() : string

Retrieve the controller name

Returns
TypeDescription
string
methodpublicgetModuleKey() : string

Retrieve the module key

Returns
TypeDescription
string
methodpublicgetModuleName() : string

Retrieve the module name

Returns
TypeDescription
string
methodpublicgetParam(string $key, mixed $default = null) : mixed

Get an action parameter

Parameters
NameTypeDescription
$keystring
$defaultmixed

Default value to use if key not found

Returns
TypeDescription
mixed
methodpublicgetParams() : array

Get all action parameters

Returns
TypeDescription
array
methodpublicgetUserParam(string $key, string $default = null) : mixed

Retrieve a single user param (i.e, a param specific to the object and not the environment)

Parameters
NameTypeDescription
$keystring
$defaultstring

Default value to use if key not found

Returns
TypeDescription
mixed
methodpublicgetUserParams() : array

Retrieve only user params (i.e, any param specific to the object and not the environment)

Returns
TypeDescription
array
methodpublicisDispatched() : boolean

Determine if the request has been dispatched

Returns
TypeDescription
boolean
methodpublicsetActionKey(string $key) : \Zend_Controller_Request_Abstract

Set the action key

Parameters
NameTypeDescription
$keystring
Returns
TypeDescription
\Zend_Controller_Request_Abstract
methodpublicsetActionName(string $value) : \Zend_Controller_Request_Abstract

Set the action name

Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Controller_Request_Abstract
methodpublicsetControllerKey(string $key) : \Zend_Controller_Request_Abstract

Set the controller key

Parameters
NameTypeDescription
$keystring
Returns
TypeDescription
\Zend_Controller_Request_Abstract
methodpublicsetControllerName(string $value) : \Zend_Controller_Request_Abstract

Set the controller name to use

Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Controller_Request_Abstract
methodpublicsetDispatched(boolean $flag = true) : \Zend_Controller_Request_Abstract

Set flag indicating whether or not request has been dispatched

Parameters
NameTypeDescription
$flagboolean
Returns
TypeDescription
\Zend_Controller_Request_Abstract
methodpublicsetModuleKey(string $key) : \Zend_Controller_Request_Abstract

Set the module key

Parameters
NameTypeDescription
$keystring
Returns
TypeDescription
\Zend_Controller_Request_Abstract
methodpublicsetModuleName(string $value) : \Zend_Controller_Request_Abstract

Set the module name to use

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

Set an action parameter

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

Set action parameters en masse; does not overwrite

Null values will unset the associated key.
Parameters
NameTypeDescription
$arrayarray
Returns
TypeDescription
\Zend_Controller_Request_Abstract
Documentation was generated by phpDocumentor 2.2.0 .