Class Passwd_Driver_vpopmail

Description

The vpopmail class attempts to change a user's password for vpopmail based servers. It is very similar to the more generic sql driver, and the two should probably be merged into one driver if possible.

$Horde: passwd/lib/Driver/vpopmail.php,v 1.17.2.6 2009/01/06 15:25:23 jan Exp $

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

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

Located in /lib/Driver/vpopmail.php (line 23)

Passwd_Driver
   |
   --Passwd_Driver_vpopmail
Variable Summary
 boolean $_connected
 DB $_db
Method Summary
 Passwd_Driver_vpopmail Passwd_Driver_vpopmail ([array $params = array()])
 boolean changePassword (string $username, string $old_password, string $new_password)
 boolean _connect ()
 boolean _lookup (string $username, string $old_password)
 boolean _modify (string $username, string $new_password)
Variables
boolean $_connected = false (line 37)

State of SQL connection.

DB $_db (line 30)

SQL connection object.

Inherited Variables

Inherited from Passwd_Driver

Passwd_Driver::$_errorstr
Passwd_Driver::$_params
Methods
Constructor Passwd_Driver_vpopmail (line 44)

Constructs a new Passwd_Driver_vpopmail object.

Passwd_Driver_vpopmail Passwd_Driver_vpopmail ([array $params = array()])
  • array $params: A hash containing connection parameters.
changePassword (line 214)

Change the user's password.

  • return: True or false based on success of the change.
boolean changePassword (string $username, string $old_password, string $new_password)
  • string $username: The user for which to change the password.
  • string $old_password: The old (current) user password.
  • string $new_password: The new user password to set.

Redefinition of:
Passwd_Driver::changePassword()
Change the user's password.
_connect (line 76)

Connect to the database.

  • return: True on success or PEAR_Error on failure.
boolean _connect ()
_lookup (line 109)

Find out if a username and password is valid.

  • return: True on valid or PEAR_Error on invalid.
boolean _lookup (string $username, string $old_password)
  • string $username: The username to check.
  • string $old_password: An old password to check.
_modify (line 161)

Modify (update) a mysql password record for a user.

  • return: True or False based on success of the modify.
boolean _modify (string $username, string $new_password)
  • string $username: The user whose record we will udpate.
  • string $new_password: The new password value to set.

Inherited Methods

Inherited From Passwd_Driver

 Passwd_Driver::Passwd_Driver()
 Passwd_Driver::changePassword()
 Passwd_Driver::comparePasswords()
 Passwd_Driver::encryptPassword()
 Passwd_Driver::factory()

Documentation generated on Sun, 30 Jan 2011 05:36:08 +0000 by phpDocumentor 1.4.3