Docs For Class Accounts_Driver

Description

The ldap class attempts to return user information stored in an ldap directory service.

See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.fsf.org/copyleft/lgpl.html.

author: Eric Jon Rostetter <eric.rostetter@physics.utexas.edu>
since: Horde 3.1

Located in /lib/Block/account.php (line 420)

Accounts_Driver
   |
   --Accounts_Driver_ldap

Direct descendents

Class	Description
Accounts_Driver_kolab	The kolab driver class is merely an extension to the ldap class. It reuses

Variable Summary

resource $_ds

array $_params

Method Summary

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

mixed checkPasswordStatus ()

mixed getFullname ()

mixed getHome ()

mixed getPasswordChange ()

mixed getShell ()

string getUsername ()

void _bind ()

int _convertWinTimeToUnix (int $dateLargeInt)

array _getAccount ()

int _getMaxPasswd ()

Variables

resource $_ds (line 427)

Pointer to the ldap connection.

array $_params (line 434)

Hash containing connection parameters.

Inherited Variables

Inherited from Accounts_Driver

Accounts_Driver::$err_str

Methods

Constructor Accounts_Driver_ldap (line 441)

Constructs a new Accounts_Driver_ldap object.

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

array $params: A hash containing connection parameters.

checkPasswordStatus (line 675)

Returns the status of the current password.

return: A string with a warning message if the password is about to expire, PEAR_Error on error and false otherwise.

mixed checkPasswordStatus ()

Redefinition of:

Accounts_Driver::checkPasswordStatus(): Returns the status of the current password.

getFullname (line 588)

Returns the user's full name.

return: The user's full name (string), or false (error).

mixed getFullname ()

Redefinition of:

Accounts_Driver::getFullname(): Returns the user's full name.

getHome (line 610)

Returns the user's home (login) directory.

return: The user's directory (string), or false (error).

mixed getHome ()

Redefinition of:

Accounts_Driver::getHome(): Returns the user's home (login) directory.

getPasswordChange (line 652)

Returns the date of the user's last password change.

return: Date string (string) or false (error).

mixed getPasswordChange ()

Redefinition of:

Accounts_Driver::getPasswordChange(): Returns the date of the user's last password change.

getShell (line 629)

Returns the user's default shell.

return: The user's shell (string), or false (error).

mixed getShell ()

Redefinition of:

Accounts_Driver::getShell(): Returns the user's default shell.

getUsername (line 578)

Returns the username. Since this method is called for authenticating in the parent class, we also have the option to NOT strip the domain name if there is one. This is a configuration checkbox.

return: The username.

string getUsername ()

Redefinition of:

Accounts_Driver::getUsername(): Returns the username.

_bind (line 456)

void _bind ()

_convertWinTimeToUnix (line 529)

Code from 'brudinie at yahoo dot co dot uk' at http://nl3.php.net/ldap/

return: A unix timestamp.

int _convertWinTimeToUnix (int $dateLargeInt)

int $dateLargeInt: The win32 active directory epoch time.

_getAccount (line 545)

Returns the user account from the ldap source.

return: A hash with complete account details.

array _getAccount ()

_getMaxPasswd (line 500)

Returns the win32 AD epoch number of days the password may be unchanged.

return: The AD epoch number of days the password may unchanged.

int _getMaxPasswd ()

Inherited Methods

Inherited From Accounts_Driver

Accounts_Driver::checkPasswordStatus()
Accounts_Driver::getFullname()
Accounts_Driver::getHome()
Accounts_Driver::getPasswordChange()
Accounts_Driver::getQuota()
Accounts_Driver::getRealm()
Accounts_Driver::getShell()
Accounts_Driver::getUsername()