File/plugins/prefs_mdb2/functions.php

Description
Description | Classes | Includes | Functions

MDB2 Preference Backend functions

Copyright (c) 2006 Tomas Kuliavas <tokul@users.sourceforge.net>

  • version: $Id: functions.php,v 1.2 2006/08/04 13:41:28 tokul Exp $
Classes
Description | Classes | Includes | Functions
Class Description
class prefs_mdb2
Includes
Description | Classes | Includes | Functions
include_once ('MDB2.php') (line 11)
Functions
Description | Classes | Includes | Functions
getPref (line 310)

returns the value for the pref $string

mixed getPref (string $data_dir, string $username, string $pref_name, [mixed $default = ''])
  • string $data_dir
  • string $username
  • string $pref_name
  • mixed $default: default value. Text data must be in US-ASCII.
getSig (line 422)

Gets the signature

  • return: signature text
string getSig (string $data_dir, string $username, integer $number)
  • string $data_dir: unused. compatibility with file prefs
  • string $username: username
  • integer $number: identity number, 'g' for main identity
prefs_mdb2_load (line 230)
  • return: object
object prefs_mdb2 prefs_mdb2_load ( $username)
  • $username
removePref (line 339)

Remove the pref $string

boolean removePref (string $data_dir, string $username, string $string)
  • string $data_dir
  • string $username
  • string $string
setPref (line 363)

Standard SquirrelMail setPref function

  • return: true on success, false on failure
boolean setPref (string $data_dir, string $username, string $key, string $value)
  • string $data_dir: unused. compatibility with file prefs
  • string $username: username
  • string $key: preference name
  • string $value: preference value
setSig (line 406)

Writes the Signature

boolean setSig (string $data_dir, string $username, integer $number, string $string)
  • string $data_dir: unused. compatibility with file prefs
  • string $username: username
  • integer $number: identity number, 'g' for main identity
  • string $string: signature text

Documentation generated on Sun, 22 Nov 2009 17:36:31 +0200 by phpDocumentor 1.4.3