lamBooleanListOption
extends lamListOption
in package
Boolean option for list configuration.
Tags
Table of Contents
- $ID : mixed
- unique ID
- $name : mixed
- option name
- $value : mixed
- option value
- __construct() : lamBooleanListOption
- Creates a new boolean option.
- fillFromPostData() : array<string|int, mixed>
- Fills the config option from POST data.
- getID() : string
- Returns the option ID.
- getMetaHTML() : htmlResponsiveRow
- Returns the meta HTML data to display this option.
- getValue() : string
- Returns the option value. The value must not contain "=" and ";".
- isSelected() : bool
- Returns if this option is selected.
- setValue() : mixed
- Sets the config option value. The value must not contain "=" and ";".
Properties
$ID
unique ID
private
mixed
$ID
$name
option name
private
mixed
$name
$value
option value
private
mixed
$value
Methods
__construct()
Creates a new boolean option.
public
__construct(string $name, string $ID) : lamBooleanListOption
Parameters
- $name : string
-
name to show on config page
- $ID : string
-
unique ID
Return values
lamBooleanListOption —config option
fillFromPostData()
Fills the config option from POST data.
public
fillFromPostData() : array<string|int, mixed>
Return values
array<string|int, mixed> —list of StatusMessages (array(
getID()
Returns the option ID.
public
getID() : string
Return values
string —ID
getMetaHTML()
Returns the meta HTML data to display this option.
public
getMetaHTML() : htmlResponsiveRow
Tags
Return values
htmlResponsiveRow —meta HTML
getValue()
Returns the option value. The value must not contain "=" and ";".
public
getValue() : string
Return values
string —value
isSelected()
Returns if this option is selected.
public
isSelected() : bool
Return values
bool —true, if selected
setValue()
Sets the config option value. The value must not contain "=" and ";".
public
setValue(string $value) : mixed
Parameters
- $value : string