| category | Zend |
|---|---|
| package | Zend_Controller |
| subpackage | Dispatcher |
| copyright | Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com) |
| license | New BSD License |
| inherited_from | \Zend_Controller_Dispatcher_Abstract |
__construct(array $params = array()) : void
| inherited_from | \Zend_Controller_Dispatcher_Abstract::__construct() |
|---|
array
__construct(array $params = array()) : void
_verifyDelimiter(string|array $spec) : array
Verify a delimiter to use in controllers or actions. May be a single string or an array of strings.
stringarray
\Zend_Controller_Dispatcher_Exception |
with invalid delimiters |
|---|
arrayaddControllerDirectory(string $path, string $module = null) : \Zend_Controller_Dispatcher_Standard
string
string
\Zend_Controller_Dispatcher_StandardclassToFilename(string $class) : string
string
stringclearParams($name = null) : \Zend_Controller_Dispatcher_Abstract
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.
| inherited_from | \Zend_Controller_Dispatcher_Interface::clearParams() |
|---|
\Zend_Controller_Dispatcher_Abstractdispatch(\Zend_Controller_Request_Abstract $request, \Zend_Controller_Response_Abstract $response) : void
By default, if a controller is not dispatchable, dispatch() will throw an exception. If you wish to use the default controller instead, set the param 'useDefaultControllerAlways' via \setParam().
\Zend_Controller_Request_Abstract
\Zend_Controller_Response_Abstract
\Zend_Controller_Dispatcher_Exception |
|---|
formatActionName(string $unformatted) : string
| inherited_from | \Zend_Controller_Dispatcher_Interface::formatActionName() |
|---|
string
stringformatClassName(string $moduleName, string $className) : string
stringName of the current module
stringName of the action class
stringFormatted class nameformatControllerName(string $unformatted) : string
| inherited_from | \Zend_Controller_Dispatcher_Interface::formatControllerName() |
|---|
string
stringformatModuleName(string $unformatted) : string
string
stringgetActionMethod(\Zend_Controller_Request_Abstract $request) : string
First attempt to retrieve from request; then from request params using action key; default to default action
Returns formatted action name
\Zend_Controller_Request_Abstract
stringgetControllerClass(\Zend_Controller_Request_Abstract $request) : string | false
Try request first; if not found, try pulling from request parameter; if still not found, fallback to default
\Zend_Controller_Request_Abstract
stringfalseReturns class name on successgetControllerDirectory(string $module = null) : array | string
If a module is specified, returns just that directory.
stringModule name
arraystringReturns array of all directories by default, single
module directory if module argument providedgetDefaultAction() : string
| inherited_from | \Zend_Controller_Dispatcher_Interface::getDefaultAction() |
|---|
stringgetDefaultControllerClass(\Zend_Controller_Request_Abstract $request) : string
Determines whether the default controller to use lies within the requested module, or if the global default should be used.
By default, will only use the module default unless that controller does not exist; if this is the case, it falls back to the default controller in the default module.
\Zend_Controller_Request_Abstract
stringgetDefaultControllerName() : string
| inherited_from | \Zend_Controller_Dispatcher_Interface::getDefaultControllerName() |
|---|
stringgetDefaultModule() : string
| inherited_from | \Zend_Controller_Dispatcher_Interface::getDefaultModule() |
|---|
stringgetDispatchDirectory() : string
stringgetFrontController() : \Zend_Controller_Front
\Zend_Controller_FrontgetParam(string $name) : mixed
| inherited_from | \Zend_Controller_Dispatcher_Interface::getParam() |
|---|
string
mixedgetParams() : array
| inherited_from | \Zend_Controller_Dispatcher_Interface::getParams() |
|---|
arraygetPathDelimiter() : array
arraygetResponse() : \Zend_Controller_Response_Abstract | null
| inherited_from | \Zend_Controller_Dispatcher_Interface::getResponse() |
|---|
\Zend_Controller_Response_Abstractnull
getWordDelimiter() : array
arrayisDispatchable(\Zend_Controller_Request_Abstract $request) : boolean
Use this method wisely. By default, the dispatcher will fall back to the default controller (either in the module specified or the global default) if a given controller does not exist. This method returning false does not necessarily indicate the dispatcher will not still dispatch the call.
booleanisValidModule(string $module) : boolean
string
booleanloadClass(string $className) : string
Attempts to load the controller class file from \getControllerDirectory(). If the controller belongs to a module, looks for the module prefix to the controller class.
string
\Zend_Controller_Dispatcher_Exception |
if class not loaded |
|---|
stringClass name loadedremoveControllerDirectory(string $module) : boolean
string
booleansetControllerDirectory(array|string $directory, $module = null) : \Zend_Controller_Dispatcher_Standard
arraystring
\Zend_Controller_Dispatcher_StandardsetDefaultAction(string $action) : \Zend_Controller_Dispatcher_Abstract
string
\Zend_Controller_Dispatcher_AbstractsetDefaultControllerName(string $controller) : \Zend_Controller_Dispatcher_Abstract
string
\Zend_Controller_Dispatcher_AbstractsetDefaultModule(string $module) : \Zend_Controller_Dispatcher_Abstract
string
\Zend_Controller_Dispatcher_AbstractsetFrontController(\Zend_Controller_Front $controller) : \Zend_Controller_Dispatcher_Abstract
\Zend_Controller_Front
\Zend_Controller_Dispatcher_AbstractsetParam(string $name, mixed $value) : \Zend_Controller_Dispatcher_Abstract
| inherited_from | \Zend_Controller_Dispatcher_Interface::setParam() |
|---|
string
mixed
\Zend_Controller_Dispatcher_AbstractsetParams(array $params) : \Zend_Controller_Dispatcher_Abstract
| inherited_from | \Zend_Controller_Dispatcher_Interface::setParams() |
|---|
array
\Zend_Controller_Dispatcher_AbstractsetPathDelimiter(string $spec) : \Zend_Controller_Dispatcher_Abstract
Set the path delimiter to use in controllers. May be a single string or an array of strings.
string
\Zend_Controller_Dispatcher_AbstractsetResponse(\Zend_Controller_Response_Abstract|null $response = null) : \Zend_Controller_Dispatcher_Abstract
| inherited_from | \Zend_Controller_Dispatcher_Interface::setResponse() |
|---|
\Zend_Controller_Response_Abstractnull
\Zend_Controller_Dispatcher_AbstractsetWordDelimiter(string|array $spec) : \Zend_Controller_Dispatcher_Abstract
Set the word delimiter to use in controllers and actions. May be a single string or an array of strings.
stringarray
\Zend_Controller_Dispatcher_Abstract_formatName(string $unformatted, boolean $isAction = false) : string
By default, replaces words separated by the word separator character(s) with camelCaps. If $isAction is false, it also preserves replaces words separated by the path separation character with an underscore, making the following word Title cased. All non-alphanumeric characters are removed.
string
booleanDefaults to false
string$_controllerDirectory : array
array()$_curDirectory : string
$_curModule : string
$_defaultAction : string
'index'$_defaultController : string
'index'$_defaultModule : string
'default'$_frontController : \Zend_Controller_Front
$_invokeParams : array
array()$_pathDelimiter : string
'_'$_response : \Zend_Controller_Response_Abstract | null
null$_wordDelimiter : array
array('-', '.')