Zend Framework
1.12
|
Public Member Functions | |
formatControllerName ($unformatted) | |
Formats a string into a controller name. | |
formatModuleName ($unformatted) | |
Formats a string into a module name. | |
formatActionName ($unformatted) | |
Formats a string into an action name. | |
isDispatchable (Zend_Controller_Request_Abstract $request) | |
Returns TRUE if an action can be dispatched, or FALSE otherwise. | |
setParam ($name, $value) | |
Add or modify a parameter with which to instantiate an Action Controller. | |
setParams (array $params) | |
Set an array of a parameters to pass to the Action Controller constructor. | |
getParam ($name) | |
Retrieve a single parameter from the controller parameter stack. | |
getParams () | |
Retrieve the parameters to pass to the Action Controller constructor. | |
clearParams ($name=null) | |
Clear the controller parameter stack. | |
setResponse (Zend_Controller_Response_Abstract $response=null) | |
Set the response object to use, if any. | |
getResponse () | |
Retrieve the response object, if any. | |
addControllerDirectory ($path, $args=null) | |
Add a controller directory to the controller directory stack. | |
setControllerDirectory ($path) | |
Set the directory where controller files are stored. | |
getControllerDirectory () | |
Return the currently set directory(ies) for controller file lookup. | |
dispatch (Zend_Controller_Request_Abstract $request, Zend_Controller_Response_Abstract $response) | |
Dispatches a request object to a controller/action. | |
isValidModule ($module) | |
Whether or not a given module is valid. | |
getDefaultModule () | |
Retrieve the default module name. | |
getDefaultControllerName () | |
Retrieve the default controller name. | |
getDefaultAction () | |
Retrieve the default action. | |
addControllerDirectory | ( | $path, | |
$args = null |
|||
) |
Add a controller directory to the controller directory stack.
string | $path | |
string | $args |
Implemented in Zend_Controller_Dispatcher_Standard.
clearParams | ( | $name = null | ) |
Clear 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.
null|string|array | single key or array of keys for params to clear |
Implemented in Zend_Controller_Dispatcher_Abstract.
dispatch | ( | Zend_Controller_Request_Abstract | $request, |
Zend_Controller_Response_Abstract | $response | ||
) |
Dispatches a request object to a controller/action.
If the action requests a forward to another action, a new request will be returned.
Zend_Controller_Request_Abstract | $request | |
Zend_Controller_Response_Abstract | $response |
Implemented in Zend_Controller_Dispatcher_Standard.
formatActionName | ( | $unformatted | ) |
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.
string | $unformatted |
Implemented in Zend_Controller_Dispatcher_Abstract.
formatControllerName | ( | $unformatted | ) |
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.
string | $unformatted |
Implemented in Zend_Controller_Dispatcher_Abstract.
formatModuleName | ( | $unformatted | ) |
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.
string | $unformatted |
Implemented in Zend_Controller_Dispatcher_Standard.
getControllerDirectory | ( | ) |
Return the currently set directory(ies) for controller file lookup.
getDefaultAction | ( | ) |
getDefaultControllerName | ( | ) |
Retrieve the default controller name.
Implemented in Zend_Controller_Dispatcher_Abstract.
getDefaultModule | ( | ) |
getParam | ( | $name | ) |
Retrieve a single parameter from the controller parameter stack.
string | $name |
Implemented in Zend_Controller_Dispatcher_Abstract.
getParams | ( | ) |
Retrieve the parameters to pass to the Action Controller constructor.
Implemented in Zend_Controller_Dispatcher_Abstract.
getResponse | ( | ) |
Retrieve the response object, if any.
Implemented in Zend_Controller_Dispatcher_Abstract.
isDispatchable | ( | Zend_Controller_Request_Abstract | $request | ) |
Returns TRUE if an action can be dispatched, or FALSE otherwise.
Zend_Controller_Request_Abstract | $request |
Implemented in Zend_Controller_Dispatcher_Standard.
isValidModule | ( | $module | ) |
Whether or not a given module is valid.
string | $module |
Implemented in Zend_Controller_Dispatcher_Standard.
setControllerDirectory | ( | $path | ) |
Set the directory where controller files are stored.
Specify a string or an array; if an array is specified, all paths will be added.
string | array | $dir |
setParam | ( | $name, | |
$value | |||
) |
Add or modify a parameter with which to instantiate an Action Controller.
string | $name | |
mixed | $value |
Implemented in Zend_Controller_Dispatcher_Abstract.
setParams | ( | array | $params | ) |
Set an array of a parameters to pass to the Action Controller constructor.
array | $params |
Implemented in Zend_Controller_Dispatcher_Abstract.
setResponse | ( | Zend_Controller_Response_Abstract | $response = null | ) |
Set the response object to use, if any.
Zend_Controller_Response_Abstract | null | $response |
Implemented in Zend_Controller_Dispatcher_Abstract.