CONFIGDBSTRUCTURE
in package
CONFIGDBSTRUCTURE
Map out the structure of the config table
Table of Contents
Methods
- __construct() : mixed
- CONFIGDBSTRUCTURE
- getAllData() : array<string|int, mixed>
- Get all data from the config table and return an array of ($field => 'value')
- getData() : array<string|int, mixed>
- Get data from the config table for specific variables and return an array of ($field => 'value')
- getOne() : bool|float|string
- Get and return one value from the config table.
- updateOne() : mixed
- Update one value in the config table.
Methods
__construct()
CONFIGDBSTRUCTURE
public
__construct() : mixed
getAllData()
Get all data from the config table and return an array of ($field => 'value')
public
getAllData() : array<string|int, mixed>
Return values
array<string|int, mixed>getData()
Get data from the config table for specific variables and return an array of ($field => 'value')
public
getData(mixed $match) : array<string|int, mixed>
Parameters
- $match : mixed
-
is the name of a variable or an array or variable names : array('var1, 'var2', ...).
Return values
array<string|int, mixed>getOne()
Get and return one value from the config table.
public
getOne(string $field) : bool|float|string
Requested value must be a configName value that is in WIKINDX_LIST_CONFIG_OPTIONS. For other values, use standard $db functions.
Result is returned as a number if the value is stored in configInt columns else the return result is a string or a boolean
Parameters
- $field : string
-
– the table column to match the condition.
Return values
bool|float|stringupdateOne()
Update one value in the config table.
public
updateOne(string $name, mixed $value) : mixed
Parameters
- $name : string
-
in the 'configName' column (i.e. which configuration variable to update)
- $value : mixed
-
to set