|
| __construct ($data=null) |
|
| getFields ($range=null, $section=null, $name=null) |
|
| getMetadata ($field) |
|
| getValue ($field) |
|
| setValue ($field, $value) |
|
| getIterator () |
|
| __get ($field) |
|
| __set ($field, $value) |
|
| __isset ($field) |
|
| offsetExists ($offset) |
|
| offsetGet ($offset) |
|
| offsetSet ($offset, $value) |
|
| offsetUnset ($offset) |
|
| count () |
|
| store ($field, $data) |
|
| create ($field, $data=[]) |
|
| delete ($field) |
|
| convertFromDatabase ($type, $value, $field) |
|
| convertForDatabase ($type, $value, $field) |
|
__construct |
( |
|
$data = null | ) |
|
pass array of config entries in field => value pairs to circumvent fetching from database
- Parameters
-
magic method for dynamic properties
magic method for dynamic properties
magic method for dynamic properties
convertForDatabase |
( |
|
$type, |
|
|
|
$value, |
|
|
|
$field |
|
) |
| |
Transforms the given value to be stored in the database.
- Parameters
-
string | $type | |
mixed | $value | |
string | $field | |
- Returns
- mixed
convertFromDatabase |
( |
|
$type, |
|
|
|
$value, |
|
|
|
$field |
|
) |
| |
Transforms the data from the database for use.
- Parameters
-
string | $type | |
mixed | $value | |
string | $field | |
- Returns
- mixed
create |
( |
|
$field, |
|
|
|
$data = [] |
|
) |
| |
creates a new config entry in database
- Parameters
-
string | name of entry |
array | data to insert as assoc array |
- Exceptions
-
- Returns
- null|ConfigEntry
delete config entry from database
- Parameters
-
- Exceptions
-
- Returns
- integer number of deleted rows
fetchData |
( |
|
$data = null | ) |
|
|
protected |
fetch config data from table config pass array to override database access
- Parameters
-
returns singleton instance
- Returns
- Config
getFields |
( |
|
$range = null , |
|
|
|
$section = null , |
|
|
|
$name = null |
|
) |
| |
returns a list of config entry names, filtered by given params
- Parameters
-
string | filter by range: global, range, user, course or institute |
string | filter by section |
string | filter by part of name |
- Returns
- array
getI18NIdentifier |
( |
|
$field | ) |
|
|
protected |
Returns the identifier for the i18n field.
- Parameters
-
- Returns
- string
returns metadata for config entry
- Parameters
-
- Returns
- array
returns value of config entry for compatibility reasons an existing variable in global namespace with the same name is also returned
- Parameters
-
- Returns
- mixed
ArrayAccess: Check whether the given offset exists.
ArrayAccess: Get the value at the given offset.
offsetSet |
( |
|
$offset, |
|
|
|
$value |
|
) |
| |
ArrayAccess: Set the value at the given offset.
ArrayAccess: unset the value at the given offset (not applicable)
use to set singleton instance for testing or to unset by passing null
- Parameters
-
setValue |
( |
|
$field, |
|
|
|
$value |
|
) |
| |
set config entry to given value, but don't store it in database
- Parameters
-
- Returns
store new value for existing config entry in database posts notification ConfigValueChanged if entry is changed
- Parameters
-
- Exceptions
-
- Returns
- boolean
The documentation for this class was generated from the following file: