Class Vacation_Driver_sql

Description

Vacation_Driver_sql:: implements the Vacation_Driver API for SQL servers.

$Horde: vacation/lib/Driver/sql.php,v 1.34.2.6 2009/05/07 15:27:47 jan Exp $

Copyright 2001-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.

Located in /lib/Driver/sql.php (line 18)

Vacation_Driver
   |
   --Vacation_Driver_sql
Variable Summary
 mixed $_connected
 mixed $_db
Method Summary
 void setVacation (string $password, string $message, string $subject, string $from, [string $alias = ''])
 void unsetVacation (string $password)
 string _buildUsername ()
 void _checkConfig ()
 boolean _connect ()
 array _getUserDetails (string $password)
Variables
array $capabilities = array('changeFrom' => false) (line 28)

An array of capabilities, so that the driver can report which operations it supports and which it doesn't.

  • 'changeFrom' permits the user to change the From: header.


Redefinition of:
Vacation_Driver::$capabilities
An array of capabilities, so that the driver can report which operations it supports and which it doesn't.
mixed $_connected = false (line 38)

Boolean which contains the state of the SQL connection.

mixed $_db (line 33)

SQL connection object.

Inherited Variables

Inherited from Vacation_Driver

Vacation_Driver::$_from
Vacation_Driver::$_message
Vacation_Driver::$_params
Vacation_Driver::$_realm
Vacation_Driver::$_subject
Vacation_Driver::$_user
Methods
setVacation (line 49)

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 111)

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 227)

Builds a username based on presence of a realm.

  • return: user@realm or user.
string _buildUsername ()
_checkConfig (line 242)

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 268)

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 200)

Retrieves the current password details for a user.

  • return: Current password.
string _getCurrentPassword ()
_getUserDetails (line 154)

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()

Documentation generated on Sun, 30 Jan 2011 05:40:32 +0000 by phpDocumentor 1.4.3