Class Zend_Controller_Front

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

Located in /Zend/Controller/Front.php (line 43)


	
			
Variable Summary
Method Summary
static void run (string $controllerDirectory)
Zend_Controller_Front __construct ()
void addParam (mixed $param)
string getDefaultAction ()
Zend_Controller_DispatcherInteface getDispatcher ()
array getParams ()
self setControllerDirectory (string $directory)
self setDefaultAction (string $action)
self setDefaultController (string $controller)
self setParams ( $params)
Variables
array $_invokeParams = array() (line 80)

Array of invocation parameters to use when instantiating action

controllers

  • access: protected
Methods
static method run (line 97)

Convenience feature, calls setControllerDirectory()->setRouter()->dispatch()

  • access: public
static void run (string $controllerDirectory)
  • string $controllerDirectory
Constructor __construct (line 87)

Constructor

Instantiate the plugin broker.

  • access: public
Zend_Controller_Front __construct ()
addParam (line 332)

Add a parameter to use when instantiating an action controller

  • access: public
void addParam (mixed $param)
  • mixed $param
dispatch (line 390)

Dispatch an HTTP request to a controller/action.

  • access: public
getControllerDirectory (line 128)

Convenience method, passthru to Zend_Controller_Dispatcher::getControllerDirectory()

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

Retrieve the default action (unformatted string)

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

Retrieve the default controller (unformatted string)

  • access: public
string getDefaultController ()
getDispatcher (line 277)

Return the dispatcher object.

  • access: public
Zend_Controller_DispatcherInteface getDispatcher ()
getParams (line 354)

Retrieve action controller instantiation parameters

  • access: public
array getParams ()
getRequest (line 214)

Return the request object.

  • access: public
getResponse (line 321)

Return the response object.

  • access: public
null|Zend_Controller_Response_Abstract getResponse ()
getRouter (line 253)

Return the router object.

  • access: public
registerPlugin (line 365)

Register a plugin.

  • access: public
self registerPlugin (Zend_Controller_Plugin_Abstract $plugin)
setControllerDirectory (line 113)

Convenience method, passthru to Zend_Controller_Dispatcher::setControllerDirectory()

  • access: public
self setControllerDirectory (string $directory)
  • string $directory
setDefaultAction (line 166)

Set the default action (unformatted string)

  • access: public
self setDefaultAction (string $action)
  • string $action
setDefaultController (line 143)

Set the default controller (unformatted string)

  • access: public
self setDefaultController (string $controller)
  • string $controller
setDispatcher (line 266)

Set the dispatcher object. The dispatcher is responsible for taking a Zend_Controller_Dispatcher_Token object, instantiating the controller, and call the action method of the controller.

  • access: public
self setDispatcher (Zend_Controller_Dispatcher_Interface $dispatcher)
setParams (line 343)

Set parameters to pass to action controller constructors

  • access: public
self setParams ( $params)
  • array $params
setRequest (line 194)

Set request class/object

Set the request object. The request holds the request environment.

If a class name is provided, it will instantiate it

  • access: public
  • throws: Zend_Controller_Front_Exception if invalid request class
self setRequest (string|Zend_Controller_Request_Abstract $request)
setResponse (line 301)

Set response class/object

Set the response object. The response is a container for action responses and headers. Usage is optional.

If a class name is provided, instantiates a response object.

  • access: public
  • throws: Zend_Controller_Front_Exception if invalid response class
self setResponse (string|Zend_Controller_Response_Abstract $response)
setRouter (line 232)

Set router class/object

Set the router object. The router is responsible for mapping the request to a controller and action.

If a class name is provided, instantiates router with any parameters registered via addParam() or setParams().

  • access: public
  • throws: Zend_Controller_Front_Exception if invalid router class
self setRouter (string|Zend_Controller_Router_Interface $router)
unregisterPlugin (line 377)

Unregister a plugin.

  • access: public
self unregisterPlugin (Zend_Controller_Plugin_Abstract $plugin)

Documentation generated on Sun, 29 Oct 2006 21:27:56 -0600 by phpDocumentor 1.3.0RC6