A static class for preferences stored with admin user preferences.
| package |
CMS |
|---|---|
| license |
GPL |
| since | 1.10 |
| author |
Robert Campbell (calguy1000@gmail.com) |
get_for_user(integer $userid, string $key, mixed $dflt = '') : string
integer $useridThe specified user id.
string $keyThe preference name
mixed $dfltThe default value.
string
get(string $key, string $dflt = '') : \strung
string $keyThe preference name
string $dfltA default value if the preference could not be found
\strung
get_all_for_user(integer $userid) : array
integer $userid array
Associative array of preferences and values.
exists_for_user(integer $userid, string $key) : boolean
integer $useridthe user id
string $keyThe preference name
boolean
exists(string $key) : boolean
string $keyThe preference name
boolean
set_for_user(integer $userid, string $key, string $value)
integer $useridThe user id
string $keyThe preference name
string $valueThe preference value
set(string $key, string $value)
string $keyThe preference name
string $valueThe preference value
remove_for_user(integer $userid, string $key = '', boolean $like = FALSE)
integer $useridThe user id
string $key(optional) The preference name. If not specified, all preferences for this user will be removed.
boolean $like(optional) wether or not to use approximation in the preference name
remove(string $key, boolean $like = FALSE)
string $keyThe preference name.
boolean $like(optional) wether or not to use approximation in the preference name