Controller/Request/Abstract.php

Show:

inherited

Classes
- \Zend_Controller_Request_Abstract

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 24593 2012-01-05 20:35:02Z matthew $

\Zend_Controller_Request_Abstract
jump to top

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

Properties

string $_action

Action

Details

Type: string

string $_actionKey = 'action'

Action key for retrieving action from params

Default value'action'Details

Type: string

string $_controller

Controller

Details

Type: string

string $_controllerKey = 'controller'

Controller key for retrieving controller from params

Default value'controller'Details

Type: string

boolean $_dispatched = false

Has the action been dispatched?

Default valuefalseDetails

Type: boolean

string $_module

Module

Details

Type: string

string $_moduleKey = 'module'

Module key for retrieving module from params

Default value'module'Details

Type: string

array $_params = array()

Request parameters

Default valuearray()Details

Type: array

Methods

clearParams() : \Zend_Controller_Request_Abstract

Unset all user parameters

Returns

Type	Description
\Zend_Controller_Request_Abstract

getActionKey() : string

Retrieve the action key

Returns

Type	Description
string

getActionName() : string

Retrieve the action name

Returns

Type	Description
string

getControllerKey() : string

Retrieve the controller key

Returns

Type	Description
string

getControllerName() : string

Retrieve the controller name

Returns

Type	Description
string

getModuleKey() : string

Retrieve the module key

Returns

Type	Description
string

getModuleName() : string

Retrieve the module name

Returns

Type	Description
string

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

getParams() : array

Get all action parameters

Returns

Type	Description
array

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

getUserParams() : array

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

Returns

Type	Description
array

isDispatched() : boolean

Determine if the request has been dispatched

Returns

Type	Description
boolean

setActionKey(string $key) : \Zend_Controller_Request_Abstract

Set the action key

Parameters

Name	Type	Description
$key	string

Returns

Type	Description
\Zend_Controller_Request_Abstract

setActionName(string $value) : \Zend_Controller_Request_Abstract

Set the action name

Parameters

Name	Type	Description
$value	string

Returns

Type	Description
\Zend_Controller_Request_Abstract

setControllerKey(string $key) : \Zend_Controller_Request_Abstract

Set the controller key

Parameters

Name	Type	Description
$key	string

Returns

Type	Description
\Zend_Controller_Request_Abstract

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

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

setModuleKey(string $key) : \Zend_Controller_Request_Abstract

Set the module key

Parameters

Name	Type	Description
$key	string

Returns

Type	Description
\Zend_Controller_Request_Abstract

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

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

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

Controller/Request/Abstract.php

\Zend_Controller_Request_Abstractjump to top

Properties

Methods

\Zend_Controller_Request_Abstract
jump to top