/functions/file_prefs.php

Description

file_prefs.php

This contains functions for manipulating user preferences in files

Functions
cachePrefValues (line 23)

Check the preferences into the session cache.

  • since: 1.1.3
void cachePrefValues (string $data_dir, string $username)
  • string $data_dir
  • string $username
checkForPrefs (line 202)

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: user name
  • string $filename: (since 1.2.0) preference file name. detects file name, if set to empty string.
getPref (line 100)

Return the value for the preference given by $string.

mixed getPref (string $data_dir, string $username, string $string, [string $default = ''])
  • string $data_dir: data directory
  • string $username: user name
  • string $string: preference name
  • string $default: (since 1.2.0) default preference value
getSig (line 293)

Get the signature.

  • return: signature
string getSig (string $data_dir, string $username, integer $number)
  • string $data_dir: data directory
  • string $username: user name
  • integer $number: (since 1.2.5) identity number
removePref (line 159)

Remove a preference for the current user.

void removePref (string $data_dir, string $username, string $string)
  • string $data_dir: data directory
  • string $username: user name
  • string $string: preference name
savePrefValues (line 124)

Save the preferences for this user.

  • since: 1.1.3
void savePrefValues (string $data_dir, string $username)
  • string $data_dir: data directory
  • string $username: user name
setPref (line 178)

Set a there preference $string to $value.

void setPref (string $data_dir, string $username, string $string, mixed $value)
  • string $data_dir: data directory
  • string $username: user name
  • string $string: preference name
  • mixed $value: preference value
setSig (line 260)

Write the User Signature.

void setSig (string $data_dir, string $username, integer $number, string $value)
  • string $data_dir: data directory
  • string $username: user name
  • integer $number: (since 1.2.5) identity number. parameter was used for signature text before 1.2.5.
  • string $value: (since 1.2.5) signature text

Documentation generated on Sat, 07 Oct 2006 16:10:56 +0300 by phpDocumentor 1.3.0RC6