Docs For Class prefs

Description

Located in /plugins/prefs_mdb2/functions.php (line 17)

Variable Summary

mixed $charset

mixed $dbh

mixed $defaults

mixed $error

mixed $key_field

mixed $key_size

string $table

mixed $user_field

mixed $user_size

mixed $val_field

mixed $var_size

Method Summary

prefs_mdb2 prefs_mdb2 ([array $params = array()])

void deleteKey (string $user, string $key)

void failQuery ([object $res = NULL])

array fillPrefsCache (string $user)

void getKey (string $user, string $key, [mixed $default = ''])

void open ()

boolean setKey (string $user, string $key, mixed $value)

Variables

mixed $charset = 'utf-8' (line 29)

mixed $dbh = NULL (line 32)

mixed $defaults = array() (line 30)

mixed $error = NULL (line 33)

mixed $key_field = 'prefkey' (line 25)

mixed $key_size = 128 (line 26)

string $table = 'userprefs' (line 22)

Table that stores user data.

mixed $user_field = 'user' (line 23)

mixed $user_size = 128 (line 24)

mixed $val_field = 'prefval' (line 27)

mixed $var_size = 65535 (line 28)

Methods

Constructor prefs_mdb2 (line 39)

Constructor function

prefs_mdb2 prefs_mdb2 ([array $params = array()])

array $params

deleteKey (line 163)

void deleteKey (string $user, string $key)

string $user
string $key

failQuery (line 108)

Function is used to inform about fatal database error. It displays error message and stops script execution.

void failQuery ([object $res = NULL])

object $res: PEAR Error object (getMessage() method must be supported)

fillPrefsCache (line 123)

return: all user preferences stored in database

array fillPrefsCache (string $user)

string $user: username

getKey (line 151)

void getKey (string $user, string $key, [mixed $default = ''])

string $user
string $key
mixed $default

open (line 87)

Opens connection to database

void open ()

setKey (line 192)

return: true on success, false on failure

boolean setKey (string $user, string $key, mixed $value)

string $user
string $key
mixed $value: (string or integer)