Controller/Request/Abstract.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Controller
version: $Id: Abstract.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes: Zend_Controller_Request_Abstract

Description

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.

Zend_Controller_Request_Abstract
jump to top

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Controller
Properties: $_dispatched; $_module; $_moduleKey; $_controller; $_controllerKey; $_action; $_actionKey; $_params
Methods: getModuleName; setModuleName; getControllerName; setControllerName; getActionName; setActionName; getModuleKey; setModuleKey; getControllerKey; setControllerKey; getActionKey; setActionKey; getParam; getUserParams; getUserParam; setParam; getParams; setParams; clearParams; setDispatched; isDispatched

Description

Properties

$_action
jump to class

string $_action = ''

Action

Details

$_action: string
visibility: protected
default
final: false
static: false

$_actionKey
jump to class

string $_actionKey = 'action'

Action key for retrieving action from params

Details

$_actionKey: string
visibility: protected
default: action
final: false
static: false

$_controller
jump to class

string $_controller = ''

Controller

Details

$_controller: string
visibility: protected
default
final: false
static: false

$_controllerKey
jump to class

string $_controllerKey = 'controller'

Controller key for retrieving controller from params

Details

$_controllerKey: string
visibility: protected
default: controller
final: false
static: false

$_dispatched
jump to class

boolean $_dispatched = 'false'

Has the action been dispatched?

Details

$_dispatched: boolean
visibility: protected
default: false
final: false
static: false

$_module
jump to class

string $_module = ''

Module

Details

$_module: string
visibility: protected
default
final: false
static: false

$_moduleKey
jump to class

string $_moduleKey = 'module'

Module key for retrieving module from params

Details

$_moduleKey: string
visibility: protected
default: module
final: false
static: false

$_params
jump to class

array $_params = 'array'

Request parameters

Details

$_params: array
visibility: protected
default: array
final: false
static: false

Methods

clearParams
jump to class

clearParams(
          
          )
        
        :
        Zend_Controller_Request_Abstract

Unset all user parameters

Output

Zend_Controller_Request_Abstract

Details

visibility: public
final: false
static: false

getActionKey
jump to class

getActionKey(
          
          )
        
        :
        string

Retrieve the action key

Output

string

Details

visibility: public
final: false
static: false

getActionName
jump to class

getActionName(
          
          )
        
        :
        string

Retrieve the action name

Output

string

Details

visibility: public
final: false
static: false

getControllerKey
jump to class

getControllerKey(
          
          )
        
        :
        string

Retrieve the controller key

Output

string

Details

visibility: public
final: false
static: false

getControllerName
jump to class

getControllerName(
          
          )
        
        :
        string

Retrieve the controller name

Output

string

Details

visibility: public
final: false
static: false

getModuleKey
jump to class

getModuleKey(
          
          )
        
        :
        string

Retrieve the module key

Output

string

Details

visibility: public
final: false
static: false

getModuleName
jump to class

getModuleName(
          
          )
        
        :
        string

Retrieve the module name

Output

string

Details

visibility: public
final: false
static: false

getParam
jump to class

getParam(
          string $key, mixed $default
              =
              null
          )
        
        :
        mixed

Get an action parameter

Arguments

$key: string
$default: mixed
Default value to use if key not found

Output

mixed

Details

visibility: public
final: false
static: false

getParams
jump to class

getParams(
          
          )
        
        :
        array

Get all action parameters

Output

array

Details

visibility: public
final: false
static: false

getUserParam
jump to class

getUserParam(
          string $key, string $default
              =
              null
          )
        
        :
        mixed

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

Arguments

$key: string
$default: string
Default value to use if key not found

Output

mixed

Details

visibility: public
final: false
static: false

getUserParams
jump to class

getUserParams(
          
          )
        
        :
        array

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

Output

array

Details

visibility: public
final: false
static: false

isDispatched
jump to class

isDispatched(
          
          )
        
        :
        boolean

Determine if the request has been dispatched

Output

boolean

Details

visibility: public
final: false
static: false

setActionKey
jump to class

setActionKey(
          string $key
          )
        
        :
        Zend_Controller_Request_Abstract

Set the action key

Arguments

$key: string

Output

Zend_Controller_Request_Abstract

Details

visibility: public
final: false
static: false

setActionName
jump to class

setActionName(
          string $value
          )
        
        :
        Zend_Controller_Request_Abstract

Set the action name

Arguments

$value: string

Output

Zend_Controller_Request_Abstract

Details

visibility: public
final: false
static: false

setControllerKey
jump to class

setControllerKey(
          string $key
          )
        
        :
        Zend_Controller_Request_Abstract

Set the controller key

Arguments

$key: string

Output

Zend_Controller_Request_Abstract

Details

visibility: public
final: false
static: false

setControllerName
jump to class

setControllerName(
          string $value
          )
        
        :
        Zend_Controller_Request_Abstract

Set the controller name to use

Arguments

$value: string

Output

Zend_Controller_Request_Abstract

Details

visibility: public
final: false
static: false

setDispatched
jump to class

setDispatched(
          boolean $flag
              =
              true
          )
        
        :
        Zend_Controller_Request_Abstract

Set flag indicating whether or not request has been dispatched

Arguments

$flag: boolean

Output

Zend_Controller_Request_Abstract

Details

visibility: public
final: false
static: false

setModuleKey
jump to class

setModuleKey(
          string $key
          )
        
        :
        Zend_Controller_Request_Abstract

Set the module key

Arguments

$key: string

Output

Zend_Controller_Request_Abstract

Details

visibility: public
final: false
static: false

setModuleName
jump to class

setModuleName(
          string $value
          )
        
        :
        Zend_Controller_Request_Abstract

Set the module name to use

Arguments

$value: string

Output

Zend_Controller_Request_Abstract

Details

visibility: public
final: false
static: false

setParam
jump to class

setParam(
          string $key, mixed $value
          )
        
        :
        Zend_Controller_Request_Abstract

Set an action parameter

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

Arguments

$key: string
$value: mixed

Output

Zend_Controller_Request_Abstract

Details

visibility: public
final: false
static: false

setParams
jump to class

setParams(
          array $array
          )
        
        :
        Zend_Controller_Request_Abstract

Set action parameters en masse; does not overwrite

Null values will unset the associated key.

Arguments

$array: array

Output

Zend_Controller_Request_Abstract

Details

visibility: public
final: false
static: false

API Documentation

Controller/Request/Abstract.php

Description

Zend_Controller_Request_Abstractjump to top

Description

Properties

$_actionjump to class

Details

$_actionKeyjump to class

Details

$_controllerjump to class

Details

$_controllerKeyjump to class

Details

$_dispatchedjump to class

Details

$_modulejump to class

Details

$_moduleKeyjump to class

Details

$_paramsjump to class

Details

Methods

clearParamsjump to class

Output

Details

getActionKeyjump to class

Output

Details

getActionNamejump to class

Output

Details

getControllerKeyjump to class

Output

Details

getControllerNamejump to class

Output

Details

getModuleKeyjump to class

Output

Details

getModuleNamejump to class

Output

Details

getParamjump to class

Arguments

Output

Details

getParamsjump to class

Output

Details

getUserParamjump to class

Arguments

Output

Details

getUserParamsjump to class

Output

Details

isDispatchedjump to class

Output

Details

setActionKeyjump to class

Arguments

Output

Details

setActionNamejump to class

Arguments

Output

Details

setControllerKeyjump to class

Arguments

Output

Details

setControllerNamejump to class

Arguments

Output

Details

setDispatchedjump to class

Arguments

Output

Zend_Controller_Request_Abstract
jump to top

$_action
jump to class

$_actionKey
jump to class

$_controller
jump to class

$_controllerKey
jump to class

$_dispatched
jump to class

$_module
jump to class

$_moduleKey
jump to class

$_params
jump to class

clearParams
jump to class

getActionKey
jump to class

getActionName
jump to class

getControllerKey
jump to class

getControllerName
jump to class

getModuleKey
jump to class

getModuleName
jump to class

getParam
jump to class

getParams
jump to class

getUserParam
jump to class

getUserParams
jump to class

isDispatched
jump to class

setActionKey
jump to class

setActionName
jump to class

setControllerKey
jump to class

setControllerName
jump to class

setDispatched
jump to class

setModuleKey
jump to class

setModuleName
jump to class

setParam
jump to class

setParams
jump to class