Zend Framework
LICENSE
This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

array
$_controllerDirectory= 'array()'
Controller directory(ies)
array()
Details
__construct(
array $params
=
array()
)
:
void
Constructor: Set current module to default value
Name | Type | Description |
---|---|---|
$params | array |

addControllerDirectory(
string $path, string $module
=
null
)
:
\Zend_Controller_Dispatcher_Standard
Add a single path to the controller directory stack
Name | Type | Description |
---|---|---|
$path | string | |
$module | string |
Type | Description |
---|---|
\Zend_Controller_Dispatcher_Standard |

classToFilename(
string $class
)
:
string
Convert a class name to a filename
Name | Type | Description |
---|---|---|
$class | string |
Type | Description |
---|---|
string |

dispatch(
\Zend_Controller_Request_Abstract $request, \Zend_Controller_Response_Abstract $response
)
:
void
Dispatch to a controller/action
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 {@link setParam()}.
Name | Type | Description |
---|---|---|
$request | \Zend_Controller_Request_Abstract | |
$response | \Zend_Controller_Response_Abstract |
Exception | Description |
---|---|
\Zend_Controller_Dispatcher_Exception |

formatClassName(
string $moduleName, string $className
)
:
string
Format action class name
Name | Type | Description |
---|---|---|
$moduleName | string | Name of the current module |
$className | string | Name of the action class |
Type | Description |
---|---|
string | Formatted class name |

formatModuleName(
string $unformatted
)
:
string
Format the module name.
Name | Type | Description |
---|---|---|
$unformatted | string |
Type | Description |
---|---|
string |

getActionMethod(
\Zend_Controller_Request_Abstract $request
)
:
string
Determine the action name
First attempt to retrieve from request; then from request params using action key; default to default action
Returns formatted action name
Name | Type | Description |
---|---|---|
$request | \Zend_Controller_Request_Abstract |
Type | Description |
---|---|
string |

getControllerClass(
\Zend_Controller_Request_Abstract $request
)
:
string|false
Get controller class name
Try request first; if not found, try pulling from request parameter; if still not found, fallback to default
Name | Type | Description |
---|---|---|
$request | \Zend_Controller_Request_Abstract |
Type | Description |
---|---|
string|false | Returns class name on success |

getControllerDirectory(
string $module
=
null
)
:
array|string
Return the currently set directories for Zend_Controller_Action class lookup
If a module is specified, returns just that directory.
Name | Type | Description |
---|---|---|
$module | string | Module name |
Type | Description |
---|---|
array|string | Returns array of all directories by default, single module directory if module argument provided |

getDefaultControllerClass(
\Zend_Controller_Request_Abstract $request
)
:
string
Retrieve default controller class
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.
Name | Type | Description |
---|---|---|
$request | \Zend_Controller_Request_Abstract |
Type | Description |
---|---|
string |

getDispatchDirectory(
)
:
string
Return the value of the currently selected dispatch directory (as set by {@link getController()})
Type | Description |
---|---|
string |

isDispatchable(
$request
)
:
boolean
Returns TRUE if the Zend_Controller_Request_Abstract object can be dispatched to a controller.
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.
Name | Type | Description |
---|---|---|
$request |
Type | Description |
---|---|
boolean |

isValidModule(
string $module
)
:
bool
Determine if a given module is valid
Name | Type | Description |
---|---|---|
$module | string |
Type | Description |
---|---|
bool |

loadClass(
string $className
)
:
string
Load a controller class
Attempts to load the controller class file from {@link getControllerDirectory()}. If the controller belongs to a module, looks for the module prefix to the controller class.
Name | Type | Description |
---|---|---|
$className | string |
Type | Description |
---|---|
string | Class name loaded |
Exception | Description |
---|---|
\Zend_Controller_Dispatcher_Exception | if class not loaded |

removeControllerDirectory(
string $module
)
:
bool
Remove a controller directory by module name
Name | Type | Description |
---|---|---|
$module | string |
Type | Description |
---|---|
bool |

setControllerDirectory(
array|string $directory, $module
=
null
)
:
\Zend_Controller_Dispatcher_Standard
Set controller directory
Name | Type | Description |
---|---|---|
$directory | array|string | |
$module |
Type | Description |
---|---|
\Zend_Controller_Dispatcher_Standard |