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