Docs For Class Passwd_Driver

Description

The pine class attempts to change a user's password on a in a pine password file.

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

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

author: Max Kalika <max@horde.org>
since: Passwd 3.0

Located in /lib/Driver/pine.php (line 33)

Passwd_Driver
   |
   --Passwd_Driver_pine

Variable Summary

boolean $_connected

array $_contents

VFS $_ftp

Method Summary

Passwd_Driver_pine Passwd_Driver_pine ([array $params = array()])

mixed changePassword (string $username, string $oldPassword, string $newPassword)

mixed _connect ( $user, $password)

array _decode (string $string)

mixed _disconnect ()

array _encode (array $lines)

mixed _lookup (string $user, string $oldPassword)

mixed _modify (string $user, string $newPassword)

Variables

boolean $_connected = false (line 47)

Boolean which contains state of the ftp connection.

array $_contents = array() (line 54)

Contents array of the pine password file.

VFS $_ftp (line 40)

FTP connection handle.

Inherited Variables

Inherited from Passwd_Driver

Passwd_Driver::$_errorstr
Passwd_Driver::$_params

Methods

Constructor Passwd_Driver_pine (line 61)

Constructs a new pine Passwd_Driver object.

Passwd_Driver_pine Passwd_Driver_pine ([array $params = array()])

array $params: A hash containing connection parameters.

changePassword (line 266)

Change the user's password.

return: True on success or a PEAR_Error object on failure.

mixed changePassword (string $username, string $oldPassword, string $newPassword)

string $username: The user for which to change the password.
string $oldPassword: The old (current) user password.
string $newPassword: The new user password to set.

Redefinition of:

Passwd_Driver::changePassword(): Change the user's password.

_connect (line 87)

Connect to the FTP server.

return: True on success or a PEAR_Error object on failure.

mixed _connect ( $user, $password)

$user
$password

_decode (line 138)

Decodes a Pine-encoded password string. The algorithm is borrowed from read_passfile() and xlate_out() functions in pine/imap.c file distributed in the Pine source archive.

return: List of lines of decoded elements.

array _decode (string $string)

string $string: The contents of a pine-encoded password file.

_disconnect (line 119)

Disconnect from the FTP server and clean up the connection.

return: True on success or a PEAR_Error object on failure.

mixed _disconnect ()

_encode (line 179)

Encodes an array of elements into a Pine-readable password string.

The algorith is borrowed from write_passfile() and xlate_in() functions in pine/imap.c file distributed in the Pine source archive.

return: Contents of a pine-readable password file.

array _encode (array $lines)

array $lines: List of lines of decoded elements

_lookup (line 215)

Find out if a username and password is valid.

return: True on success or a PEAR_Error object on failure.

mixed _lookup (string $user, string $oldPassword)

string $user: The userID to check.
string $oldPassword: An old password to check.

_modify (line 242)

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

return: True on success or a PEAR_Error object on failure.

mixed _modify (string $user, string $newPassword)

string $user: The user whose record we will udpate.
string $newPassword: 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()