[CLEANUP] Replace wrong/old file copyright comments
[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 * Extbase is a backport of TYPO3 Flow. All credits go to the TYPO3 Flow team.
9 * All rights reserved
10 *
11 * This script is part of the TYPO3 project. The TYPO3 project is
12 * free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or
15 * (at your option) any later version.
16 *
17 * The GNU General Public License can be found at
18 * http://www.gnu.org/copyleft/gpl.html.
19 * A copy is found in the textfile GPL.txt and important notices to the license
20 * from the author is found in LICENSE.txt distributed with these scripts.
21 *
22 *
23 * This script is distributed in the hope that it will be useful,
24 * but WITHOUT ANY WARRANTY; without even the implied warranty of
25 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
26 * GNU General Public License for more details.
27 *
28 * This copyright notice MUST APPEAR in all copies of the script!
29 ***************************************************************/
30 interface ConfigurationManagerInterface extends \TYPO3\CMS\Core\SingletonInterface {
31
32 const CONFIGURATION_TYPE_FRAMEWORK = 'Framework';
33 const CONFIGURATION_TYPE_SETTINGS = 'Settings';
34 const CONFIGURATION_TYPE_FULL_TYPOSCRIPT = 'FullTypoScript';
35
36 /**
37 * @param \TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer $contentObject
38 * @return void
39 */
40 public function setContentObject(\TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer $contentObject = NULL);
41
42 /**
43 * Get the content object
44 *
45 * @return \TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer
46 * @api (v4 only)
47 */
48 public function getContentObject();
49
50 /**
51 * Returns the specified configuration.
52 * The actual configuration will be merged from different sources in a defined order.
53 *
54 * Note that this is a low level method and only makes sense to be used by Extbase internally.
55 *
56 * @param string $configurationType The kind of configuration to fetch - must be one of the CONFIGURATION_TYPE_* constants
57 * @param string $extensionName if specified, the configuration for the given extension will be returned.
58 * @param string $pluginName if specified, the configuration for the given plugin will be returned.
59 * @return array The configuration
60 */
61 public function getConfiguration($configurationType, $extensionName = NULL, $pluginName = NULL);
62
63 /**
64 * Sets the specified raw configuration coming from the outside.
65 * Note that this is a low level method and only makes sense to be used by Extbase internally.
66 *
67 * @param array $configuration The new configuration
68 * @return void
69 */
70 public function setConfiguration(array $configuration = array());
71
72 /**
73 * Returns TRUE if a certain feature, identified by $featureName
74 * should be activated, FALSE for backwards-compatible behavior.
75 *
76 * This is an INTERNAL API used throughout Extbase and Fluid for providing backwards-compatibility.
77 * Do not use it in your custom code!
78 *
79 * @param string $featureName
80 * @return boolean
81 */
82 public function isFeatureEnabled($featureName);
83 }
84
85 ?>