TYPO3 CMS  TYPO3_7-6
TYPO3\CMS\Install\Configuration\AbstractCustomPreset Class Reference
Inheritance diagram for TYPO3\CMS\Install\Configuration\AbstractCustomPreset:
TYPO3\CMS\Install\Configuration\AbstractPreset TYPO3\CMS\Install\Configuration\PresetInterface TYPO3\CMS\Install\Configuration\Charset\CustomPreset TYPO3\CMS\Install\Configuration\Context\CustomPreset TYPO3\CMS\Install\Configuration\Image\CustomPreset TYPO3\CMS\Install\Configuration\Mail\CustomPreset

Public Member Functions

 isActive ()
 
 setActive ()
 
 isAvailable ()
 
 getConfigurationValues ()
 
- Public Member Functions inherited from TYPO3\CMS\Install\Configuration\AbstractPreset
 injectConfigurationManager (\TYPO3\CMS\Core\Configuration\ConfigurationManager $configurationManager)
 
 setPostValues (array $postValues)
 
 getIsAvailable ()
 
 isActive ()
 
 getIsActive ()
 
 getName ()
 
 getPriority ()
 
 getConfigurationValues ()
 

Protected Attributes

 $name = 'Custom'
 
 $isActive = false
 
 $priority = 10
 
- Protected Attributes inherited from TYPO3\CMS\Install\Configuration\AbstractPreset
 $configurationManager = null
 
 $name = ''
 
 $priority = 50
 
 $configurationValues = []
 
 $postValues = []
 

Detailed Description

Abstract custom preset class implements common preset code

Definition at line 20 of file AbstractCustomPreset.php.

Member Function Documentation

◆ getConfigurationValues()

TYPO3\CMS\Install\Configuration\AbstractCustomPreset::getConfigurationValues ( )

Get configuration values is 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

Implements TYPO3\CMS\Install\Configuration\PresetInterface.

Definition at line 79 of file AbstractCustomPreset.php.

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

◆ isActive()

TYPO3\CMS\Install\Configuration\AbstractCustomPreset::isActive ( )

Whether custom preset is active is set by feature

Returns
bool TRUE if custom preset is active

Implements TYPO3\CMS\Install\Configuration\PresetInterface.

Definition at line 42 of file AbstractCustomPreset.php.

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

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

◆ isAvailable()

TYPO3\CMS\Install\Configuration\AbstractCustomPreset::isAvailable ( )

Custom configuration is always available

Returns
bool TRUE

Implements TYPO3\CMS\Install\Configuration\PresetInterface.

Definition at line 67 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.

Returns
void

Definition at line 57 of file AbstractCustomPreset.php.

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

Member Data Documentation

◆ $isActive

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

◆ $name

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

◆ $priority

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

Definition at line 35 of file AbstractCustomPreset.php.