constructor Auth_PrefManager::Auth_PrefManager

constructor Auth_PrefManager::Auth_PrefManager() – Constructor


require_once '/PrefManager.php';

bool constructor Auth_PrefManager::Auth_PrefManager ( string $dsn , array $properties = NULL , string $defaultUser )


The $properties property should be an associative array, with the structure below. Any options not set will be set to the default.


The table to retrieve preferences from. [preferences]


The field to use for matching user IDs. [user_id]


The field to use for matching preference names. [pref_name]


The field to retrieve preference values from. [pref_value]


The user ID to use for retrieving default values. [__default__]


The key to use for the cache in $_SESSION. [prefsCache]


Should values be cached for later use. [true]


Should values be serialized before saving to the database, and unserialized on retrieval. [false]


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.


No exceptions thrown.


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.

A short guide to using Auth_PrefManager (Previous) Cleans out the cache. (Next)
Last updated: Sat, 16 Feb 2019 — Download Documentation
Do you think that something on this page is wrong? Please file a bug report.
View this page in:
  • English

User Notes:

There are no user contributed notes for this page.