Vacation_Driver_sql implements the Vacation_Driver API for SQL servers.

$Horde: vacation/lib/Driver/customsql.php,v 1.2.2.6 2009/08/18 12:54:50 jan Exp $

Copyright 2008-2009 The Horde Project (http://www.horde.org/)

See the enclosed file LICENSE for license information (BSD). If you did not receive this file, see http://www.horde.org/licenses/bsdl.php.

• author: Jan Schneider <jan@horde.org>
• since: Vacation 3.1

Located in /lib/Driver/customsql.php (line 16)

Vacation_Driver
   |
   --Vacation_Driver_customsql

boolean $_connected = false (line 30)

State of SQL connection.

DB $_db (line 23)

SQL connection object.

Inherited Variables

Inherited from Vacation_Driver

Vacation_Driver::$capabilities
Vacation_Driver::$_from
Vacation_Driver::$_message
Vacation_Driver::$_params
Vacation_Driver::$_realm
Vacation_Driver::$_subject
Vacation_Driver::$_user

Constructor Vacation_Driver_customsql (line 38)

Constructor.

Vacation_Driver_customsql Vacation_Driver_customsql (string $user, [array $params = array()])

• string $user: A user name.
• array $params: Configuration parameters for the backend.

setVacation (line 53)

Sets up vacation notices for a user.

void setVacation (string $password, string $message, string $subject, string $from, [string $alias = ''])

• string $password: The password for the user.
• string $message: The text of the vacation notice.
• string $subject: The subject of the vacation notice.
• string $from: The From: address of the vacation notice.
• string $alias: The alias email address.

---

Redefinition of:

Vacation_Driver::setVacation()

Sets up vacation notices for a user.

unsetVacation (line 104)

Disables the vacation message for a user.

void unsetVacation (string $password)

• string $password: The password of the user.

---

Redefinition of:

Vacation_Driver::unsetVacation()

Disables vacation notices for a user.

_buildUsername (line 244)

Builds a username based on presence of realm.

• return: Fully qualified username.

string _buildUsername ()

_checkConfig (line 259)

Checks if the realm has a specific configuration. If not, tries to fall back on the default configuration. If still not a valid configuration then exits with an error.

void _checkConfig ()

_connect (line 280)

Does an SQL connect and logs in as user with privilege to change vacation.

• return: True or PEAR_Error based on success of connect.

boolean _connect ()

_getCurrentPassword (line 213)

Retrieves the current password details for a user.

• return: Current password.

string _getCurrentPassword ()

_getUserDetails (line 152)

Retrieves the current vacation details for the user.

• return: Vacation details or PEAR_Error.

array _getUserDetails (string $password)

• string $password: The password for user.

---

Redefinition of:

Vacation_Driver::_getUserDetails()

Retrieves the current vacation details for the user.

Inherited Methods

Inherited From Vacation_Driver

Vacation_Driver::Vacation_Driver()
Vacation_Driver::currentFrom()
Vacation_Driver::currentMessage()
Vacation_Driver::currentSubject()
Vacation_Driver::factory()
Vacation_Driver::getFrom()
Vacation_Driver::getParam()
Vacation_Driver::getUser()
Vacation_Driver::hasCapability()
Vacation_Driver::isEnabled()
Vacation_Driver::setVacation()
Vacation_Driver::unsetVacation()
Vacation_Driver::_buildMessage()
Vacation_Driver::_encryptPassword()
Vacation_Driver::_getUserDetails()
Vacation_Driver::_makeEmailAddress()
Vacation_Driver::_parseMessage()
Vacation_Driver::_processMessage()