/nasmail/functions/file_prefs.php
Description
file_prefs.php
This contains functions for manipulating user preferences in files
Functions
cachePrefValues (line 22)
Caches user preferences
void
cachePrefValues
(string $data_dir, string $username)
- string $data_dir: Data directory
- string $username: Username
checkForPrefs (line 205)
Check for a preferences file. If one can not be found, create it.
void
checkForPrefs
(string $data_dir, string $username, [string $filename = ''])
- string $data_dir: Data directory
- string $username: Username
- string $filename: Filename, defaults to $username.pref
getPref (line 99)
Return the value for the preference given by $string.
Function executes get_pref and get_pref_override hooks.
string
getPref
(string $data_dir, string $username, string $string, [string $default = ''])
- string $data_dir: Data directory
- string $username: Username
- string $string: Preference key name
- string $default: Default value returned when setting is not available.
getSig (line 290)
Get the signature.
string
getSig
(string $data_dir, string $username, int|string $number)
- string $data_dir: Data directory
- string $username: Username
- int|string $number: identity number or 'g' for default
removePref (line 161)
Removes a preference for the current user.
void
removePref
(string $data_dir, string $username, string $string)
- string $data_dir: Data directory
- string $username: Username
- string $string: Deleted preference key name
savePrefValues (line 125)
Save the preferences for this user.
Function stops execution on failure.
void
savePrefValues
(string $data_dir, string $username)
- string $data_dir: Data directory
- string $username: Username
setPref (line 181)
Sets preference $string to $value.
void
setPref
(string $data_dir, string $username, string $string, string $value)
- string $data_dir: Data directory
- string $username: Username
- string $string: Preference key
- string $value: Preference value
setSig (line 256)
Write the User Signature.
void
setSig
(string $data_dir, string $username, int|string $number, string $value)
- string $data_dir: Data directory
- string $username: Username
- int|string $number: identity number or 'g' for default
- string $value: Signature
Documentation generated on Sun, 22 Nov 2009 17:36:27 +0200 by phpDocumentor 1.4.3