ClassInterface 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
Methods
addControllerDirectory (line 145)

Add a controller directory to the controller directory stack

  • access: public
Zend_Controller_Dispatcher_Interface addControllerDirectory (string $path)
  • string $path
clearParams (line 122)

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 203)

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
formatActionName (line 70)

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 59)

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
formatModuleName (line 48)

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 class name prefix that a class extending Zend_Controller_Action would use.

  • access: public
string formatModuleName (string $unformatted)
  • string $unformatted
getControllerDirectory (line 163)

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

  • access: public
array getControllerDirectory ()
getDefaultAction (line 193)

Retrieve the default action name (minus formatting)

  • access: public
string getDefaultAction ()
getDefaultController (line 178)

Retrieve the default controller name (minus formatting)

  • access: public
string getDefaultController ()
getParam (line 103)

Retrieve a single parameter from the controller parameter stack

  • access: public
mixed getParam (string $name)
  • string $name
getParams (line 110)

Retrieve the parameters to pass to the Action Controller constructor

  • access: public
array getParams ()
getResponse (line 137)

Retrieve the response object, if any

  • access: public
Zend_Controller_Response_Abstract|null getResponse ()
isDispatchable (line 78)

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

  • access: public
boolean isDispatchable (Zend_Controller_Request_Abstract $request)
setControllerDirectory (line 156)

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
setDefaultAction (line 186)

Set default action name (minus formatting)

  • access: public
Zend_Controller_Dispatcher_Interface setDefaultAction (string $action)
  • string $action
setDefaultController (line 171)

Set default controller name (minus formatting)

  • access: public
Zend_Controller_Dispatcher_Interface setDefaultController (string $controller)
  • string $controller
setParam (line 87)

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 95)

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 130)

Set the response object to use, if any

  • access: public
void setResponse ([Zend_Controller_Response_Abstract $response = null])

Documentation generated on Thu, 18 Jan 2007 09:56:02 -0800 by phpDocumentor 1.3.1