diff options
Diffstat (limited to 'library/vendor/Zend/Controller/Dispatcher/Interface.php')
| -rw-r--r-- | library/vendor/Zend/Controller/Dispatcher/Interface.php | 204 |
1 files changed, 204 insertions, 0 deletions
diff --git a/library/vendor/Zend/Controller/Dispatcher/Interface.php b/library/vendor/Zend/Controller/Dispatcher/Interface.php new file mode 100644 index 0000000..1f18df7 --- /dev/null +++ b/library/vendor/Zend/Controller/Dispatcher/Interface.php @@ -0,0 +1,204 @@ +<?php +/** + * 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. + * + * @category Zend + * @package Zend_Controller + * @subpackage Dispatcher + * @copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com) + * @license http://framework.zend.com/license/new-bsd New BSD License + * @version $Id$ + */ + +/** + * Zend_Controller_Request_Abstract + */ + +/** + * Zend_Controller_Response_Abstract + */ + +/** + * @package Zend_Controller + * @subpackage Dispatcher + * @copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com) + * @license http://framework.zend.com/license/new-bsd New BSD License + */ +interface Zend_Controller_Dispatcher_Interface +{ + /** + * 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. + * + * @param string $unformatted + * @return string + */ + public function formatControllerName($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. + * + * @param string $unformatted + * @return string + */ + public function formatModuleName($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. + * + * @param string $unformatted + * @return string + */ + public function formatActionName($unformatted); + + /** + * Returns TRUE if an action can be dispatched, or FALSE otherwise. + * + * @param Zend_Controller_Request_Abstract $request + * @return boolean + */ + public function isDispatchable(Zend_Controller_Request_Abstract $request); + + /** + * Add or modify a parameter with which to instantiate an Action Controller + * + * @param string $name + * @param mixed $value + * @return Zend_Controller_Dispatcher_Interface + */ + public function setParam($name, $value); + + /** + * Set an array of a parameters to pass to the Action Controller constructor + * + * @param array $params + * @return Zend_Controller_Dispatcher_Interface + */ + public function setParams(array $params); + + /** + * Retrieve a single parameter from the controller parameter stack + * + * @param string $name + * @return mixed + */ + public function getParam($name); + + /** + * Retrieve the parameters to pass to the Action Controller constructor + * + * @return array + */ + public function getParams(); + + /** + * 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. + * + * @param null|string|array single key or array of keys for params to clear + * @return Zend_Controller_Dispatcher_Interface + */ + public function clearParams($name = null); + + /** + * Set the response object to use, if any + * + * @param Zend_Controller_Response_Abstract|null $response + * @return void + */ + public function setResponse(Zend_Controller_Response_Abstract $response = null); + + /** + * Retrieve the response object, if any + * + * @return Zend_Controller_Response_Abstract|null + */ + public function getResponse(); + + /** + * Add a controller directory to the controller directory stack + * + * @param string $path + * @param string $args + * @return Zend_Controller_Dispatcher_Interface + */ + public function addControllerDirectory($path, $args = null); + + /** + * Set the directory where controller files are stored + * + * Specify a string or an array; if an array is specified, all paths will be + * added. + * + * @param string|array $dir + * @return Zend_Controller_Dispatcher_Interface + */ + public function setControllerDirectory($path); + + /** + * Return the currently set directory(ies) for controller file lookup + * + * @return array + */ + public function getControllerDirectory(); + + /** + * Dispatches a request object to a controller/action. If the action + * requests a forward to another action, a new request will be returned. + * + * @param Zend_Controller_Request_Abstract $request + * @param Zend_Controller_Response_Abstract $response + * @return void + */ + public function dispatch(Zend_Controller_Request_Abstract $request, Zend_Controller_Response_Abstract $response); + + /** + * Whether or not a given module is valid + * + * @param string $module + * @return boolean + */ + public function isValidModule($module); + + /** + * Retrieve the default module name + * + * @return string + */ + public function getDefaultModule(); + + /** + * Retrieve the default controller name + * + * @return string + */ + public function getDefaultControllerName(); + + /** + * Retrieve the default action + * + * @return string + */ + public function getDefaultAction(); +} |