[TASK] Re-work/simplify copyright header in PHP files - Part 2
[Packages/TYPO3.CMS.git] / typo3 / sysext / install / Classes / Controller / Action / Step / StepInterface.php
1 <?php
2 namespace TYPO3\CMS\Install\Controller\Action\Step;
3
4 /**
5 * This file is part of the TYPO3 CMS project.
6 *
7 * It is free software; you can redistribute it and/or modify it under
8 * the terms of the GNU General Public License, either version 2
9 * of the License, or any later version.
10 *
11 * For the full copyright and license information, please read the
12 * LICENSE.txt file that was distributed with this source code.
13 *
14 * The TYPO3 project - inspiring people to share!
15 */
16
17 use TYPO3\CMS\Install\Controller\Action;
18
19 /**
20 * Interface implemented by single steps
21 */
22 interface StepInterface {
23 /**
24 * Execute a step
25 *
26 * @return array<\TYPO3\CMS\Install\Status\StatusInterface>
27 */
28 public function execute();
29
30 /**
31 * Whether this step must be executed
32 *
33 * @return boolean TRUE if this step needs to be executed
34 */
35 public function needsExecution();
36
37 /**
38 * Tell the action which position it has in the list of actions
39 *
40 * @param int $current The current position
41 * @param int $total The total number of steps
42 * @return void
43 */
44 public function setStepsCounter($current, $total);
45
46 /**
47 * Gets current position
48 *
49 * @return int
50 */
51 public function getCurrentStep();
52
53 /**
54 * Gets total steps
55 *
56 * @return int
57 */
58 public function getTotalSteps();
59 }