PresetInterface
Preset interface
A preset is a class for handling a specific configuration set of a feature.
Table of Contents
Methods
- getConfigurationValues() : array<string|int, mixed>
- Get configuration values to activate prefix
- 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
- Check is preset is currently active on the system
- isAvailable() : bool
- Check if preset is available on the system
- setPostValues() : mixed
- Set POST values
Methods
getConfigurationValues()
Get configuration values to activate prefix
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()
Check is preset is currently active on the system
public
isActive() : bool
Return values
bool —TRUE if preset is active
isAvailable()
Check if preset is available on the system
public
isAvailable() : bool
Return values
bool —TRUE if preset is available
setPostValues()
Set POST values
public
setPostValues(array<string|int, mixed> $postValues) : mixed
Parameters
- $postValues : array<string|int, mixed>
-
Post values of feature