d4bd2007c833b34f21892e276da7fdfccc2aa8dd
[Packages/TYPO3.CMS.git] / typo3 / sysext / extbase / Classes / MVC / Controller / ControllerInterface.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 2009 Jochen Rau <jochen.rau@typoplanet.de>
6 * All rights reserved
7 *
8 * This class is a backport of the corresponding class of FLOW3.
9 * All credits go to the v5 team.
10 *
11 * This script is part of the TYPO3 project. The TYPO3 project is
12 * free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or
15 * (at your option) any later version.
16 *
17 * The GNU General Public License can be found at
18 * http://www.gnu.org/copyleft/gpl.html.
19 *
20 * This script is distributed in the hope that it will be useful,
21 * but WITHOUT ANY WARRANTY; without even the implied warranty of
22 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 * GNU General Public License for more details.
24 *
25 * This copyright notice MUST APPEAR in all copies of the script!
26 ***************************************************************/
27
28 /**
29 * Interface for controllers
30 *
31 * @package Extbase
32 * @subpackage MVC\Controller
33 * @version $ID:$
34 * @api
35 */
36 interface Tx_Extbase_MVC_Controller_ControllerInterface {
37
38 /**
39 * Sets / injects the settings of the package this controller belongs to.
40 *
41 * Needed to emulate settings injection.
42 *
43 * @param array $settings Settings container of the current package
44 * @return void
45 */
46 public function injectSettings(array $settings);
47
48 /**
49 * Checks if the current request type is supported by the controller.
50 *
51 * @param Tx_Extbase_MVC_Request $request The current request
52 * @return boolean TRUE if this request type is supported, otherwise FALSE
53 * @api
54 */
55 public function canProcessRequest(Tx_Extbase_MVC_Request $request);
56
57 /**
58 * Processes a general request. The result can be returned by altering the given response.
59 *
60 * @param Tx_Extbase_MVC_Request $request The request object
61 * @param Tx_Extbase_MVC_Response $response The response, modified by the controller
62 * @return void
63 * @throws Tx_Extbase_MVC_Exception_UnsupportedRequestType if the controller doesn't support the current request type
64 * @api
65 */
66 public function processRequest(Tx_Extbase_MVC_Request $request, Tx_Extbase_MVC_Response $response);
67
68 }
69 ?>