rex_system_setting
in package
AbstractYes
This class can be used to add settings to the system settings page.
Tags
Table of Contents
Methods
- getAll() : array<int, self>
- Returns all registered setting objects.
- getField() : rex_form_element
- Returns the field.
- getKey() : string
- Returns the setting key.
- register() : void
- Registers a setting object.
- setValue() : string|bool
- Sets the new value.
Methods
getAll()
Returns all registered setting objects.
public
static getAll() : array<int, self>
Return values
array<int, self>getField()
Returns the field.
public
abstract getField() : rex_form_element
Return values
rex_form_elementgetKey()
Returns the setting key.
public
abstract getKey() : string
Return values
stringregister()
Registers a setting object.
public
static register(self $setting) : void
Parameters
- $setting : self
-
Setting object
setValue()
Sets the new value.
public
abstract setValue(mixed $value) : string|bool
Parameters
- $value : mixed
Return values
string|bool —True, when everything went well. String a errormessage in case of failure.