API Documentation

Zend/Controller/Request/Abstract.php

Show: inherited
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  
Version
$Id: Abstract.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Controller_Request_Abstract

Package: Zend\Controller

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  
Used_by
\Zend_Controller_Request_Http  

Properties

Propertyprotectedstring  $_action= ''

Action

Details
Type
string
Propertyprotectedstring  $_actionKey= ''action''

Action key for retrieving action from params

Default value'action'Details
Type
string
Propertyprotectedstring  $_controller= ''

Controller

Details
Type
string
Propertyprotectedstring  $_controllerKey= ''controller''

Controller key for retrieving controller from params

Default value'controller'Details
Type
string
Propertyprotectedboolean  $_dispatched= 'false'

Has the action been dispatched?

Default valuefalseDetails
Type
boolean
Propertyprotectedstring  $_module= ''

Module

Details
Type
string
Propertyprotectedstring  $_moduleKey= ''module''

Module key for retrieving module from params

Default value'module'Details
Type
string
Propertyprotectedarray  $_params= 'array()'

Request parameters

Default valuearray()Details
Type
array

Methods

methodpublicclearParams( ) : \Zend_Controller_Request_Abstract

Unset all user parameters

Returns
Type Description
\Zend_Controller_Request_Abstract
methodpublicgetActionKey( ) : string

Retrieve the action key

Returns
Type Description
string
methodpublicgetActionName( ) : string

Retrieve the action name

Returns
Type Description
string
methodpublicgetControllerKey( ) : string

Retrieve the controller key

Returns
Type Description
string
methodpublicgetControllerName( ) : string

Retrieve the controller name

Returns
Type Description
string
methodpublicgetModuleKey( ) : string

Retrieve the module key

Returns
Type Description
string
methodpublicgetModuleName( ) : string

Retrieve the module name

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

Get an action parameter

Parameters
Name Type Description
$key string
$default mixed

Default value to use if key not found

Returns
Type Description
mixed
methodpublicgetParams( ) : array

Get all action parameters

Returns
Type Description
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
Name Type Description
$key string
$default string

Default value to use if key not found

Returns
Type Description
mixed
methodpublicgetUserParams( ) : array

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

Returns
Type Description
array
methodpublicisDispatched( ) : boolean

Determine if the request has been dispatched

Returns
Type Description
boolean
methodpublicsetActionKey( string $key ) : \Zend_Controller_Request_Abstract

Set the action key

Parameters
Name Type Description
$key string
Returns
Type Description
\Zend_Controller_Request_Abstract
methodpublicsetActionName( string $value ) : \Zend_Controller_Request_Abstract

Set the action name

Parameters
Name Type Description
$value string
Returns
Type Description
\Zend_Controller_Request_Abstract
methodpublicsetControllerKey( string $key ) : \Zend_Controller_Request_Abstract

Set the controller key

Parameters
Name Type Description
$key string
Returns
Type Description
\Zend_Controller_Request_Abstract
methodpublicsetControllerName( string $value ) : \Zend_Controller_Request_Abstract

Set the controller name to use

Parameters
Name Type Description
$value string
Returns
Type Description
\Zend_Controller_Request_Abstract
methodpublicsetDispatched( boolean $flag = true ) : \Zend_Controller_Request_Abstract

Set flag indicating whether or not request has been dispatched

Parameters
Name Type Description
$flag boolean
Returns
Type Description
\Zend_Controller_Request_Abstract
methodpublicsetModuleKey( string $key ) : \Zend_Controller_Request_Abstract

Set the module key

Parameters
Name Type Description
$key string
Returns
Type Description
\Zend_Controller_Request_Abstract
methodpublicsetModuleName( string $value ) : \Zend_Controller_Request_Abstract

Set the module name to use

Parameters
Name Type Description
$value string
Returns
Type Description
\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
Name Type Description
$key string
$value mixed
Returns
Type Description
\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
Name Type Description
$array array
Returns
Type Description
\Zend_Controller_Request_Abstract
Documentation was generated by DocBlox 0.15.1.