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
$_invokeParams= 'array()'
Array of invocation parameters to use when instantiating action controllers
array()
Details
\Zend_Controller_Response_Abstract|null
$_response= 'null'
Response object to pass to action controllers, if any

_formatName(
string $unformatted, boolean $isAction
=
false
)
:
string
Formats a string from a URI into a PHP-friendly name.
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.
Name | Type | Description |
---|---|---|
$unformatted | string | |
$isAction | boolean | Defaults to false |
Type | Description |
---|---|
string |

_verifyDelimiter(
string|array $spec
)
:
array
Verify delimiter
Verify a delimiter to use in controllers or actions. May be a single string or an array of strings.
Name | Type | Description |
---|---|---|
$spec | string|array |
Type | Description |
---|---|
array |
Exception | Description |
---|---|
\Zend_Controller_Dispatcher_Exception | with invalid delimiters |

clearParams(
null|string|array $name
=
null
)
:
\Zend_Controller_Dispatcher_Abstract
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_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 stored inside a Zend_Controller_Request_Abstract 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 stored inside a Zend_Controller_Request_Abstract 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 |

getDefaultAction(
)
:
string
Retrieve the default action name (minus formatting)
Type | Description |
---|---|
string |

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

getFrontController(
)
:
\Zend_Controller_Front
Retrieve front controller instance
Type | Description |
---|---|
\Zend_Controller_Front |

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

getParams(
)
:
array
Retrieve action controller instantiation parameters
Type | Description |
---|---|
array |

getPathDelimiter(
)
:
array
Retrieve the path delimiter character(s) used in controller names
Type | Description |
---|---|
array |

getResponse(
)
:
\Zend_Controller_Response_Abstract|null
Return the registered response object
Type | Description |
---|---|
\Zend_Controller_Response_Abstract|null |

getWordDelimiter(
)
:
array
Retrieve the word delimiter character(s) used in controller or action names
Type | Description |
---|---|
array |

setDefaultAction(
string $action
)
:
\Zend_Controller_Dispatcher_Abstract
Set the default action (minus any formatting)
Name | Type | Description |
---|---|---|
$action | string |
Type | Description |
---|---|
\Zend_Controller_Dispatcher_Abstract |

setDefaultControllerName(
string $controller
)
:
\Zend_Controller_Dispatcher_Abstract
Set the default controller (minus any formatting)
Name | Type | Description |
---|---|---|
$controller | string |
Type | Description |
---|---|
\Zend_Controller_Dispatcher_Abstract |

setDefaultModule(
string $module
)
:
\Zend_Controller_Dispatcher_Abstract
Set the default module
Name | Type | Description |
---|---|---|
$module | string |
Type | Description |
---|---|
\Zend_Controller_Dispatcher_Abstract |

setFrontController(
\Zend_Controller_Front $controller
)
:
\Zend_Controller_Dispatcher_Abstract
Set front controller instance
Name | Type | Description |
---|---|---|
$controller | \Zend_Controller_Front |
Type | Description |
---|---|
\Zend_Controller_Dispatcher_Abstract |

setParam(
string $name, mixed $value
)
:
\Zend_Controller_Dispatcher_Abstract
Add or modify a parameter to use when instantiating an action controller
Name | Type | Description |
---|---|---|
$name | string | |
$value | mixed |
Type | Description |
---|---|
\Zend_Controller_Dispatcher_Abstract |

setParams(
array $params
)
:
\Zend_Controller_Dispatcher_Abstract
Set parameters to pass to action controller constructors
Name | Type | Description |
---|---|---|
$params | array |
Type | Description |
---|---|
\Zend_Controller_Dispatcher_Abstract |

setPathDelimiter(
string $spec
)
:
\Zend_Controller_Dispatcher_Abstract
Set path delimiter
Set the path delimiter to use in controllers. May be a single string or an array of strings.
Name | Type | Description |
---|---|---|
$spec | string |
Type | Description |
---|---|
\Zend_Controller_Dispatcher_Abstract |

setResponse(
\Zend_Controller_Response_Abstract|null $response
=
null
)
:
\Zend_Controller_Dispatcher_Abstract
Set response object to pass to action controllers
Name | Type | Description |
---|---|---|
$response | \Zend_Controller_Response_Abstract|null |
Type | Description |
---|---|
\Zend_Controller_Dispatcher_Abstract |

setWordDelimiter(
string|array $spec
)
:
\Zend_Controller_Dispatcher_Abstract
Set word delimiter
Set the word delimiter to use in controllers and actions. May be a single string or an array of strings.
Name | Type | Description |
---|---|---|
$spec | string|array |
Type | Description |
---|---|
\Zend_Controller_Dispatcher_Abstract |