TYPO3 CMS  TYPO3_8-7
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
TYPO3\CMS\Core\Configuration\ConfigurationManager Class Reference

Public Member Functions

 getDefaultConfiguration ()
 
 getDefaultConfigurationFileLocation ()
 
 getDefaultConfigurationDescriptionFileLocation ()
 
 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'
 
 $defaultConfigurationDescriptionFile = 'typo3/sysext/core/Configuration/DefaultConfigurationDescription.php'
 
 $localConfigurationFile = 'typo3conf/LocalConfiguration.php'
 
 $additionalConfigurationFile = 'typo3conf/AdditionalConfiguration.php'
 
 $factoryConfigurationFile = 'typo3/sysext/core/Configuration/FactoryConfiguration.php'
 
 $additionalFactoryConfigurationFile = 'typo3conf/AdditionalFactoryConfiguration.php'
 
 $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 ConfigurationManager.php.

Member Function Documentation

◆ canWriteConfiguration()

TYPO3\CMS\Core\Configuration\ConfigurationManager::canWriteConfiguration ( )

Checks if the configuration can be written.

Returns
bool private

Definition at line 282 of file ConfigurationManager.php.

References TYPO3\CMS\Core\Configuration\ConfigurationManager\getLocalConfigurationFileLocation().

Referenced by TYPO3\CMS\Core\Configuration\ConfigurationManager\writeLocalConfiguration().

◆ createLocalConfigurationFromFactoryConfiguration()

TYPO3\CMS\Core\Configuration\ConfigurationManager::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

Definition at line 371 of file ConfigurationManager.php.

References TYPO3\CMS\Core\Configuration\ConfigurationManager\getAdditionalFactoryConfigurationFileLocation(), TYPO3\CMS\Core\Configuration\ConfigurationManager\getFactoryConfigurationFileLocation(), TYPO3\CMS\Core\Configuration\ConfigurationManager\getLocalConfigurationFileLocation(), TYPO3\CMS\Core\Utility\ArrayUtility\mergeRecursiveWithOverrule(), and TYPO3\CMS\Core\Configuration\ConfigurationManager\writeLocalConfiguration().

◆ exportConfiguration()

TYPO3\CMS\Core\Configuration\ConfigurationManager::exportConfiguration ( )

Reads the configuration array and exports it to the global variable

private

Exceptions

Definition at line 294 of file ConfigurationManager.php.

References $GLOBALS, TYPO3\CMS\Core\Configuration\ConfigurationManager\getAdditionalConfigurationFileLocation(), TYPO3\CMS\Core\Configuration\ConfigurationManager\getDefaultConfiguration(), TYPO3\CMS\Core\Configuration\ConfigurationManager\getLocalConfiguration(), TYPO3\CMS\Core\Configuration\ConfigurationManager\getLocalConfigurationFileLocation(), and TYPO3\CMS\Core\Utility\ArrayUtility\mergeRecursiveWithOverrule().

◆ getAdditionalConfigurationFileLocation()

TYPO3\CMS\Core\Configuration\ConfigurationManager::getAdditionalConfigurationFileLocation ( )

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

Returns
string private

Definition at line 145 of file ConfigurationManager.php.

References TYPO3\CMS\Core\Configuration\ConfigurationManager\$additionalConfigurationFile.

Referenced by TYPO3\CMS\Core\Configuration\ConfigurationManager\exportConfiguration().

◆ getAdditionalFactoryConfigurationFileLocation()

TYPO3\CMS\Core\Configuration\ConfigurationManager::getAdditionalFactoryConfigurationFileLocation ( )
protected

Get absolute file location of factory configuration file

Returns
string

Definition at line 165 of file ConfigurationManager.php.

References TYPO3\CMS\Core\Configuration\ConfigurationManager\$additionalFactoryConfigurationFile.

Referenced by TYPO3\CMS\Core\Configuration\ConfigurationManager\createLocalConfigurationFromFactoryConfiguration().

◆ getConfigurationValueByPath()

TYPO3\CMS\Core\Configuration\ConfigurationManager::getConfigurationValueByPath (   $path)

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

Parameters
string$pathPath to search for
Returns
mixed

Definition at line 211 of file ConfigurationManager.php.

References TYPO3\CMS\Core\Configuration\ConfigurationManager\getDefaultConfiguration(), TYPO3\CMS\Core\Configuration\ConfigurationManager\getLocalConfiguration(), TYPO3\CMS\Core\Utility\ArrayUtility\getValueByPath(), and TYPO3\CMS\Core\Utility\ArrayUtility\mergeRecursiveWithOverrule().

◆ getDefaultConfiguration()

TYPO3\CMS\Core\Configuration\ConfigurationManager::getDefaultConfiguration ( )

Return default configuration array

Returns
array

Definition at line 87 of file ConfigurationManager.php.

References TYPO3\CMS\Core\Configuration\ConfigurationManager\getDefaultConfigurationFileLocation().

Referenced by TYPO3\CMS\Core\Configuration\ConfigurationManager\exportConfiguration(), TYPO3\CMS\Core\Configuration\ConfigurationManager\getConfigurationValueByPath(), TYPO3\CMS\Core\Configuration\ConfigurationManager\getDefaultConfigurationValueByPath(), and TYPO3\CMS\Core\Configuration\ConfigurationManager\isValidLocalConfigurationPath().

◆ getDefaultConfigurationDescriptionFileLocation()

TYPO3\CMS\Core\Configuration\ConfigurationManager::getDefaultConfigurationDescriptionFileLocation ( )

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

Returns
string private

Definition at line 111 of file ConfigurationManager.php.

References TYPO3\CMS\Core\Configuration\ConfigurationManager\$defaultConfigurationDescriptionFile.

◆ getDefaultConfigurationFileLocation()

TYPO3\CMS\Core\Configuration\ConfigurationManager::getDefaultConfigurationFileLocation ( )

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

Returns
string private

Definition at line 99 of file ConfigurationManager.php.

References TYPO3\CMS\Core\Configuration\ConfigurationManager\$defaultConfigurationFile.

Referenced by TYPO3\CMS\Core\Configuration\ConfigurationManager\getDefaultConfiguration().

◆ getDefaultConfigurationValueByPath()

TYPO3\CMS\Core\Configuration\ConfigurationManager::getDefaultConfigurationValueByPath (   $path)

Get a value at given path from default configuration

Parameters
string$pathPath to search for
Returns
mixed Value at path

Definition at line 188 of file ConfigurationManager.php.

References TYPO3\CMS\Core\Configuration\ConfigurationManager\getDefaultConfiguration(), and TYPO3\CMS\Core\Utility\ArrayUtility\getValueByPath().

◆ getFactoryConfigurationFileLocation()

TYPO3\CMS\Core\Configuration\ConfigurationManager::getFactoryConfigurationFileLocation ( )
protected

Get absolute file location of factory configuration file

Returns
string

Definition at line 155 of file ConfigurationManager.php.

References TYPO3\CMS\Core\Configuration\ConfigurationManager\$factoryConfigurationFile.

Referenced by TYPO3\CMS\Core\Configuration\ConfigurationManager\createLocalConfigurationFromFactoryConfiguration().

◆ getLocalConfiguration()

TYPO3\CMS\Core\Configuration\ConfigurationManager::getLocalConfiguration ( )

Return local configuration array typo3conf/LocalConfiguration.php

Returns
array Content array of local configuration file

Definition at line 121 of file ConfigurationManager.php.

References TYPO3\CMS\Core\Configuration\ConfigurationManager\getLocalConfigurationFileLocation().

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

◆ getLocalConfigurationFileLocation()

TYPO3\CMS\Core\Configuration\ConfigurationManager::getLocalConfigurationFileLocation ( )

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

Returns
string private

Definition at line 133 of file ConfigurationManager.php.

References TYPO3\CMS\Core\Configuration\ConfigurationManager\$localConfigurationFile.

Referenced by TYPO3\CMS\Core\Configuration\ConfigurationManager\canWriteConfiguration(), TYPO3\CMS\Core\Configuration\ConfigurationManager\createLocalConfigurationFromFactoryConfiguration(), TYPO3\CMS\Core\Configuration\ConfigurationManager\exportConfiguration(), TYPO3\CMS\Core\Configuration\ConfigurationManager\getLocalConfiguration(), and TYPO3\CMS\Core\Configuration\ConfigurationManager\writeLocalConfiguration().

◆ getLocalConfigurationValueByPath()

TYPO3\CMS\Core\Configuration\ConfigurationManager::getLocalConfigurationValueByPath (   $path)

Get a value at given path from local configuration

Parameters
string$pathPath to search for
Returns
mixed Value at path

Definition at line 199 of file ConfigurationManager.php.

References TYPO3\CMS\Core\Configuration\ConfigurationManager\getLocalConfiguration(), and TYPO3\CMS\Core\Utility\ArrayUtility\getValueByPath().

◆ isValidLocalConfigurationPath()

TYPO3\CMS\Core\Configuration\ConfigurationManager::isValidLocalConfigurationPath (   $path)
protected

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

Parameters
string$pathPath to search for
Returns
bool TRUE if access is allowed

Definition at line 397 of file ConfigurationManager.php.

References TYPO3\CMS\Core\Configuration\ConfigurationManager\getDefaultConfiguration(), TYPO3\CMS\Core\Utility\GeneralUtility\isFirstPartOfStr(), and TYPO3\CMS\Core\Utility\ArrayUtility\isValidPath().

Referenced by TYPO3\CMS\Core\Configuration\ConfigurationManager\setLocalConfigurationValueByPath(), and TYPO3\CMS\Core\Configuration\ConfigurationManager\setLocalConfigurationValuesByPathValuePairs().

◆ removeLocalConfigurationKeysByPath()

TYPO3\CMS\Core\Configuration\ConfigurationManager::removeLocalConfigurationKeysByPath ( array  $keys)

Remove keys from LocalConfiguration

Parameters
array$keysArray with key paths to remove from LocalConfiguration
Returns
bool TRUE if something was removed

Definition at line 259 of file ConfigurationManager.php.

References TYPO3\CMS\Core\Configuration\ConfigurationManager\getLocalConfiguration(), TYPO3\CMS\Core\Utility\ArrayUtility\isValidPath(), TYPO3\CMS\Core\Utility\ArrayUtility\removeByPath(), and TYPO3\CMS\Core\Configuration\ConfigurationManager\writeLocalConfiguration().

◆ setLocalConfigurationValueByPath()

TYPO3\CMS\Core\Configuration\ConfigurationManager::setLocalConfigurationValueByPath (   $path,
  $value 
)

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

Parameters
string$pathPath to update
mixed$valueValue to set
Returns
bool TRUE on success

Definition at line 225 of file ConfigurationManager.php.

References TYPO3\CMS\Core\Configuration\ConfigurationManager\getLocalConfiguration(), TYPO3\CMS\Core\Configuration\ConfigurationManager\isValidLocalConfigurationPath(), TYPO3\CMS\Core\Utility\ArrayUtility\setValueByPath(), and TYPO3\CMS\Core\Configuration\ConfigurationManager\writeLocalConfiguration().

◆ setLocalConfigurationValuesByPathValuePairs()

TYPO3\CMS\Core\Configuration\ConfigurationManager::setLocalConfigurationValuesByPathValuePairs ( array  $pairs)

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

Parameters
array$pairsKey is path, value is value to set
Returns
bool TRUE on success

Definition at line 242 of file ConfigurationManager.php.

References TYPO3\CMS\Core\Configuration\ConfigurationManager\getLocalConfiguration(), TYPO3\CMS\Core\Configuration\ConfigurationManager\isValidLocalConfigurationPath(), TYPO3\CMS\Core\Utility\ArrayUtility\setValueByPath(), and TYPO3\CMS\Core\Configuration\ConfigurationManager\writeLocalConfiguration().

◆ updateLocalConfiguration()

TYPO3\CMS\Core\Configuration\ConfigurationManager::updateLocalConfiguration ( array  $configurationToMerge)

Override local configuration with new values.

Parameters
array$configurationToMergeOverride configuration array

Definition at line 175 of file ConfigurationManager.php.

References TYPO3\CMS\Core\Configuration\ConfigurationManager\getLocalConfiguration(), TYPO3\CMS\Core\Utility\ArrayUtility\mergeRecursiveWithOverrule(), and TYPO3\CMS\Core\Configuration\ConfigurationManager\writeLocalConfiguration().

◆ writeAdditionalConfiguration()

TYPO3\CMS\Core\Configuration\ConfigurationManager::writeAdditionalConfiguration ( array  $additionalConfigurationLines)

Write additional configuration array to typo3conf/AdditionalConfiguration.php

Parameters
array$additionalConfigurationLinesThe configuration lines to be written
Exceptions

Definition at line 354 of file ConfigurationManager.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\writeFile().

◆ writeLocalConfiguration()

TYPO3\CMS\Core\Configuration\ConfigurationManager::writeLocalConfiguration ( array  $configuration)

Write local configuration array to typo3conf/LocalConfiguration.php

Parameters
array$configurationThe local configuration to be written
Exceptions

Definition at line 322 of file ConfigurationManager.php.

References TYPO3\CMS\Core\Configuration\ConfigurationManager\$localConfigurationFile, TYPO3\CMS\Core\Utility\ArrayUtility\arrayExport(), TYPO3\CMS\Core\Configuration\ConfigurationManager\canWriteConfiguration(), TYPO3\CMS\Core\Configuration\ConfigurationManager\getLocalConfigurationFileLocation(), TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance(), TYPO3\CMS\Core\Utility\ArrayUtility\sortByKeyRecursive(), and TYPO3\CMS\Core\Utility\GeneralUtility\writeFile().

Referenced by TYPO3\CMS\Core\Configuration\ConfigurationManager\createLocalConfigurationFromFactoryConfiguration(), TYPO3\CMS\Core\Configuration\ConfigurationManager\removeLocalConfigurationKeysByPath(), TYPO3\CMS\Core\Configuration\ConfigurationManager\setLocalConfigurationValueByPath(), TYPO3\CMS\Core\Configuration\ConfigurationManager\setLocalConfigurationValuesByPathValuePairs(), and TYPO3\CMS\Core\Configuration\ConfigurationManager\updateLocalConfiguration().

Member Data Documentation

◆ $additionalConfigurationFile

TYPO3\CMS\Core\Configuration\ConfigurationManager::$additionalConfigurationFile = 'typo3conf/AdditionalConfiguration.php'
protected

Definition at line 56 of file ConfigurationManager.php.

Referenced by TYPO3\CMS\Core\Configuration\ConfigurationManager\getAdditionalConfigurationFileLocation().

◆ $additionalFactoryConfigurationFile

TYPO3\CMS\Core\Configuration\ConfigurationManager::$additionalFactoryConfigurationFile = 'typo3conf/AdditionalFactoryConfiguration.php'
protected

Definition at line 66 of file ConfigurationManager.php.

Referenced by TYPO3\CMS\Core\Configuration\ConfigurationManager\getAdditionalFactoryConfigurationFileLocation().

◆ $defaultConfigurationDescriptionFile

TYPO3\CMS\Core\Configuration\ConfigurationManager::$defaultConfigurationDescriptionFile = 'typo3/sysext/core/Configuration/DefaultConfigurationDescription.php'
protected

Definition at line 46 of file ConfigurationManager.php.

Referenced by TYPO3\CMS\Core\Configuration\ConfigurationManager\getDefaultConfigurationDescriptionFileLocation().

◆ $defaultConfigurationFile

TYPO3\CMS\Core\Configuration\ConfigurationManager::$defaultConfigurationFile = 'typo3/sysext/core/Configuration/DefaultConfiguration.php'
protected

Definition at line 41 of file ConfigurationManager.php.

Referenced by TYPO3\CMS\Core\Configuration\ConfigurationManager\getDefaultConfigurationFileLocation().

◆ $factoryConfigurationFile

TYPO3\CMS\Core\Configuration\ConfigurationManager::$factoryConfigurationFile = 'typo3/sysext/core/Configuration/FactoryConfiguration.php'
protected

Definition at line 61 of file ConfigurationManager.php.

Referenced by TYPO3\CMS\Core\Configuration\ConfigurationManager\getFactoryConfigurationFileLocation().

◆ $localConfigurationFile

TYPO3\CMS\Core\Configuration\ConfigurationManager::$localConfigurationFile = 'typo3conf/LocalConfiguration.php'
protected

Definition at line 51 of file ConfigurationManager.php.

Referenced by TYPO3\CMS\Core\Configuration\ConfigurationManager\getLocalConfigurationFileLocation(), and TYPO3\CMS\Core\Configuration\ConfigurationManager\writeLocalConfiguration().

◆ $whiteListedLocalConfigurationPaths

TYPO3\CMS\Core\Configuration\ConfigurationManager::$whiteListedLocalConfigurationPaths
protected
Initial value:
= [
'EXT/extConf',
'EXTCONF',
'DB',
'SYS/caching/cacheConfigurations',
'SYS/session',
]

Definition at line 74 of file ConfigurationManager.php.