[TASK] Streamline phpdoc annotations in EXT:extbase
[Packages/TYPO3.CMS.git] / typo3 / sysext / extbase / Classes / Configuration / ConfigurationManagerInterface.php
1 <?php
2 namespace TYPO3\CMS\Extbase\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 /**
18 * Class ConfigurationManagerInterface
19 * @internal only to be used within Extbase, not part of TYPO3 Core API.
20 */
21 interface ConfigurationManagerInterface extends \TYPO3\CMS\Core\SingletonInterface
22 {
23 const CONFIGURATION_TYPE_FRAMEWORK = 'Framework';
24 const CONFIGURATION_TYPE_SETTINGS = 'Settings';
25 const CONFIGURATION_TYPE_FULL_TYPOSCRIPT = 'FullTypoScript';
26
27 /**
28 * @param \TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer $contentObject
29 */
30 public function setContentObject(\TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer $contentObject = null);
31
32 /**
33 * Get the content object
34 *
35 * @return \TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer
36 */
37 public function getContentObject();
38
39 /**
40 * Returns the specified configuration.
41 * The actual configuration will be merged from different sources in a defined order.
42 *
43 * Note that this is a low level method and only makes sense to be used by Extbase internally.
44 *
45 * @param string $configurationType The kind of configuration to fetch - must be one of the CONFIGURATION_TYPE_* constants
46 * @param string $extensionName if specified, the configuration for the given extension will be returned.
47 * @param string $pluginName if specified, the configuration for the given plugin will be returned.
48 * @return array The configuration
49 */
50 public function getConfiguration($configurationType, $extensionName = null, $pluginName = null);
51
52 /**
53 * Sets the specified raw configuration coming from the outside.
54 * Note that this is a low level method and only makes sense to be used by Extbase internally.
55 *
56 * @param array $configuration The new configuration
57 */
58 public function setConfiguration(array $configuration = []);
59
60 /**
61 * Returns TRUE if a certain feature, identified by $featureName
62 * should be activated, FALSE for backwards-compatible behavior.
63 *
64 * This is an INTERNAL API used throughout Extbase and Fluid for providing backwards-compatibility.
65 * Do not use it in your custom code!
66 *
67 * @param string $featureName
68 * @return bool
69 */
70 public function isFeatureEnabled($featureName);
71 }