package Zend_Controller
subpackage Dispatcher
copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
license New BSD License

 Methods

Add a controller directory to the controller directory stack

addControllerDirectory(string $path, string $args = null) : \Zend_Controller_Dispatcher_Interface

Parameters

$path

string

$args

string

Returns

\Zend_Controller_Dispatcher_Interface

Clear the controller parameter stack

clearParams($name = null) : \Zend_Controller_Dispatcher_Interface

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.

Parameters

$name

Returns

\Zend_Controller_Dispatcher_Interface

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

dispatch(\Zend_Controller_Request_Abstract $request, \Zend_Controller_Response_Abstract $response) : void

Parameters

$request

\Zend_Controller_Request_Abstract

$response

\Zend_Controller_Response_Abstract

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.

formatActionName(string $unformatted) : string

Parameters

$unformatted

string

Returns

string

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.

formatControllerName(string $unformatted) : string

Parameters

$unformatted

string

Returns

string

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.

formatModuleName(string $unformatted) : string

Parameters

$unformatted

string

Returns

string

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

getControllerDirectory() : array

Returns

array

Retrieve the default action

getDefaultAction() : string

Returns

string

Retrieve the default controller name

getDefaultControllerName() : string

Returns

string

Retrieve the default module name

getDefaultModule() : string

Returns

string

Retrieve a single parameter from the controller parameter stack

getParam(string $name) : mixed

Parameters

$name

string

Returns

mixed

Retrieve the parameters to pass to the Action Controller constructor

getParams() : array

Returns

array

Retrieve the response object, if any

getResponse() : \Zend_Controller_Response_Abstract | null

Returns

\Zend_Controller_Response_Abstractnull

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

isDispatchable(\Zend_Controller_Request_Abstract $request) : boolean

Parameters

$request

\Zend_Controller_Request_Abstract

Returns

boolean

Whether or not a given module is valid

isValidModule(string $module) : boolean

Parameters

$module

string

Returns

boolean

Set the directory where controller files are stored

setControllerDirectory($path) : \Zend_Controller_Dispatcher_Interface

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

Parameters

$path

Returns

\Zend_Controller_Dispatcher_Interface

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

setParam(string $name, mixed $value) : \Zend_Controller_Dispatcher_Interface

Parameters

$name

string

$value

mixed

Returns

\Zend_Controller_Dispatcher_Interface

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

setParams(array $params) : \Zend_Controller_Dispatcher_Interface

Parameters

$params

array

Returns

\Zend_Controller_Dispatcher_Interface

Set the response object to use, if any

setResponse(\Zend_Controller_Response_Abstract|null $response = null) : void

Parameters

$response

\Zend_Controller_Response_Abstractnull