TYPO3\CMS\Extensionmanager\Utility\ConfigurationUtility Class Reference

Inheritance diagram for TYPO3\CMS\Extensionmanager\Utility\ConfigurationUtility:

Public Member Functions
	saveDefaultConfiguration ($extensionKey)
	getCurrentConfiguration ($extensionKey)
	getDefaultConfigurationFromExtConfTemplateAsValuedArray ($extensionKey)
	convertValuedToNestedConfiguration (array $valuedConfiguration)
	convertNestedToValuedConfiguration (array $nestedConfiguration)

Protected Member Functions
	getExtensionPathInformation ($extensionKey)
	getDefaultConfigurationRawString ($extensionKey)

Protected Attributes
	$objectManager

Detailed Description

This file is part of the TYPO3 CMS project.

It is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License, either version 2 of the License, or any later version.

For the full copyright and license information, please read the LICENSE.txt file that was distributed with this source code.

The TYPO3 project - inspiring people to share! Utility for dealing with ext_emconf and ext_conf_template settings

Author

Susanne Moog susan.nosp@m.ne.m.nosp@m.oog@t.nosp@m.ypo3.nosp@m..org

Definition at line 21 of file ConfigurationUtility.php.

Member Function Documentation

convertNestedToValuedConfiguration()

TYPO3\CMS\Extensionmanager\Utility\ConfigurationUtility::convertNestedToValuedConfiguration

(

array

$nestedConfiguration

)

Convert a nested configuration to a valued configuration

array('first.' => array('second' => 1)) will become array('first.second' => array('value' => 1)

Parameters

array

$nestedConfiguration

Returns

array

Definition at line 210 of file ConfigurationUtility.php.

References TYPO3\CMS\Core\Utility\ArrayUtility\flatten().

Referenced by TYPO3\CMS\Extensionmanager\Utility\ConfigurationUtility\getCurrentConfiguration().

convertValuedToNestedConfiguration()

TYPO3\CMS\Extensionmanager\Utility\ConfigurationUtility::convertValuedToNestedConfiguration

(

array

$valuedConfiguration

)

Converts a valued configuration to a nested configuration.

array('first.second' => array('value' => 1)) will become array('first.' => array('second' => ))

Parameters

array

$valuedConfiguration

Returns

array

Definition at line 192 of file ConfigurationUtility.php.

References TYPO3\CMS\Core\Utility\ArrayUtility\setValueByPath().

Referenced by TYPO3\CMS\Extensionmanager\Utility\ConfigurationUtility\saveDefaultConfiguration().

getCurrentConfiguration()

TYPO3\CMS\Extensionmanager\Utility\ConfigurationUtility::getCurrentConfiguration

(

$extensionKey

)

Get current configuration of an extension. Will return the configuration as a valued object

Parameters

string

$extensionKey

Returns

array

Definition at line 70 of file ConfigurationUtility.php.

References $GLOBALS, TYPO3\CMS\Extensionmanager\Utility\ConfigurationUtility\convertNestedToValuedConfiguration(), TYPO3\CMS\Extensionmanager\Utility\ConfigurationUtility\getDefaultConfigurationFromExtConfTemplateAsValuedArray(), and TYPO3\CMS\Core\Utility\ArrayUtility\mergeRecursiveWithOverrule().

Referenced by TYPO3\CMS\Extensionmanager\Utility\ConfigurationUtility\saveDefaultConfiguration().

getDefaultConfigurationFromExtConfTemplateAsValuedArray()

TYPO3\CMS\Extensionmanager\Utility\ConfigurationUtility::getDefaultConfigurationFromExtConfTemplateAsValuedArray

(

$extensionKey

)

Create a flat array of configuration options from ext_conf_template.txt of an extension using core's typoscript parser.

Generates an array from the typoscript style constants and adds meta data like TSConstantEditor comments

Result is an array, with configuration item as array keys, and item properties as key-value sub-array:

array( 'fooOption' => array( 'type' => 'string', 'value' => 'foo', ... ), 'barOption' => array( 'type' => boolean, 'default_value' => 0, ... ), ... )

Parameters

string

$extensionKey

Extension key

Returns

array

Definition at line 109 of file ConfigurationUtility.php.

References $GLOBALS, TYPO3\CMS\Extensionmanager\Utility\ConfigurationUtility\getDefaultConfigurationRawString(), and TYPO3\CMS\Extensionmanager\Utility\ConfigurationUtility\getExtensionPathInformation().

Referenced by TYPO3\CMS\Extensionmanager\Utility\ConfigurationUtility\getCurrentConfiguration().

getDefaultConfigurationRawString()

TYPO3\CMS\Extensionmanager\Utility\ConfigurationUtility::getDefaultConfigurationRawString (   $extensionKey )

protected

Return content of an extensions ext_conf_template.txt file if the file exists, empty string if file does not exist.

Parameters

string

$extensionKey

Extension key

Returns

string

Definition at line 170 of file ConfigurationUtility.php.

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

Referenced by TYPO3\CMS\Extensionmanager\Utility\ConfigurationUtility\getDefaultConfigurationFromExtConfTemplateAsValuedArray().

getExtensionPathInformation()

TYPO3\CMS\Extensionmanager\Utility\ConfigurationUtility::getExtensionPathInformation (   $extensionKey )

protected

Parameters

string

$extensionKey

Returns

mixed

Definition at line 159 of file ConfigurationUtility.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Extensionmanager\Utility\ConfigurationUtility\getDefaultConfigurationFromExtConfTemplateAsValuedArray().

saveDefaultConfiguration()

TYPO3\CMS\Extensionmanager\Utility\ConfigurationUtility::saveDefaultConfiguration

(

$extensionKey

)

Get default configuration from ext_conf_template of an extension and save as initial configuration to LocalConfiguration ['EXT']['extConf'].

Used by the InstallUtility to initialize local extension config.

Parameters

string

$extensionKey

Extension key

Returns

void

Definition at line 38 of file ConfigurationUtility.php.

References TYPO3\CMS\Extensionmanager\Utility\ConfigurationUtility\convertValuedToNestedConfiguration(), TYPO3\CMS\Extensionmanager\Utility\ConfigurationUtility\getCurrentConfiguration(), and TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

Member Data Documentation

$objectManager

TYPO3\CMS\Extensionmanager\Utility\ConfigurationUtility::$objectManager

protected

Definition at line 27 of file ConfigurationUtility.php.