[CLEANUP] Adjust code to coding guidelines
[Packages/TYPO3.CMS.git] / typo3 / sysext / extbase / Classes / Configuration / ConfigurationManagerInterface.php
1 <?php
2 namespace TYPO3\CMS\Extbase\Configuration;
3
4 /***************************************************************
5 * Copyright notice
6 *
7 * (c) 2010-2012 Extbase Team (http://forge.typo3.org/projects/typo3v4-mvc)
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 * A copy is found in the textfile GPL.txt and important notices to the license
19 * from the author is found in LICENSE.txt distributed with these scripts.
20 *
21 *
22 * This script is distributed in the hope that it will be useful,
23 * but WITHOUT ANY WARRANTY; without even the implied warranty of
24 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25 * GNU General Public License for more details.
26 *
27 * This copyright notice MUST APPEAR in all copies of the script!
28 ***************************************************************/
29 interface ConfigurationManagerInterface extends \TYPO3\CMS\Core\SingletonInterface {
30
31 const CONFIGURATION_TYPE_FRAMEWORK = 'Framework';
32 const CONFIGURATION_TYPE_SETTINGS = 'Settings';
33 const CONFIGURATION_TYPE_FULL_TYPOSCRIPT = 'FullTypoScript';
34
35 /**
36 * @param \TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer $contentObject
37 * @return void
38 */
39 public function setContentObject(\TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer $contentObject = NULL);
40
41 /**
42 * Get the content object
43 *
44 * @return \TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer
45 * @api (v4 only)
46 */
47 public function getContentObject();
48
49 /**
50 * Returns the specified configuration.
51 * The actual configuration will be merged from different sources in a defined order.
52 *
53 * Note that this is a low level method and only makes sense to be used by Extbase internally.
54 *
55 * @param string $configurationType The kind of configuration to fetch - must be one of the CONFIGURATION_TYPE_* constants
56 * @param string $extensionName if specified, the configuration for the given extension will be returned.
57 * @param string $pluginName if specified, the configuration for the given plugin will be returned.
58 * @return array The configuration
59 */
60 public function getConfiguration($configurationType, $extensionName = NULL, $pluginName = NULL);
61
62 /**
63 * Sets the specified raw configuration coming from the outside.
64 * Note that this is a low level method and only makes sense to be used by Extbase internally.
65 *
66 * @param array $configuration The new configuration
67 * @return void
68 */
69 public function setConfiguration(array $configuration = array());
70
71 /**
72 * Returns TRUE if a certain feature, identified by $featureName
73 * should be activated, FALSE for backwards-compatible behavior.
74 *
75 * This is an INTERNAL API used throughout Extbase and Fluid for providing backwards-compatibility.
76 * Do not use it in your custom code!
77 *
78 * @param string $featureName
79 * @return boolean
80 */
81 public function isFeatureEnabled($featureName);
82 }
83
84 ?>