[!!!][TASK] Rewrite install tool
[Packages/TYPO3.CMS.git] / typo3 / sysext / install / Classes / Controller / Action / ActionInterface.php
1 <?php
2 namespace TYPO3\CMS\Install\Controller\Action;
3
4 /***************************************************************
5 * Copyright notice
6 *
7 * (c) 2013 Christian Kuhn <lolli@schwarzbu.ch>
8 * All rights reserved
9 *
10 * This script is part of the TYPO3 project. The TYPO3 project is
11 * free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
15 *
16 * The GNU General Public License can be found at
17 * http://www.gnu.org/copyleft/gpl.html.
18 *
19 * This script is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 * GNU General Public License for more details.
23 *
24 * This copyright notice MUST APPEAR in all copies of the script!
25 ***************************************************************/
26
27 /**
28 * General action interface
29 */
30 interface ActionInterface {
31
32 /**
33 * Handle this action
34 *
35 * @return string rendered content
36 */
37 public function handle();
38
39 /**
40 * Set form protection token
41 *
42 * @param string $token Form protection token
43 * @return void
44 */
45 public function setToken($token);
46
47 /**
48 * Set controller, Either string 'step', 'tool' or 'common'
49 *
50 * @param string $controller Controller name
51 * @return void
52 */
53 public function setController($controller);
54
55 /**
56 * Set action name. This is usually similar to the class name,
57 * only for loginForm, the action is login
58 *
59 * @param string $action Name of target action for forms
60 * @return void
61 */
62 public function setAction($action);
63
64 /**
65 * Set POST values
66 *
67 * @param array $postValues List of values submitted via POST
68 * @return void
69 */
70 public function setPostValues(array $postValues);
71
72 /**
73 * Status messages from controller
74 *
75 * @param array<\TYPO3\CMS\Install\Status\StatusInterface> $messages
76 */
77 public function setMessages(array $messages = array());
78 }
79 ?>