Controller/Dispatcher/Interface.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
subpackage: Dispatcher
version: $Id: Interface.php 20096 2010-01-06 02:05:09Z bkarwin $
Interfaces: Zend_Controller_Dispatcher_Interface

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_Dispatcher_Interface
jump to top

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
subpackage: Dispatcher
Methods: formatControllerName; formatModuleName; formatActionName; isDispatchable; setParam; setParams; getParam; getParams; clearParams; setResponse; getResponse; addControllerDirectory; setControllerDirectory; getControllerDirectory; dispatch; isValidModule; getDefaultModule; getDefaultControllerName; getDefaultAction

Description

Methods

addControllerDirectory
jump to class

addControllerDirectory(
          string $path, string $args
              =
              null
          )
        
        :
        Zend_Controller_Dispatcher_Interface

Add a controller directory to the controller directory stack

Arguments

$path: string
$args: string

Output

Zend_Controller_Dispatcher_Interface

Details

visibility: public
final: false
static: false

clearParams
jump to class

clearParams(
          null|string|array $name
              =
              null
          )
        
        :
        Zend_Controller_Dispatcher_Interface

Clear the controller parameter stack

By default, clears all parameters. If a parameter name is given, clears only that parameter; if an array of parameter names is provided, clears each.

Arguments

$name: nullstringarray
single key or array of keys for params to clear

Output

Zend_Controller_Dispatcher_Interface

Details

visibility: public
final: false
static: false

dispatch
jump to class

dispatch(
          Zend_Controller_Request_Abstract $request, Zend_Controller_Response_Abstract $response
          )
        
        :
        void

Dispatches a request object to a controller/action. If the action requests a forward to another action, a new request will be returned.

Arguments

$request: Zend_Controller_Request_Abstract
$response: Zend_Controller_Response_Abstract

Details

visibility: public
final: false
static: false

formatActionName
jump to class

formatActionName(
          string $unformatted
          )
        
        :
        string

Formats a string into an action name. This is used to take a raw action name, such as one that would be packaged inside a request object, and reformat into a proper method name that would be found inside a class extending Zend_Controller_Action.

Arguments

$unformatted: string

Output

string

Details

visibility: public
final: false
static: false

formatControllerName
jump to class

formatControllerName(
          string $unformatted
          )
        
        :
        string

Formats a string into a controller name. This is used to take a raw controller name, such as one that would be packaged inside a request object, and reformat it to a proper class name that a class extending Zend_Controller_Action would use.

Arguments

$unformatted: string

Output

string

Details

visibility: public
final: false
static: false

formatModuleName
jump to class

formatModuleName(
          string $unformatted
          )
        
        :
        string

Formats a string into a module name. This is used to take a raw module name, such as one that would be packaged inside a request object, and reformat it to a proper directory/class name that a class extending Zend_Controller_Action would use.

Arguments

$unformatted: string

Output

string

Details

visibility: public
final: false
static: false

getControllerDirectory
jump to class

getControllerDirectory(
          
          )
        
        :
        array

Return the currently set directory(ies) for controller file lookup

Output

array

Details

visibility: public
final: false
static: false

getDefaultAction
jump to class

getDefaultAction(
          
          )
        
        :
        string

Retrieve the default action

Output

string

Details

visibility: public
final: false
static: false

getDefaultControllerName
jump to class

getDefaultControllerName(
          
          )
        
        :
        string

Retrieve the default controller name

Output

string

Details

visibility: public
final: false
static: false

getDefaultModule
jump to class

getDefaultModule(
          
          )
        
        :
        string

Retrieve the default module name

Output

string

Details

visibility: public
final: false
static: false

getParam
jump to class

getParam(
          string $name
          )
        
        :
        mixed

Retrieve a single parameter from the controller parameter stack

Arguments

$name: string

Output

mixed

Details

visibility: public
final: false
static: false

getParams
jump to class

getParams(
          
          )
        
        :
        array

Retrieve the parameters to pass to the Action Controller constructor

Output

array

Details

visibility: public
final: false
static: false

getResponse
jump to class

getResponse(
          
          )
        
        :
        Zend_Controller_Response_Abstract|null

Retrieve the response object, if any

Output

Zend_Controller_Response_Abstract|null

Details

visibility: public
final: false
static: false

isDispatchable
jump to class

isDispatchable(
          Zend_Controller_Request_Abstract $request
          )
        
        :
        boolean

Returns TRUE if an action can be dispatched, or FALSE otherwise.

Arguments

$request: Zend_Controller_Request_Abstract

Output

boolean

Details

visibility: public
final: false
static: false

isValidModule
jump to class

isValidModule(
          string $module
          )
        
        :
        boolean

Whether or not a given module is valid

Arguments

$module: string

Output

boolean

Details

visibility: public
final: false
static: false

setControllerDirectory
jump to class

setControllerDirectory(
           $path
          )
        
        :
        Zend_Controller_Dispatcher_Interface

Set the directory where controller files are stored

Specify a string or an array; if an array is specified, all paths will be added.

Arguments

$path

Output

Zend_Controller_Dispatcher_Interface

Details

visibility: public
final: false
static: false

setParam
jump to class

setParam(
          string $name, mixed $value
          )
        
        :
        Zend_Controller_Dispatcher_Interface

Add or modify a parameter with which to instantiate an Action Controller

Arguments

$name: string
$value: mixed

Output

Zend_Controller_Dispatcher_Interface

Details

visibility: public
final: false
static: false

setParams
jump to class

setParams(
          array $params
          )
        
        :
        Zend_Controller_Dispatcher_Interface

Set an array of a parameters to pass to the Action Controller constructor

Arguments

$params: array

Output

Zend_Controller_Dispatcher_Interface

Details

visibility: public
final: false
static: false

setResponse
jump to class

setResponse(
          Zend_Controller_Response_Abstract|null $response
              =
              null
          )
        
        :
        void

Set the response object to use, if any

Arguments

$response: Zend_Controller_Response_Abstractnull

Details

visibility: public
final: false
static: false

API Documentation

Controller/Dispatcher/Interface.php

Description

Zend_Controller_Dispatcher_Interfacejump to top

Description

Methods

addControllerDirectoryjump to class

Arguments

Output

Details

clearParamsjump to class

Arguments

Output

Details

dispatchjump to class

Arguments

Details

formatActionNamejump to class

Arguments

Output

Details

formatControllerNamejump to class

Arguments

Output

Details

formatModuleNamejump to class

Arguments

Output

Details

getControllerDirectoryjump to class

Output

Details

getDefaultActionjump to class

Output

Details

getDefaultControllerNamejump to class

Output

Details

getDefaultModulejump to class

Output

Details

getParamjump to class

Arguments

Output

Details

getParamsjump to class

Output

Details

getResponsejump to class

Output

Details

isDispatchablejump to class

Arguments

Output

Details

isValidModulejump to class

Arguments

Output

Details

setControllerDirectoryjump to class

Arguments

Output

Details

setParamjump to class

Arguments

Output

Details

setParamsjump to class

Arguments

Output

Details

setResponsejump to class

Arguments

Details

Zend_Controller_Dispatcher_Interface
jump to top

addControllerDirectory
jump to class

clearParams
jump to class

dispatch
jump to class

formatActionName
jump to class

formatControllerName
jump to class

formatModuleName
jump to class

getControllerDirectory
jump to class

getDefaultAction
jump to class

getDefaultControllerName
jump to class

getDefaultModule
jump to class

getParam
jump to class

getParams
jump to class

getResponse
jump to class

isDispatchable
jump to class

isValidModule
jump to class

setControllerDirectory
jump to class

setParam
jump to class

setParams
jump to class

setResponse
jump to class