Controller/Dispatcher/Interface.php
inherited
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 [email protected] so we can send you a copy immediately.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Controller
- Subpackage
- Dispatcher
- Version
- $Id: Interface.php 24593 2012-01-05 20:35:02Z matthew $
\Zend_Controller_Dispatcher_Interface
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Methods
addControllerDirectory(string $path, string $args = null) : \Zend_Controller_Dispatcher_InterfaceAdd a controller directory to the controller directory stack
| Name | Type | Description |
|---|---|---|
| $path | string | |
| $args | string |
| Type | Description |
|---|---|
| \Zend_Controller_Dispatcher_Interface |
clearParams(null | string | array $name = null) : \Zend_Controller_Dispatcher_InterfaceClear 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.
| Name | Type | Description |
|---|---|---|
| $name | null | string | array | single key or array of keys for params to clear |
| Type | Description |
|---|---|
| \Zend_Controller_Dispatcher_Interface |
dispatch(\Zend_Controller_Request_Abstract $request, \Zend_Controller_Response_Abstract $response) : voidDispatches a request object to a controller/action.
If the action requests a forward to another action, a new request will be returned.
| Name | Type | Description |
|---|---|---|
| $request | \Zend_Controller_Request_Abstract | |
| $response | \Zend_Controller_Response_Abstract |
formatActionName(string $unformatted) : stringFormats 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.
| Name | Type | Description |
|---|---|---|
| $unformatted | string |
| Type | Description |
|---|---|
| string |
formatControllerName(string $unformatted) : stringFormats 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.
| Name | Type | Description |
|---|---|---|
| $unformatted | string |
| Type | Description |
|---|---|
| string |
formatModuleName(string $unformatted) : stringFormats 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.
| Name | Type | Description |
|---|---|---|
| $unformatted | string |
| Type | Description |
|---|---|
| string |
getControllerDirectory() : arrayReturn the currently set directory(ies) for controller file lookup
| Type | Description |
|---|---|
| array |
getDefaultAction() : stringRetrieve the default action
| Type | Description |
|---|---|
| string |
getDefaultControllerName() : stringRetrieve the default controller name
| Type | Description |
|---|---|
| string |
getDefaultModule() : stringRetrieve the default module name
| Type | Description |
|---|---|
| string |
getParam(string $name) : mixedRetrieve a single parameter from the controller parameter stack
| Name | Type | Description |
|---|---|---|
| $name | string |
| Type | Description |
|---|---|
| mixed |
getParams() : arrayRetrieve the parameters to pass to the Action Controller constructor
| Type | Description |
|---|---|
| array |
getResponse() : \Zend_Controller_Response_Abstract | nullRetrieve the response object, if any
| Type | Description |
|---|---|
| \Zend_Controller_Response_Abstract | null |
isDispatchable(\Zend_Controller_Request_Abstract $request) : booleanReturns TRUE if an action can be dispatched, or FALSE otherwise.
| Name | Type | Description |
|---|---|---|
| $request | \Zend_Controller_Request_Abstract |
| Type | Description |
|---|---|
| boolean |
isValidModule(string $module) : booleanWhether or not a given module is valid
| Name | Type | Description |
|---|---|---|
| $module | string |
| Type | Description |
|---|---|
| boolean |
setControllerDirectory( $path) : \Zend_Controller_Dispatcher_InterfaceSet the directory where controller files are stored
Specify a string or an array; if an array is specified, all paths will be added.
| Name | Type | Description |
|---|---|---|
| $path |
| Type | Description |
|---|---|
| \Zend_Controller_Dispatcher_Interface |
setParam(string $name, mixed $value) : \Zend_Controller_Dispatcher_InterfaceAdd or modify a parameter with which to instantiate an Action Controller
| Name | Type | Description |
|---|---|---|
| $name | string | |
| $value | mixed |
| Type | Description |
|---|---|
| \Zend_Controller_Dispatcher_Interface |
setParams(array $params) : \Zend_Controller_Dispatcher_InterfaceSet an array of a parameters to pass to the Action Controller constructor
| Name | Type | Description |
|---|---|---|
| $params | array |
| Type | Description |
|---|---|
| \Zend_Controller_Dispatcher_Interface |
setResponse(\Zend_Controller_Response_Abstract | null $response = null) : voidSet the response object to use, if any
| Name | Type | Description |
|---|---|---|
| $response | \Zend_Controller_Response_Abstract | null |