[+API] Extbase (Configuration): Adding getContentObject to API
[Packages/TYPO3.CMS.git] / typo3 / sysext / extbase / Classes / Configuration / ConfigurationManagerInterface.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 2009 Jochen Rau <jochen.rau@typoplanet.de>
6 * All rights reserved
7 *
8 * This script is part of the TYPO3 project. The TYPO3 project is
9 * free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
13 *
14 * The GNU General Public License can be found at
15 * http://www.gnu.org/copyleft/gpl.html.
16 *
17 * This script is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
21 *
22 * This copyright notice MUST APPEAR in all copies of the script!
23 ***************************************************************/
24
25 /**
26 *
27 *
28 * @package Extbase
29 * @subpackage Configuration
30 * @version $ID:$
31 */
32 interface Tx_Extbase_Configuration_ConfigurationManagerInterface extends t3lib_Singleton {
33
34 const CONFIGURATION_TYPE_FRAMEWORK = 'Framework';
35 const CONFIGURATION_TYPE_SETTINGS = 'Settings';
36 const CONFIGURATION_TYPE_FULL_TYPOSCRIPT = 'FullTypoScript';
37
38 /**
39 * @param tslib_cObj $contentObject
40 * @return void
41 */
42 public function setContentObject(tslib_cObj $contentObject = NULL);
43
44 /**
45 * Get the content object
46 *
47 * @return tslib_cObj
48 * @api (v4 only)
49 */
50 public function getContentObject();
51
52 /**
53 * Returns the specified configuration.
54 * The actual configuration will be merged from different sources in a defined order.
55 *
56 * Note that this is a low level method and only makes sense to be used by Extbase internally.
57 *
58 * @param string $configurationType The kind of configuration to fetch - must be one of the CONFIGURATION_TYPE_* constants
59 * @return array The configuration
60 */
61 public function getConfiguration($configurationType);
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 ?>