ClassInterface Zend_Controller_Dispatcher_Interface

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

Located in /Controller/Dispatcher/Interface.php (line 39)


	
			
Method Summary
 Zend_Controller_Dispatcher_Interface addControllerDirectory (string $path, [string $args = null])
 Zend_Controller_Dispatcher_Interface clearParams ([null|string|array $name = null])
 string formatActionName (string $unformatted)
 string formatControllerName (string $unformatted)
 string formatModuleName (string $unformatted)
 string getDefaultAction ()
 string getDefaultModule ()
 mixed getParam (string $name)
 array getParams ()
 boolean isValidModule (string $module)
 Zend_Controller_Dispatcher_Interface setParam (string $name, mixed $value)
 void setResponse ([Zend_Controller_Response_Abstract $response = null])
Methods
addControllerDirectory (line 148)

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

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

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

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

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

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.

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

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

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

Retrieve the default action

  • access: public
string getDefaultAction ()
getDefaultControllerName (line 198)

Retrieve the default controller name

  • access: public
string getDefaultControllerName ()
getDefaultModule (line 191)

Retrieve the default module name

  • access: public
string getDefaultModule ()
getParam (line 105)

Retrieve a single parameter from the controller parameter stack

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

Retrieve the parameters to pass to the Action Controller constructor

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

Retrieve the response object, if any

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

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

  • access: public
boolean isDispatchable (Zend_Controller_Request_Abstract $request)
isValidModule (line 184)

Whether or not a given module is valid

  • access: public
boolean isValidModule (string $module)
  • string $module
setControllerDirectory (line 159)

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

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

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

Set the response object to use, if any

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

Documentation generated on Mon, 21 Jun 2010 15:29:36 -0400 by phpDocumentor 1.4.3