CustomPreset extends AbstractCustomPreset implements CustomPresetInterface
Custom preset is a fallback if no other preset fits
only to be used within EXT:install
Table of Contents
Interfaces
- CustomPresetInterface
- Custom preset interface
Properties
- $configurationManager : ConfigurationManager
- $configurationValues : array<string|int, mixed>
- $isActive : bool
- $name : string
- $postValues : array<string|int, mixed>
- $priority : int
- $readonlyConfigurationValues : mixed
Methods
- __construct() : mixed
- getConfigurationDescriptors() : array<string|int, mixed>
- Build configuration descriptors to be used in fluid to show configuration options.
- getConfigurationValues() : array<string|int, mixed>
- Get configuration values is used to persist data and is merged with given $postValues.
- getIsActive() : bool
- Wrapper for isActive, used in fluid
- getIsAvailable() : bool
- Wrapper for isAvailable, used in fluid
- getName() : string
- Get name of preset
- getPriority() : int
- Get priority of preset
- isActive() : bool
- Whether custom preset is active is set by feature
- isAvailable() : bool
- Custom configuration is always available
- setActive() : mixed
- Mark preset as active.
- setPostValues() : mixed
- Set POST values
Properties
$configurationManager
protected
ConfigurationManager
$configurationManager
$configurationValues
protected
array<string|int, mixed>
$configurationValues
= ['GFX/processor_enabled' => false, 'GFX/processor_path' => '', 'GFX/processor' => '', 'GFX/processor_effects' => false, 'GFX/processor_colorspace' => '']
Configuration values handled by this preset
$isActive
protected
bool
$isActive
= false
TRUE if custom preset is active
$name
protected
string
$name
= 'Custom'
Name of preset, always set to "Custom"
$postValues
protected
array<string|int, mixed>
$postValues
= []
List of $POST values
$priority
protected
int
$priority
= 10
Priority of custom prefix is usually the lowest
$readonlyConfigurationValues
protected
mixed
$readonlyConfigurationValues
= ['GFX/processor_path' => true]
Methods
__construct()
public
__construct([ConfigurationManager|null $configurationManager = null ]) : mixed
Parameters
- $configurationManager : ConfigurationManager|null = null
getConfigurationDescriptors()
Build configuration descriptors to be used in fluid to show configuration options.
public
getConfigurationDescriptors() : array<string|int, mixed>
They are fetched from LocalConfiguration / DefaultConfiguration and merged with given $postValues.
Return values
array<string|int, mixed> —Configuration values needed to activate prefix
getConfigurationValues()
Get configuration values is used to persist data and is merged with given $postValues.
public
getConfigurationValues() : array<string|int, mixed>
Return values
array<string|int, mixed> —Configuration values needed to activate prefix
getIsActive()
Wrapper for isActive, used in fluid
public
getIsActive() : bool
Return values
bool —TRUE if preset is active
getIsAvailable()
Wrapper for isAvailable, used in fluid
public
getIsAvailable() : bool
Return values
bool —TRUE if preset is available
getName()
Get name of preset
public
getName() : string
Return values
string —Name
getPriority()
Get priority of preset
public
getPriority() : int
Return values
int —Priority, usually between 0 and 100
isActive()
Whether custom preset is active is set by feature
public
isActive() : bool
Return values
bool —TRUE if custom preset is active
isAvailable()
Custom configuration is always available
public
isAvailable() : bool
Return values
bool —TRUE
setActive()
Mark preset as active.
public
setActive() : mixed
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.
setPostValues()
Set POST values
public
setPostValues(array<string|int, mixed> $postValues) : mixed
Parameters
- $postValues : array<string|int, mixed>
-
Post values of feature