TYPO3\CMS\Install\Configuration\AbstractCustomPreset Class Reference

Inheritance diagram for TYPO3\CMS\Install\Configuration\AbstractCustomPreset:

Public Member Functions
bool	isActive ()
	setActive ()
bool	isAvailable ()
array	getConfigurationValues ()
array	getConfigurationDescriptors ()
‪Public Member Functions inherited from ‪TYPO3\CMS\Install\Configuration\AbstractPreset
	__construct (ConfigurationManager $configurationManager=null)
mixed	setPostValues (array $postValues)
bool	getIsAvailable ()
bool	getIsActive ()
string	getName ()
int	getPriority ()

Protected Attributes
string	$name = 'Custom'
bool	$isActive = false
int	$priority = 10
‪Protected Attributes inherited from ‪TYPO3\CMS\Install\Configuration\AbstractPreset
TYPO3 CMS Core Configuration ConfigurationManager	$configurationManager
string	$name = ''
int	$priority = 50
array	$configurationValues = array( )
array	$readonlyConfigurationValues = array( )
array	$postValues = array( )

Detailed Description

Abstract custom preset class implements common preset code

only to be used within EXT:install

Definition at line 22 of file AbstractCustomPreset.php.

Member Function Documentation

getConfigurationDescriptors()

array TYPO3\CMS\Install\Configuration\AbstractCustomPreset::getConfigurationDescriptors

(

)

Build configuration descriptors to be used in fluid to show configuration options. They are fetched from LocalConfiguration / DefaultConfiguration and merged with given $postValues.

Returns

‪array Configuration values needed to activate prefix

Reimplemented in TYPO3\CMS\Install\Configuration\PasswordHashing\CustomPreset.

Definition at line 86 of file AbstractCustomPreset.php.

References TYPO3\CMS\Install\Configuration\AbstractPreset\$configurationValues, and TYPO3\CMS\Install\Configuration\AbstractCustomPreset\$name.

Referenced by TYPO3\CMS\Install\Configuration\AbstractCustomPreset\getConfigurationValues().

getConfigurationValues()

array TYPO3\CMS\Install\Configuration\AbstractCustomPreset::getConfigurationValues

(

)

Get configuration values is used to persist data and is merged with given $postValues.

Returns

‪array Configuration values needed to activate prefix

Reimplemented from TYPO3\CMS\Install\Configuration\AbstractPreset.

Definition at line 74 of file AbstractCustomPreset.php.

References TYPO3\CMS\Install\Configuration\AbstractCustomPreset\getConfigurationDescriptors().

isActive()

bool TYPO3\CMS\Install\Configuration\AbstractCustomPreset::isActive

(

)

Whether custom preset is active is set by feature

Returns

‪bool TRUE if custom preset is active

Reimplemented from TYPO3\CMS\Install\Configuration\AbstractPreset.

Definition at line 41 of file AbstractCustomPreset.php.

References TYPO3\CMS\Install\Configuration\AbstractCustomPreset\$isActive.

Referenced by TYPO3\CMS\Install\Configuration\AbstractCustomPreset\setActive().

isAvailable()

bool TYPO3\CMS\Install\Configuration\AbstractCustomPreset::isAvailable

(

)

Custom configuration is always available

Returns

‪bool TRUE

Implements TYPO3\CMS\Install\Configuration\PresetInterface.

Definition at line 64 of file AbstractCustomPreset.php.

setActive()

TYPO3\CMS\Install\Configuration\AbstractCustomPreset::setActive

(

)

Mark preset as active. The custom features do not know by itself if they are active or not since the configuration options may overlay with other presets. Marking the custom preset as active is therefor taken care off by the feature itself if no other preset is active.

Definition at line 54 of file AbstractCustomPreset.php.

References TYPO3\CMS\Install\Configuration\AbstractCustomPreset\isActive().

Member Data Documentation

$isActive

bool TYPO3\CMS\Install\Configuration\AbstractCustomPreset::$isActive = false

protected

TRUE if custom preset is active

Definition at line 30 of file AbstractCustomPreset.php.

Referenced by TYPO3\CMS\Install\Configuration\AbstractCustomPreset\isActive().

$name

string TYPO3\CMS\Install\Configuration\AbstractCustomPreset::$name = 'Custom'

protected

Name of preset, always set to "Custom"

Definition at line 26 of file AbstractCustomPreset.php.

Referenced by TYPO3\CMS\Install\Configuration\AbstractCustomPreset\getConfigurationDescriptors().

$priority

int TYPO3\CMS\Install\Configuration\AbstractCustomPreset::$priority = 10

protected

Priority of custom prefix is usually the lowest

Definition at line 34 of file AbstractCustomPreset.php.