[TASK][WIP] Move non class code back to source files
[Packages/TYPO3.CMS.git] / typo3 / sysext / extbase / Classes / Mvc / RequestHandlerInterface.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 2010 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 * The interface for a request handler
29 *
30 * @api
31 */
32 interface Tx_Extbase_MVC_RequestHandlerInterface
33 {
34 /**
35 * Handles a raw request and returns the respsonse.
36 *
37 * @return Tx_Extbase_MVC_ResponseInterface
38 * @api
39 */
40 public function handleRequest();
41
42 /**
43 * Checks if the request handler can handle the current request.
44 *
45 * @return boolean TRUE if it can handle the request, otherwise FALSE
46 * @api
47 */
48 public function canHandleRequest();
49
50 /**
51 * Returns the priority - how eager the handler is to actually handle the
52 * request. An integer > 0 means "I want to handle this request" where
53 * "100" is default. "0" means "I am a fallback solution".
54 *
55 * @return integer The priority of the request handler
56 * @api
57 */
58 public function getPriority();
59
60 }
61 ?>