[TASK] Re-work/simplify copyright header in PHP files - Part 1
[Packages/TYPO3.CMS.git] / typo3 / sysext / install / Classes / Configuration / PresetInterface.php
1 <?php
2 namespace TYPO3\CMS\Install\Configuration;
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\Core\Utility\GeneralUtility;
18
19 /**
20 * Preset interface
21 *
22 * A preset is a class for handling a specific configuration
23 * set of a feature.
24 */
25 interface PresetInterface {
26
27 /**
28 * Set POST values
29 *
30 * @param array $postValues Post values of feature
31 * @return mixed
32 */
33 public function setPostValues(array $postValues);
34
35 /**
36 * Check if preset is available on the system
37 *
38 * @return boolean TRUE if preset is available
39 */
40 public function isAvailable();
41
42 /**
43 * Wrapper for isAvailable, used in fluid
44 *
45 * @return boolean TRUE if preset is available
46 */
47 public function getIsAvailable();
48
49 /**
50 * Check is preset is currently active on the system
51 *
52 * @return boolean TRUE if preset is active
53 */
54 public function isActive();
55
56 /**
57 * Wrapper for isActive, used in fluid
58 *
59 * @return boolean TRUE if preset is active
60 */
61 public function getIsActive();
62
63 /**
64 * Get name of preset
65 *
66 * @return string Name
67 */
68 public function getName();
69
70 /**
71 * Get priority of preset
72 *
73 * @return integer Priority, usually between 0 and 100
74 */
75 public function getPriority();
76
77 /**
78 * Get configuration values to activate prefix
79 *
80 * @return array Configuration values needed to activate prefix
81 */
82 public function getConfigurationValues();
83 }