Public Member Functions
	getDefaultConfiguration ()

	getDefaultConfigurationFileLocation ()

	getLocalConfiguration ()

	getLocalConfigurationFileLocation ()

	getAdditionalConfigurationFileLocation ()

	updateLocalConfiguration (array $configurationToMerge)

	getDefaultConfigurationValueByPath ($path)

	getLocalConfigurationValueByPath ($path)

	getConfigurationValueByPath ($path)

	setLocalConfigurationValueByPath ($path, $value)

	setLocalConfigurationValuesByPathValuePairs (array $pairs)

	removeLocalConfigurationKeysByPath (array $keys)

	canWriteConfiguration ()

	exportConfiguration ()

	writeLocalConfiguration (array $configuration)

	writeAdditionalConfiguration (array $additionalConfigurationLines)

	createLocalConfigurationFromFactoryConfiguration ()

Protected Member Functions
	getFactoryConfigurationFileLocation ()

	getAdditionalFactoryConfigurationFileLocation ()

	isValidLocalConfigurationPath ($path)

Protected Attributes
	$defaultConfigurationFile = 'typo3/sysext/core/Configuration/DefaultConfiguration.php'

	$localConfigurationFile = 'typo3conf/LocalConfiguration.php'

	$additionalConfigurationFile = 'typo3conf/AdditionalConfiguration.php'

	$factoryConfigurationFile = 'typo3/sysext/core/Configuration/FactoryConfiguration.php'

	$additionalFactoryConfigurationFile = 'typo3conf/AdditionalFactoryConfiguration.php'

	$pathTypo3Conf = PATH_typo3conf

	$whiteListedLocalConfigurationPaths

Detailed Description

Handle loading and writing of global and local (instance specific) configuration.

This class handles the access to the files

EXT:core/Configuration/DefaultConfiguration.php (default TYPO3_CONF_VARS)
typo3conf/LocalConfiguration.php (overrides of TYPO3_CONF_VARS)
typo3conf/AdditionalConfiguration.php (optional additional local code blocks)

IMPORTANT: This class is intended for internal core use ONLY. Extensions should usually use the resulting $GLOBALS['TYPO3_CONF_VARS'] array, do not try to modify settings in LocalConfiguration.php with an extension.

Definition at line 36 of file core/Classes/Configuration/ConfigurationManager.php.

Member Function Documentation

canWriteConfiguration ( )

Checks if the configuration can be written.

Returns: bool private

Definition at line 271 of file core/Classes/Configuration/ConfigurationManager.php.

References ConfigurationManager\getLocalConfigurationFileLocation().

Referenced by ConfigurationManager\writeLocalConfiguration().

createLocalConfigurationFromFactoryConfiguration ( )

Uses FactoryConfiguration file and a possible AdditionalFactoryConfiguration file in typo3conf to create a basic LocalConfiguration.php. This is used by the install tool in an early step.

Exceptions

\RuntimeException

Returns: void private

Definition at line 363 of file core/Classes/Configuration/ConfigurationManager.php.

References ConfigurationManager\getAdditionalFactoryConfigurationFileLocation(), ConfigurationManager\getFactoryConfigurationFileLocation(), ConfigurationManager\getLocalConfigurationFileLocation(), ArrayUtility\mergeRecursiveWithOverrule(), and ConfigurationManager\writeLocalConfiguration().

exportConfiguration ( )

Reads the configuration array and exports it to the global variable

private

Exceptions

\UnexpectedValueException

Returns: void

Definition at line 284 of file core/Classes/Configuration/ConfigurationManager.php.

References $GLOBALS, ConfigurationManager\getAdditionalConfigurationFileLocation(), ConfigurationManager\getDefaultConfiguration(), ConfigurationManager\getLocalConfiguration(), ConfigurationManager\getLocalConfigurationFileLocation(), and ArrayUtility\mergeRecursiveWithOverrule().

getAdditionalConfigurationFileLocation ( )

Get the file location of the additional configuration file, currently the path and filename.

Returns: string private

Definition at line 133 of file core/Classes/Configuration/ConfigurationManager.php.

References ConfigurationManager\$additionalConfigurationFile.

Referenced by ConfigurationManager\exportConfiguration().

getAdditionalFactoryConfigurationFileLocation ( )

protected

Get absolute file location of factory configuration file

Returns: string

Definition at line 153 of file core/Classes/Configuration/ConfigurationManager.php.

References ConfigurationManager\$additionalFactoryConfigurationFile.

Referenced by ConfigurationManager\createLocalConfigurationFromFactoryConfiguration().

getConfigurationValueByPath ( $path )

Get a value from configuration, this is default configuration merged with local configuration

Parameters

string $path Path to search for

Returns: mixed

Definition at line 200 of file core/Classes/Configuration/ConfigurationManager.php.

References ConfigurationManager\getDefaultConfiguration(), ConfigurationManager\getLocalConfiguration(), ArrayUtility\getValueByPath(), and ArrayUtility\mergeRecursiveWithOverrule().

getDefaultConfiguration ( )

Return default configuration array

Returns: array

Definition at line 87 of file core/Classes/Configuration/ConfigurationManager.php.

References ConfigurationManager\getDefaultConfigurationFileLocation().

Referenced by ConfigurationManager\exportConfiguration(), ConfigurationManager\getConfigurationValueByPath(), ConfigurationManager\getDefaultConfigurationValueByPath(), and ConfigurationManager\isValidLocalConfigurationPath().

getDefaultConfigurationFileLocation ( )

Get the file location of the default configuration file, currently the path and filename.

Returns: string private

Definition at line 99 of file core/Classes/Configuration/ConfigurationManager.php.

References ConfigurationManager\$defaultConfigurationFile.

Referenced by ConfigurationManager\getDefaultConfiguration().

getDefaultConfigurationValueByPath ( $path )

Get a value at given path from default configuration

Parameters

string $path Path to search for

Returns: mixed Value at path

Definition at line 177 of file core/Classes/Configuration/ConfigurationManager.php.

References ConfigurationManager\getDefaultConfiguration(), and ArrayUtility\getValueByPath().

getFactoryConfigurationFileLocation ( )

protected

Get absolute file location of factory configuration file

Returns: string

Definition at line 143 of file core/Classes/Configuration/ConfigurationManager.php.

References ConfigurationManager\$factoryConfigurationFile.

Referenced by ConfigurationManager\createLocalConfigurationFromFactoryConfiguration().

getLocalConfiguration ( )

Return local configuration array typo3conf/LocalConfiguration.php

Returns: array Content array of local configuration file

Definition at line 109 of file core/Classes/Configuration/ConfigurationManager.php.

References ConfigurationManager\getLocalConfigurationFileLocation().

Referenced by ConfigurationManager\exportConfiguration(), ConfigurationManager\getConfigurationValueByPath(), ConfigurationManager\getLocalConfigurationValueByPath(), ConfigurationManager\removeLocalConfigurationKeysByPath(), ConfigurationManager\setLocalConfigurationValueByPath(), ConfigurationManager\setLocalConfigurationValuesByPathValuePairs(), and ConfigurationManager\updateLocalConfiguration().

getLocalConfigurationFileLocation ( )

Get the file location of the local configuration file, currently the path and filename.

Returns: string private

Definition at line 121 of file core/Classes/Configuration/ConfigurationManager.php.

References ConfigurationManager\$localConfigurationFile.

Referenced by ConfigurationManager\canWriteConfiguration(), ConfigurationManager\createLocalConfigurationFromFactoryConfiguration(), ConfigurationManager\exportConfiguration(), ConfigurationManager\getLocalConfiguration(), and ConfigurationManager\writeLocalConfiguration().

getLocalConfigurationValueByPath ( $path )

Get a value at given path from local configuration

Parameters

string $path Path to search for

Returns: mixed Value at path

Definition at line 188 of file core/Classes/Configuration/ConfigurationManager.php.

References ConfigurationManager\getLocalConfiguration(), and ArrayUtility\getValueByPath().

isValidLocalConfigurationPath ( $path )

protected

Check if access / write to given path in local configuration is allowed.

Parameters

string $path Path to search for

Returns: bool TRUE if access is allowed

Definition at line 389 of file core/Classes/Configuration/ConfigurationManager.php.

References ConfigurationManager\getDefaultConfiguration(), GeneralUtility\isFirstPartOfStr(), and ArrayUtility\isValidPath().

Referenced by ConfigurationManager\setLocalConfigurationValueByPath(), and ConfigurationManager\setLocalConfigurationValuesByPathValuePairs().

removeLocalConfigurationKeysByPath ( array $keys )

Remove keys from LocalConfiguration

Parameters

array $keys Array with key paths to remove from LocalConfiguration

Returns: bool TRUE if something was removed

Definition at line 248 of file core/Classes/Configuration/ConfigurationManager.php.

References ConfigurationManager\getLocalConfiguration(), ArrayUtility\isValidPath(), ArrayUtility\removeByPath(), and ConfigurationManager\writeLocalConfiguration().

setLocalConfigurationValueByPath	(	$path,
		$value
	)

Update a given path in local configuration to a new value.

Parameters

string	$path	Path to update
mixed	$value	Value to set

Returns: bool TRUE on success

Definition at line 214 of file core/Classes/Configuration/ConfigurationManager.php.

References ConfigurationManager\getLocalConfiguration(), ConfigurationManager\isValidLocalConfigurationPath(), ArrayUtility\setValueByPath(), and ConfigurationManager\writeLocalConfiguration().

setLocalConfigurationValuesByPathValuePairs ( array $pairs )

Update / set a list of path and value pairs in local configuration file

Parameters

array $pairs Key is path, value is value to set

Returns: bool TRUE on success

Definition at line 231 of file core/Classes/Configuration/ConfigurationManager.php.

References ConfigurationManager\getLocalConfiguration(), ConfigurationManager\isValidLocalConfigurationPath(), ArrayUtility\setValueByPath(), and ConfigurationManager\writeLocalConfiguration().

updateLocalConfiguration ( array $configurationToMerge )

Override local configuration with new values.

Parameters

array $configurationToMerge Override configuration array

Returns: void

Definition at line 164 of file core/Classes/Configuration/ConfigurationManager.php.

References ConfigurationManager\getLocalConfiguration(), ArrayUtility\mergeRecursiveWithOverrule(), and ConfigurationManager\writeLocalConfiguration().

writeAdditionalConfiguration ( array $additionalConfigurationLines )

Write additional configuration array to typo3conf/AdditionalConfiguration.php

Parameters

array $additionalConfigurationLines The configuration lines to be written

Exceptions

\RuntimeException

Returns: bool TRUE on success private

Definition at line 345 of file core/Classes/Configuration/ConfigurationManager.php.

References GeneralUtility\writeFile().

writeLocalConfiguration ( array $configuration )

Write local configuration array to typo3conf/LocalConfiguration.php

Parameters

array $configuration The local configuration to be written

Exceptions

\RuntimeException

Returns: bool TRUE on success private

Definition at line 312 of file core/Classes/Configuration/ConfigurationManager.php.

References ConfigurationManager\$localConfigurationFile, ArrayUtility\arrayExport(), ConfigurationManager\canWriteConfiguration(), ConfigurationManager\getLocalConfigurationFileLocation(), GeneralUtility\makeInstance(), ArrayUtility\renumberKeysToAvoidLeapsIfKeysAreAllNumeric(), ArrayUtility\sortByKeyRecursive(), and GeneralUtility\writeFile().

Referenced by ConfigurationManager\createLocalConfigurationFromFactoryConfiguration(), ConfigurationManager\removeLocalConfigurationKeysByPath(), ConfigurationManager\setLocalConfigurationValueByPath(), ConfigurationManager\setLocalConfigurationValuesByPathValuePairs(), and ConfigurationManager\updateLocalConfiguration().

Member Data Documentation

$additionalConfigurationFile = 'typo3conf/AdditionalConfiguration.php'

protected

Definition at line 51 of file core/Classes/Configuration/ConfigurationManager.php.

Referenced by ConfigurationManager\getAdditionalConfigurationFileLocation().

$additionalFactoryConfigurationFile = 'typo3conf/AdditionalFactoryConfiguration.php'

protected

Definition at line 61 of file core/Classes/Configuration/ConfigurationManager.php.

Referenced by ConfigurationManager\getAdditionalFactoryConfigurationFileLocation().

$defaultConfigurationFile = 'typo3/sysext/core/Configuration/DefaultConfiguration.php'

protected

Definition at line 41 of file core/Classes/Configuration/ConfigurationManager.php.

Referenced by ConfigurationManager\getDefaultConfigurationFileLocation().

$factoryConfigurationFile = 'typo3/sysext/core/Configuration/FactoryConfiguration.php'

protected

Definition at line 56 of file core/Classes/Configuration/ConfigurationManager.php.

Referenced by ConfigurationManager\getFactoryConfigurationFileLocation().

$localConfigurationFile = 'typo3conf/LocalConfiguration.php'

protected

Definition at line 46 of file core/Classes/Configuration/ConfigurationManager.php.

Referenced by ConfigurationManager\getLocalConfigurationFileLocation(), and ConfigurationManager\writeLocalConfiguration().

$pathTypo3Conf = PATH_typo3conf

protected

Definition at line 66 of file core/Classes/Configuration/ConfigurationManager.php.

$whiteListedLocalConfigurationPaths

protected

Initial value:

= array(
        'EXT/extConf',
        'EXTCONF',
        'INSTALL/wizardDone',
        'DB',
        'SYS/caching/cacheConfigurations',
    )

Definition at line 74 of file core/Classes/Configuration/ConfigurationManager.php.

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

Member Data Documentation