Controller/Dispatcher/Abstract.php
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.
- 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: Abstract.php 24593 2012-01-05 20:35:02Z matthew $
\Zend_Controller_Dispatcher_Abstract
- Implements
- \Zend_Controller_Dispatcher_Interface
- Children
- \Zend_Controller_Dispatcher_Standard
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties


array $_invokeParams = array()
array()
Details- Type
- array


\Zend_Controller_Response_Abstract|null $_response = null
null
Details- Type
- \Zend_Controller_Response_Abstract | null
Methods


_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 |


addControllerDirectory(string $path, string $args = null) : \Zend_Controller_Dispatcher_Interface
Add a controller directory to the controller directory stack
Inherited from: \Zend_Controller_Dispatcher_Interface::addControllerDirectory()Name | Type | Description |
---|---|---|
$path | string | |
$args | string |
Type | Description |
---|---|
\Zend_Controller_Dispatcher_Interface |


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 |


dispatch(\Zend_Controller_Request_Abstract $request, \Zend_Controller_Response_Abstract $response) : void
Dispatches a request object to a controller/action.
Inherited from: \Zend_Controller_Dispatcher_Interface::dispatch()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 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 |


formatModuleName(string $unformatted) : string
Formats a string into a module name.
Inherited from: \Zend_Controller_Dispatcher_Interface::formatModuleName()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
Inherited from: \Zend_Controller_Dispatcher_Interface::getControllerDirectory()Type | Description |
---|---|
array |


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 |


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 |


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


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


setControllerDirectory( $path) : \Zend_Controller_Dispatcher_Interface
Set the directory where controller files are stored
Inherited from: \Zend_Controller_Dispatcher_Interface::setControllerDirectory()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 |


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 |