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.

addControllerDirectory(
string $path, string $args
=
null
)
:
\Zend_Controller_Dispatcher_Interface
Add 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_Interface
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.
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
)
:
void
Dispatches 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
)
:
string
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.
Name | Type | Description |
---|---|---|
$unformatted | string |
Type | Description |
---|---|
string |

formatControllerName(
string $unformatted
)
:
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.
Name | Type | Description |
---|---|---|
$unformatted | string |
Type | Description |
---|---|
string |

formatModuleName(
string $unformatted
)
:
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.
Name | Type | Description |
---|---|---|
$unformatted | string |
Type | Description |
---|---|
string |

getControllerDirectory(
)
:
array
Return the currently set directory(ies) for controller file lookup
Type | Description |
---|---|
array |

getDefaultControllerName(
)
:
string
Retrieve the default controller name
Type | Description |
---|---|
string |

getParam(
string $name
)
:
mixed
Retrieve a single parameter from the controller parameter stack
Name | Type | Description |
---|---|---|
$name | string |
Type | Description |
---|---|
mixed |

getParams(
)
:
array
Retrieve the parameters to pass to the Action Controller constructor
Type | Description |
---|---|
array |

getResponse(
)
:
\Zend_Controller_Response_Abstract|null
Retrieve the response object, if any
Type | Description |
---|---|
\Zend_Controller_Response_Abstract|null |

isDispatchable(
\Zend_Controller_Request_Abstract $request
)
:
boolean
Returns TRUE if an action can be dispatched, or FALSE otherwise.
Name | Type | Description |
---|---|---|
$request | \Zend_Controller_Request_Abstract |
Type | Description |
---|---|
boolean |

isValidModule(
string $module
)
:
boolean
Whether or not a given module is valid
Name | Type | Description |
---|---|---|
$module | string |
Type | Description |
---|---|
boolean |

setControllerDirectory(
$path
)
:
\Zend_Controller_Dispatcher_Interface
Set 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_Interface
Add 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_Interface
Set 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
)
:
void
Set the response object to use, if any
Name | Type | Description |
---|---|---|
$response | \Zend_Controller_Response_Abstract|null |