Docs For Class Accounts

Description

Accounts_Driver:: defines an API for getting/displaying account information for a user for the accounts module.

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

Direct descendents

Class	Description
Accounts_Driver_localhost	Implements the Accounts API for servers with unix accounts on the localhost machine (same machine as the web server). Should work for local unix accounts, nis/nis+ accounts, or any PAM oriented accounts that appear as local accounts on the local machine. The exception is the quota support.
Accounts_Driver_ldap	The ldap class attempts to return user information stored in an ldap directory service.
Accounts_Driver_finger	Implements the Accounts API using finger to fetch information.

Variable Summary

string $err_str

Method Summary

mixed checkPasswordStatus ()

mixed getFullname ()

mixed getHome ()

mixed getPasswordChange ()

mixed getQuota ()

string getRealm ()

mixed getShell ()

string getUsername ()

Variables

string $err_str (line 149)

Error string returned to user if an error occurs.

Methods

checkPasswordStatus (line 229)

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

Redefined in descendants as:

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

getFullname (line 188)

Returns the user's full name.

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

mixed getFullname ()

Redefined in descendants as:

Accounts_Driver_localhost::getFullname() : Returns the user's full name.
Accounts_Driver_ldap::getFullname() : Returns the user's full name.
Accounts_Driver_finger::getFullname() : Returns the user's full name.

getHome (line 198)

Returns the user's home (login) directory.

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

mixed getHome ()

Redefined in descendants as:

Accounts_Driver_localhost::getHome() : Returns the user's home (login) directory.
Accounts_Driver_ldap::getHome() : Returns the user's home (login) directory.
Accounts_Driver_finger::getHome() : Returns the user's home (login) directory.

getPasswordChange (line 218)

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

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

mixed getPasswordChange ()

Redefined in descendants as:

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

getQuota (line 178)

Returns the user's quota if available.

return: A quota array, elements are used bytes and limit bytes on success, false on failure.

mixed getQuota ()

Redefined in descendants as:

Accounts_Driver_localhost::getQuota() : Implement the Quota API for IMAP servers with a unix quota command.

getRealm (line 167)

Returns the user realm.

return: The user realm.

string getRealm ()

getShell (line 208)

Returns the user's default shell.

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

mixed getShell ()

Redefined in descendants as:

Accounts_Driver_localhost::getShell() : Returns the user's default shell.
Accounts_Driver_ldap::getShell() : Returns the user's default shell.
Accounts_Driver_finger::getShell() : Returns the user's default shell.

getUsername (line 157)

Returns the username.

return: The lowercased username.

string getUsername ()

Redefined in descendants as:

Accounts_Driver_ldap::getUsername() : 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.