Documentation

rex_system_setting
in package

AbstractYes

This class can be used to add settings to the system settings page.

Tags
author

gharlan

Table of Contents

Methods

getAll()  : array<string|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<string|int, self>
Return values
array<string|int, self>

getKey()

Returns the setting key.

public abstract getKey() : string
Return values
string

register()

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.


        
On this page

Search results