constructor Auth_PrefManager::Auth_PrefManager
Synopsis
bool constructor
Auth_PrefManager::Auth_PrefManager
(
string
$dsn
,
array
$properties = NULL
,
string
$defaultUser
)
Description
The $properties property should be an associative array, with the structure below. Any options not set will be set to the default.
-
'table' -
The table to retrieve preferences from. [preferences]
-
'userColumn' -
The field to use for matching user IDs. [user_id]
-
'nameColumn' -
The field to use for matching preference names. [pref_name]
-
'valueColumn' -
The field to retrieve preference values from. [pref_value]
-
'defaultUser' -
The user ID to use for retrieving default values. [__default__]
-
'cacheName' -
The key to use for the cache in
$_SESSION. [prefsCache]
-
'useCache' -
Should values be cached for later use. [true]
-
'serialize' -
Should values be serialized before saving to the database, and unserialized on retrieval. [false]
Parameter
-
string
$dsn -
The DSN of the database connection to make, or a DB object.
-
array
$properties -
An array of properties to set.
-
string
$defaultUser -
The default user to manage for.
Return value
returns Success or failure.
Throws
No exceptions thrown.
Note
This function can not be called statically.
Users with preferences created using Auth_PrefManager 1.0.4 or earlier shouldn't enable the serialize option, as it may result in data loss.