- /**
- ** abook_database.php
- **
- ** Backend for personal addressbook stored in a database,
- ** accessed using the DB-casses in PEAR.
- **
- ** IMPORTANT: The PEAR modules must be in the include path
- ** for this class to work.
- **
- ** An array with the following elements must be passed to
- ** the class constructor (elements marked ? are optional):
- **
- ** dsn => database DNS (see PEAR for syntax)
- ** table => table to store addresses in (must exist)
- ** owner => current user (owner of address data)
- ** ? writeable => set writeable flag (true/false)
- **
- ** The table used should have the following columns:
- ** owner, nickname, firstname, lastname, email, label
- ** The pair (owner,nickname) should be unique (primary key).
- **
- ** NOTE. This class should not be used directly. Use the
- ** "AddressBook" class instead.
- **
- ** $Id$
- **/
-
- require_once("DB.php");
-
- class abook_database extends addressbook_backend {
- var $btype = "local";
- var $bname = "database";
+/**
+ * abook_database.php
+ *
+ * Copyright (c) 1999-2003 The SquirrelMail Project Team
+ * Licensed under the GNU GPL. For full terms see the file COPYING.
+ *
+ * Backend for personal addressbook stored in a database,
+ * accessed using the DB-classes in PEAR.
+ *
+ * IMPORTANT: The PEAR modules must be in the include path
+ * for this class to work.
+ *
+ * An array with the following elements must be passed to
+ * the class constructor (elements marked ? are optional):
+ *
+ * dsn => database DNS (see PEAR for syntax)
+ * table => table to store addresses in (must exist)
+ * owner => current user (owner of address data)
+ * ? writeable => set writeable flag (true/false)
+ *
+ * The table used should have the following columns:
+ * owner, nickname, firstname, lastname, email, label
+ * The pair (owner,nickname) should be unique (primary key).
+ *
+ * NOTE. This class should not be used directly. Use the
+ * "AddressBook" class instead.
+ *
+ * $Id$
+ * @package squirrelmail
+ */
+
+/** Needs the DB functions */
+require_once('DB.php');
+
+/**
+ * Undocumented class - stores the addressbook in a sql database
+ * @package squirrelmail
+ */
+class abook_database extends addressbook_backend {
+ var $btype = 'local';
+ var $bname = 'database';