Docs For Class Zend_Controller_Dispatcher_Interface

## Interface Zend_Controller_Dispatcher_Interface

Description

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

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

Method Summary
void addParam (mixed $param)
Zend_Controller_Request_Abstract|boolean dispatch (Zend_Controller_Request_Abstract $request, Zend_Controller_Response_Abstract $response)
string formatActionName (string $unformatted)
string formatControllerName (string $unformatted)
string getDefaultAction ()
string getDefaultController ()
array getParams ()
Zend_Controller_Response_Abstract|null getResponse ()
boolean isDispatchable (Zend_Controller_Request_Abstract $request)
self setDefaultAction (string $action)
self setDefaultController (string $controller)
void setParams ( $params)
void setResponse ([Zend_Controller_Response_Abstract $response = null])
Methods
addParam (line 75)

Add a parameter with which to instantiate an Action Controller

- access: public

void addParam (mixed $param)

- mixed $param

dispatch (line 145)

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

getDefaultAction (line 135)

Retrieve the default action name (minus formatting)

- access: public

string getDefaultAction ()
getDefaultController (line 120)

Retrieve the default controller name (minus formatting)

- access: public

string getDefaultController ()
getParams (line 90)

Retrieve the parameters to pass to the Action Controller constructor

- access: public

array getParams ()
getResponse (line 105)

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

setDefaultAction (line 128)

Set default action name (minus formatting)

- access: public

self setDefaultAction (string $action)

- string $action

setDefaultController (line 113)

Set default controller name (minus formatting)

- access: public

self setDefaultController (string $controller)

- string $controller

setParams (line 83)

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

- access: public

void setParams ( $params)

- array $params

setResponse (line 98)

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 Sun, 29 Oct 2006 21:27:58 -0600 by phpDocumentor 1.3.0RC6