## Interface Zend_Controller_Dispatcher_Interface

Description

- license: New BSD License
- copyright: Copyright (c) 2005-2007 Zend Technologies USA Inc. (http://www.zend.com)

Located in /Zend/Controller/Dispatcher/Interface.php (line 37)

Method Summary
Zend_Controller_Dispatcher_Interface addControllerDirectory (string $path, [string $args = null])
Zend_Controller_Dispatcher_Interface clearParams ([null|string|array $name = null])
Zend_Controller_Request_Abstract|boolean dispatch (Zend_Controller_Request_Abstract $request, Zend_Controller_Response_Abstract $response)
string formatActionName (string $unformatted)
string formatControllerName (string $unformatted)
array getControllerDirectory ()
mixed getParam (string $name)
array getParams ()
Zend_Controller_Response_Abstract|null getResponse ()
boolean isDispatchable (Zend_Controller_Request_Abstract $request)
boolean isValidModule (string $module)
Zend_Controller_Dispatcher_Interface setControllerDirectory ( $path, string|array $dir)
Zend_Controller_Dispatcher_Interface setParam (string $name, mixed $value)
Zend_Controller_Dispatcher_Interface setParams ( $params)
void setResponse ([Zend_Controller_Response_Abstract $response = null])
Methods
addControllerDirectory (line 135)

Add a controller directory to the controller directory stack

- access: public

Zend_Controller_Dispatcher_Interface addControllerDirectory (string $path, [string $args = null])

- string $path
- string $args

clearParams (line 111)

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.

- access: public

Zend_Controller_Dispatcher_Interface clearParams ([null|string|array $name = null])

- null|string|array $name: single key or array of keys for params to clear

dispatch (line 163)

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

- access: public

Zend_Controller_Request_Abstract|boolean dispatch (Zend_Controller_Request_Abstract $request, Zend_Controller_Response_Abstract $response)

- Zend_Controller_Request_Abstract $request
- Zend_Controller_Response_Abstract $response

formatActionName (line 59)

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.

- access: public

string formatActionName (string $unformatted)

- string $unformatted

formatControllerName (line 48)

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.

- access: public

string formatControllerName (string $unformatted)

- string $unformatted

getControllerDirectory (line 153)

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

- access: public

array getControllerDirectory ()
getParam (line 92)

Retrieve a single parameter from the controller parameter stack

- access: public

mixed getParam (string $name)

- string $name

getParams (line 99)

Retrieve the parameters to pass to the Action Controller constructor

- access: public

array getParams ()
getResponse (line 126)

Retrieve the response object, if any

- access: public

Zend_Controller_Response_Abstract|null getResponse ()
isDispatchable (line 67)

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

- access: public

boolean isDispatchable (Zend_Controller_Request_Abstract $request)

- Zend_Controller_Request_Abstract $request

isValidModule (line 171)

Whether or not a given module is valid

- access: public

boolean isValidModule (string $module)

- string $module

setControllerDirectory (line 146)

Set the directory where controller files are stored

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

- access: public

Zend_Controller_Dispatcher_Interface setControllerDirectory ( $path, string|array $dir)

- string|array $dir
- $path

setParam (line 76)

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

- access: public

Zend_Controller_Dispatcher_Interface setParam (string $name, mixed $value)

- string $name
- mixed $value

setParams (line 84)

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

- access: public

Zend_Controller_Dispatcher_Interface setParams ( $params)

- array $params

setResponse (line 119)

Set the response object to use, if any

- access: public

void setResponse ([Zend_Controller_Response_Abstract $response = null])

- Zend_Controller_Response_Abstract|null $response

Documentation generated on Wed, 21 Feb 2007 11:52:22 -0800 by phpDocumentor 1.3.1